**thoughtful** is a collection of open-source libraries and tools for Robot Process
Automation (RPA) development. The goal of this project is to provide a set of
for supervising bot execution, and enabling these bots to do more.
[![PyPi version](https://badgen.net/pypi/v/thoughtful/)](https://pypi.org/project/thoughtful/)
![Main Branch Tests](https://github.com/Thoughtful-Automation/supervisor/actions/workflows/main-push.yml/badge.svg?branch=main)
[![Supported Versions](https://img.shields.io/pypi/pyversions/thoughtful.svg)](https://pypi.org/project/thoughtful)
[![Downloads](https://pepy.tech/badge/thoughtful/month)](https://pepy.tech/project/thoughtful)
[//]: # ([![GitHub release](https://img.shields.io/github/release/Thoughtful-Automation/supervisor.svg)](https://GitHub.com/Naereen/StrapDown.js/releases/))
This project is:
* Open-source: [GitHub][url:gh]
* Owned by [thoughtful][url:ta]
* Licensed under the [Apache License 2.0][url:al]
Links:
* [Homepage][url:gh]
* [Documentation][url:readthedocs]
* [PyPI][url:pypi]
**thoughtful** is available on [PyPI][url:pypi] and can be installed using pip:
```sh
pip install thoughtful
```
---
**thoughtful** officially supports Python 3.7+.
---
# Libraries
This is a list of the available libraries in this project. API Reference
and User Guide available on [docs][url:readthedocs].
## Supervisor
Supervisor is a Workflow Engine for Digital Workers that constructs
and broadcasts a detailed and structured telemetric log, called the Run Report.
```python
from thoughtful.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()
```
## Contributing
Contributions to **thoughtful** are welcome!
To get started, see the [contributing guide](CONTRIBUTING.md).
---
Made with ❤️ by
[![Thoughtful](https://user-images.githubusercontent.com/1096881/141985289-317c2e72-3c2d-4e6b-800a-0def1a05f599.png)][url:ta]
---
This project is open-source and licensed under the terms of the [Apache License 2.0][url:al].
<!-- Link References -->
[url:ta]: https://www.thoughtful.ai/
[url:gh]: https://github.com/Thoughtful-Automation/supervisor
[url:pypi]: https://pypi.org/project/thoughtful/
[git:issues]: https://github.com/Thoughtful-Automation/supervisor/issues
[url:readthedocs]: https://thoughtful-supervisor.readthedocs-hosted.com/en/latest/
[url:al]: http://www.apache.org/licenses/LICENSE-2.0
Raw data
{
"_id": null,
"home_page": "https://thoughtful.ai",
"name": "thoughtful",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": null,
"keywords": "rpa, robot-framework, robocorp, automation",
"author": "Thoughtful Automation",
"author_email": "care@thoughtful.ai",
"download_url": "https://files.pythonhosted.org/packages/ef/20/fe1060441c25906a24f39ca036ac5510377046ad131c4679b121a1567a5f/thoughtful-2.5.1.tar.gz",
"platform": null,
"description": "**thoughtful** is a collection of open-source libraries and tools for Robot Process\nAutomation (RPA) development. The goal of this project is to provide a set of\nfor supervising bot execution, and enabling these bots to do more.\n\n[![PyPi version](https://badgen.net/pypi/v/thoughtful/)](https://pypi.org/project/thoughtful/)\n![Main Branch Tests](https://github.com/Thoughtful-Automation/supervisor/actions/workflows/main-push.yml/badge.svg?branch=main)\n[![Supported Versions](https://img.shields.io/pypi/pyversions/thoughtful.svg)](https://pypi.org/project/thoughtful)\n[![Downloads](https://pepy.tech/badge/thoughtful/month)](https://pepy.tech/project/thoughtful)\n\n[//]: # ([![GitHub release](https://img.shields.io/github/release/Thoughtful-Automation/supervisor.svg)](https://GitHub.com/Naereen/StrapDown.js/releases/))\n\n\nThis project is:\n* Open-source: [GitHub][url:gh]\n* Owned by [thoughtful][url:ta]\n* Licensed under the [Apache License 2.0][url:al]\n\nLinks:\n* [Homepage][url:gh]\n* [Documentation][url:readthedocs]\n* [PyPI][url:pypi]\n\n**thoughtful** is available on [PyPI][url:pypi] and can be installed using pip:\n\n```sh\npip install thoughtful\n```\n\n---\n\n**thoughtful** officially supports Python 3.7+.\n\n---\n\n# Libraries\n\nThis is a list of the available libraries in this project. API Reference\nand User Guide available on [docs][url:readthedocs].\n\n## Supervisor\n\nSupervisor is a Workflow Engine for Digital Workers that constructs\nand broadcasts a detailed and structured telemetric log, called the Run Report.\n\n```python\nfrom thoughtful.supervisor import step, step_scope, supervise, set_step_status\n\n\n# using the step decorator\n@step(\"2\")\ndef step_2(name: str) -> bool:\n print(f'Hello {name}')\n return True # some condition\n\ndef main() -> None:\n # using the step_scope context manager\n with step_scope('1') as step_context:\n try:\n print(\"Getting credentials\")\n # ...\n except Exception as e:\n # set step status using method\n step_context.set_status(\"warning\")\n\n if not step_2():\n # set step status using function\n set_step_status(\"2\", \"fail\")\n\nif __name__ == '__main__':\n with supervise():\n main()\n```\n\n## Contributing\n\nContributions to **thoughtful** are welcome!\n\nTo get started, see the [contributing guide](CONTRIBUTING.md).\n\n---\n\n Made with \u2764\ufe0f by\n\n [![Thoughtful](https://user-images.githubusercontent.com/1096881/141985289-317c2e72-3c2d-4e6b-800a-0def1a05f599.png)][url:ta]\n\n---\n\nThis project is open-source and licensed under the terms of the [Apache License 2.0][url:al].\n\n\n<!-- Link References -->\n\n[url:ta]: https://www.thoughtful.ai/\n[url:gh]: https://github.com/Thoughtful-Automation/supervisor\n[url:pypi]: https://pypi.org/project/thoughtful/\n[git:issues]: https://github.com/Thoughtful-Automation/supervisor/issues\n[url:readthedocs]: https://thoughtful-supervisor.readthedocs-hosted.com/en/latest/\n[url:al]: http://www.apache.org/licenses/LICENSE-2.0\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Thoughtful is a python package by Thoughtful for helping manage automations with helpful packages like supervisor",
"version": "2.5.1",
"project_urls": {
"Documentation": "https://thoughtful-supervisor.readthedocs-hosted.com/en/latest/index.html",
"Homepage": "https://thoughtful.ai",
"Repository": "https://github.com/thoughtful-automation/thoughtful"
},
"split_keywords": [
"rpa",
" robot-framework",
" robocorp",
" automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b488577b29ec315da6926fcdb024160f721f7d3cd0bd29188b6bccf8b31e9c4b",
"md5": "0a1de6a9e0b50122647f8f83f7f4a400",
"sha256": "71422795d1c769414d9f3768f2c9774163cb0c8b5bddd389953978f8a90c3412"
},
"downloads": -1,
"filename": "thoughtful-2.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a1de6a9e0b50122647f8f83f7f4a400",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 38377,
"upload_time": "2024-04-23T21:59:33",
"upload_time_iso_8601": "2024-04-23T21:59:33.540432Z",
"url": "https://files.pythonhosted.org/packages/b4/88/577b29ec315da6926fcdb024160f721f7d3cd0bd29188b6bccf8b31e9c4b/thoughtful-2.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef20fe1060441c25906a24f39ca036ac5510377046ad131c4679b121a1567a5f",
"md5": "42791060ae87ec73e12427c36cd77555",
"sha256": "5f2a966d446bf66333f959abdf14e10d306c1f145309470762ef41ba75cd4daf"
},
"downloads": -1,
"filename": "thoughtful-2.5.1.tar.gz",
"has_sig": false,
"md5_digest": "42791060ae87ec73e12427c36cd77555",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 29260,
"upload_time": "2024-04-23T21:59:35",
"upload_time_iso_8601": "2024-04-23T21:59:35.750989Z",
"url": "https://files.pythonhosted.org/packages/ef/20/fe1060441c25906a24f39ca036ac5510377046ad131c4679b121a1567a5f/thoughtful-2.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 21:59:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "thoughtful-automation",
"github_project": "thoughtful",
"github_not_found": true,
"lcname": "thoughtful"
}