Skip to content

Commit 609cfbb

Browse files
committed
readme
1 parent 944322f commit 609cfbb

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
1-
# Hatchet First Workflow Example
1+
## Hatchet Python Quickstart
22

3-
This is an example project demonstrating how to use Hatchet with Python.
3+
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).
44

55
## Prerequisites
66

77
Before running this project, make sure you have the following:
88

9-
1. [Python V3.10 or higher](https://www.python.org/downloads/)
9+
1. [Python v3.10 or higher](https://www.python.org/downloads/)
10+
2. [Poetry](https://python-poetry.org/docs/#installation) for dependency management
1011

1112
## Setup
1213

13-
1. Set the required environment variable `HATCHET_CLIENT_TOKEN` created in the [Getting Started Guide](https://docs.hatchet.run/home/hatchet-cloud-quickstart).
14+
1. Clone the repository:
1415

16+
```bash
17+
git clone https://github.com/hatchet-dev/hatchet-python-quickstart.git
18+
cd hatchet-python-quickstart
1519
```
20+
21+
2. Set the required environment variable `HATCHET_CLIENT_TOKEN` created in the [Getting Started Guide](https://docs.hatchet.run/home/hatchet-cloud-quickstart).
22+
23+
```bash
1624
export HATCHET_CLIENT_TOKEN=<token>
1725
```
1826

19-
2. Run the following command to install the project dependencies:
27+
> Note: If you're self hosting you may need to set `HATCHET_CLIENT_TLS_STRATEGY=none` to disable TLS
2028
21-
```shell
22-
poetry install
23-
```
29+
3. Install the project dependencies:
30+
31+
```bash
32+
poetry install
33+
```
2434

2535
### Running an example
2636

0 commit comments

Comments
 (0)