mirror of
https://github.com/hatchet-dev/hatchet.git
synced 2026-01-01 06:11:02 -06:00
8e80faf2d6
* api changes * doc changes * move docs * generated * generate * pkg * backmerge main * revert to main * revert main * race? * remove go tests
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
## Hatchet Python Quickstart
|
|
|
|
This is an example project demonstrating how to use Hatchet with Python. For detailed setup instructions, see the [Hatchet Setup Guide](https://docs.hatchet.run/home/setup).
|
|
|
|
## Prerequisites
|
|
|
|
Before running this project, make sure you have the following:
|
|
|
|
1. [Python v3.10 or higher](https://www.python.org/downloads/)
|
|
2. [Poetry](https://python-poetry.org/docs/#installation) for dependency management
|
|
|
|
## Setup
|
|
|
|
1. Clone the repository:
|
|
|
|
```bash
|
|
git clone https://github.com/hatchet-dev/hatchet-python-quickstart.git
|
|
cd hatchet-python-quickstart
|
|
```
|
|
|
|
2. Set the required environment variable `HATCHET_CLIENT_TOKEN` created in the [Getting Started Guide](https://docs.hatchet.run/home/hatchet-cloud-quickstart).
|
|
|
|
```bash
|
|
export HATCHET_CLIENT_TOKEN=<token>
|
|
```
|
|
|
|
> Note: If you're self hosting you may need to set `HATCHET_CLIENT_TLS_STRATEGY=none` to disable TLS
|
|
|
|
3. Install the project dependencies:
|
|
|
|
```bash
|
|
poetry install
|
|
```
|
|
|
|
### Running an example
|
|
|
|
1. Start a Hatchet worker by running the following command:
|
|
|
|
```shell
|
|
poetry run python src/worker.py
|
|
```
|
|
|
|
2. To run the example workflow, open a new terminal and run the following command:
|
|
|
|
```shell
|
|
poetry run python src/run.py
|
|
```
|
|
|
|
This will trigger the workflow on the worker running in the first terminal and print the output to the the second terminal.
|