Getting Started¶
Project Setup¶
We recommend using uv.
You can set up a project using uv and the tierkreis cli called tkr.
uv init
uv add tierkreis
uv run tkr init project
This will set up the following project structure for you:
project_root/
├── tkr/
│ ├── graphs/
│ │ └── main.py
│ └── workers/
│ └── example_worker/
│ ├── src/
│ │ ├── api/
│ │ │ ├── api.py (stubs for the worker)
│ │ │ ├── pyproject.toml
│ │ │ └── README.md
│ │ └── main.py
│ ├── __init__.py
│ ├── pyproject.toml
│ ├── README.md
│ └── uv.lock
├── .gitignore
├── .python-version
├── main.py
├── pyproject.toml
├── README.md
└── uv.lock
The repository is structure is intended to separate graphs, workers and library code.
From here you can run your first graph by running
uv run python -m tkr.graphs.main
> Value is: 1
From here you can continue with the other tutorials.
Tutorials for writing workflows¶
A sequence of tutorials that cover the fundamentals of writing and operating Tierkreis workflows.
Tutorials for writing workers¶
Tutorials on writing workers that provide additional tasks. For a general oveview look at the worker documentation For worker libraries see this document