Server API

Implementation of server for ellclockin.

class ellclockin.server.Server(config)

Bases: RpcBroker

Elldev server that is also a SHV Broker.

Parameters:

config (ServerConfig) –

class Client(client, broker, *args, user=None, **kwargs)

Bases: Client

The client exposed in Broker.

Parameters:

• client (RpcClient) –

• broker (Server) –

• args (Any) –

• user (RpcBrokerConfig.User | None) –

• kwargs (Any) –

class LoginClient(*args, **kwargs)

Bases: Client, LoginClient

Broker’s client that expects login from client.

Parameters:

• args (Any) –

• kwargs (Any) –

APP_NAME: str = 'clockin-broker'

Name reported as application name for pyshvbroker.

class ConnectClient(*args, target_mount_point=None, **kwargs)

Bases: Client, ConnectClient

Broker client that actively connects to some other peer.

Parameters:

• args (Any) –

• target_mount_point (str | None) –

• kwargs (Any) –

APP_NAME: str = 'clockin-broker-client'

Name reported as application name for pyshvbroker connection.

class ellclockin.server.ServerConfig(port=3755, users=<factory>, dbfile=PosixPath('ellclockin.db'))

Bases: object

Elldev server config.

Parameters:

• port (int) –

• users (dict[str, str]) –

• dbfile (Path) –

port: int = 3755

TCP/IP port where server will be listening.

users: dict[str, str]

Mapping of user name to their passwords.

dbfile: Path = PosixPath('ellclockin.db')

Path to the SQLite database file.

shvbroker_config()

Provide new SHV Broker config based on this configuration.

Return type:

RpcBrokerConfig

classmethod load(path)

Load configuration file.

Parameters:

path (Path) – path to the configuration file

Return type:

ServerConfig

class ellclockin.server.ServerDatabase(config)

Bases: object

Abstraction on top of the database to provide data retention functionality.

Parameters:

config (ServerConfig) –

projects()

Iterate over project names.

Return type:

Iterator[str]

projects_in_progress()

Iterate over project names for those not yet completed.

Return type:

Iterator[str]

new_project(name)

Create new project.

Parameters:

name (str) – name of the new project

Return type:

None

complete_project(name)

Make project completed.

Parameters:

name (str) – name of the project

Return type:

None

project_complete(name)

Check if given project is complete or not.

Parameters:

name (str) – name of the project

Return type:

bool

project_workers(name)

Set of all workers participating in this project.

Parameters:

name (str) – name of the project

Return type:

set[str]

project_worker_seconds(project, worker)

Provide number of seconds invested in this project by this worker so far.

Parameters:

• project (str) – name of the project

• worker (str) – name of the worker

Returns:

number of seconds invested

Return type:

int

project_seconds(name)

Provide number of seconds invested in this project so far.

Parameters:

name (str) – name of the project

Return type:

int

workers()

Iterate over all worker names.

Return type:

Iterator[str]

new_worker(name)

Register new worker.

Parameters:

name (str) – name of the new worker

Return type:

None

work(name, project)

Start or end worker’s work on project.

Parameters:

• name (str) – name of the worker

• project (str | None) – name of the project, None when ending the work

Return type:

None

retroactive_clockout(name, retro_date)

Retroactively end worker’s work on their current project.

Parameters:

• name (str) – name of the worker

• retro_date (float) – clockout time timestamp

Return type:

None

add_work(name, project, seconds)

Add record about work in the past.

Parameters:

• name (str) – name of the worker

• project (str) – name of the project

• seconds (int) – number of seconds invested

Return type:

None

current_project(name)

Get current project user is working on.

Parameters:

name (str) – name of the worker

Return type:

str | None

current_seconds(name)

Get current number of seconds user already invested into the current project.

Parameters:

name (str) – name of the project

Returns:

number of seconds invested

Return type:

int | None