Client API
Elektroline developers’ clock-in tool.
-
class ellclockin.ClockInClient[source]
Bases: object
Ellclockin client for communicating with the server.
-
async clockin_project(project)[source]
Clockin the current user to the specified project.
- Parameters:
project (str) – name of the project
- Return type:
None | SHVNull | bool | SHVBool | int | float | Decimal | bytes | str | datetime | Sequence[SHVType] | Mapping[str, SHVType] | Mapping[int, SHVType]
-
async clockout_project()[source]
Clockout the current user from their current project.
- Return type:
None | SHVNull | bool | SHVBool | int | float | Decimal | bytes | str | datetime | Sequence[SHVType] | Mapping[str, SHVType] | Mapping[int, SHVType]
-
async clockout_retroactive(retro_date)[source]
Retroactively clockout the current user from their current project.
- Parameters:
retro_date (float) – clockout time timestamp
- Return type:
None | SHVNull | bool | SHVBool | int | float | Decimal | bytes | str | datetime | Sequence[SHVType] | Mapping[str, SHVType] | Mapping[int, SHVType]
-
async connect(url)[source]
Connect to the server.
- Parameters:
url (RpcUrl) – URL of the server
- Return type:
None
-
async create_new_project(project)[source]
Create a new project with the specified name.
- Parameters:
project (str) – name of the new project
- Return type:
None | SHVNull | bool | SHVBool | int | float | Decimal | bytes | str | datetime | Sequence[SHVType] | Mapping[str, SHVType] | Mapping[int, SHVType]
-
async create_new_worker(worker)[source]
Create a new worker with the specified name.
- Parameters:
-
- Return type:
None | SHVNull | bool | SHVBool | int | float | Decimal | bytes | str | datetime | Sequence[SHVType] | Mapping[str, SHVType] | Mapping[int, SHVType]
-
async disconnect()[source]
Disconnect from the server.
- Return type:
None
-
async get_all_projects()[source]
Get the names of all projects.
- Return type:
str
-
async get_all_workers()[source]
Get the name of all workers.
- Return type:
str
-
async get_user_project_contributions(project, user)[source]
Get the contributions of the specified user in the specified project.
- Parameters:
-
- Return type:
str
-
async is_project_complete(project)[source]
Check whether the specified project is complete or not.
- Parameters:
project (str) – name of the specified project
- Returns:
True in case the project is complete and False otherwise
- Return type:
bool
-
async ls(path='')[source]
Print a list of all child nodes of the node on the specified path.
- Parameters:
path (str) – SHV path to the node we want children to be listed for
- Return type:
None