Supervisor is a Workflow Engine for Digital Workers that generates a detailed telemetric log at runtime called a Work Report
Project description
👷 Supervisor
:warning: NOTE: Supervisor is quite new. We welcome and encourage you to help shape future development by reporting issues and making suggestions 💖
Supervisor is a Workflow Engine for Digital Workers that constructs and broadcasts a detailed and structured telemetric log, called the Run Report.
Supervisor is quick and easy to implement:
from supervisor import step, step_scope, supervise, set_step_status
# using the step decorator
@step("2")
def step_2(name: str) -> bool:
print(f'Hello {name}')
return True # some condition
def main() -> None:
# using the step_scope context manager
with step_scope('1') as step_context:
try:
print("Getting credentials")
# ...
except Exception as e:
# set step status using method
step_context.set_status("warning")
if not step_2():
# set step status using function
set_step_status("2", "fail")
if __name__ == '__main__':
with supervise():
main()
Supervisor supports Python ≥ 3.7.5
:books: 👉️ Read the Docs
Table of Contents
Installing Supervisor
At this time, Supervisor is a private package hosted only on CodeArtifact.
-
Authenticate with
CodeArtifact:aws codeartifact login \ --tool pip \ --repository thoughtful-automation \ --domain thoughtful-automation \ --domain-owner XXXXXXXXXXXX \ --region us-east-1
-
Pip install
pip install t-supervisor
or install a specific version:
pip install "t-supervisor==0.4.0"
Documentation available on Read the Docs
See the Read the Docs.
Contributing
Contributions to Supervisor are welcomed!
To get started, see the contributing guide.
Resources
Links to related code, documentation, and applications.
The digital Workforce Manager (DWM)
👷 Supervisor (this repo)
The Workflow Engine for Digital Workers that constructs and broadcasts a detailed and structured telemetric log, called the Work Report
The initialization tool for Digital Workers.
The design tool for Digital Workers.
The JSON-Schema-defined documents used to validate the Manifest and the runtime Work Report
:eagle: Department of Digital Labor
Documentation and Specifications for building Digital Workers in TA's ecosystem, and Empower
Made with ❤️ by
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for thoughtful-1.10.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6581189bd12029c15badc4dd4a0d20d510ab053e66d65db003235df978ee904a |
|
| MD5 | 41f6a00ba71b9514f5f38b7cc8ec4d8a |
|
| BLAKE2b-256 | f871f23a7154f2e57697ef65174289c8f6437a0caaa7b37a49eb2a823bc61225 |
