mirror of
https://github.com/hatchet-dev/hatchet.git
synced 2026-01-01 14:19:54 -06:00
747fa28ac4
* readme changes * test readme changes * try spaces * readme indent * add task orchestration features * newline * fix: headings and indent * add flow control * add scheduling * rest of readme changes * Update README.md * Update README.md * fix: small setup guide improvements * Apply suggestions from code review Co-authored-by: Matt Kaye <mrkaye97@gmail.com> * Update frontend/docs/pages/home/index.mdx Co-authored-by: Gabe Ruttner <gabriel.ruttner@gmail.com> * wip * wip * naming * task * lint * compute * fix: add a bunch of redirects * fix: dynamic * link to docs * revert * revert some changes --------- Co-authored-by: Alexander Belanger <alexander@hatchet.run> Co-authored-by: abelanger5 <belanger@sas.upenn.edu> Co-authored-by: Matt Kaye <mrkaye97@gmail.com>
52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
# Hatchet Python SDK
|
|
|
|
<div align="center">
|
|
|
|
[](https://badge.fury.io/py/hatchet-sdk)
|
|
[](https://docs.hatchet.run)
|
|
[](https://opensource.org/licenses/MIT)
|
|
|
|
</div>
|
|
|
|
This is the official Python SDK for [Hatchet](https://hatchet.run), a distributed, fault-tolerant task queue. The SDK allows you to easily integrate Hatchet's task scheduling and workflow orchestration capabilities into your Python applications.
|
|
|
|
## Installation
|
|
|
|
Install the SDK using pip:
|
|
|
|
```bash
|
|
pip install hatchet-sdk
|
|
```
|
|
|
|
Or using poetry:
|
|
|
|
```bash
|
|
poetry add hatchet-sdk
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
For examples of how to use the Hatchet Python SDK, including worker setup and task execution, please see our [official documentation](https://docs.hatchet.run/home/setup).
|
|
|
|
## Features
|
|
|
|
- 🔄 **Workflow Orchestration**: Define complex workflows with dependencies and parallel execution
|
|
- 🔁 **Automatic Retries**: Configure retry policies for handling transient failures
|
|
- 📊 **Observability**: Track workflow progress and monitor execution metrics
|
|
- ⏰ **Scheduling**: Schedule workflows to run at specific times or on a recurring basis
|
|
- 🔄 **Event-Driven**: Trigger workflows based on events in your system
|
|
|
|
## Documentation
|
|
|
|
For detailed documentation, examples, and best practices, visit:
|
|
- [Hatchet Documentation](https://docs.hatchet.run)
|
|
- [Examples](https://github.com/hatchet-dev/hatchet/tree/main/sdks/python/examples)
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions! Please check out our [contributing guidelines](https://docs.hatchet.run/contributing) and join our [Discord community](https://hatchet.run/discord) for discussions and support.
|
|
|
|
## License
|
|
|
|
This SDK is released under the MIT License. See [LICENSE](https://github.com/hatchet-dev/hatchet/blob/main/LICENSE) for details.
|