Metadata-Version: 2.5
Name: orchestrator-cookiecutter
Version: 0.0.1
Summary: A Cookiecutter template for setting up an implementation of Workflow Orchestrator
Project-URL: Source, https://github.com/workfloworchestrator/orchestrator-cookiecutter
Project-URL: Homepage, https://workfloworchestrator.org
Project-URL: Documentation, https://workfloworchestrator.org
Author-email: GÉANT Orchestration and Automation Team <goat@geant.org>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Requires-Python: <3.15,>=3.12
Requires-Dist: cookiecutter==2.7.1
Requires-Dist: typer==0.27.0
Description-Content-Type: text/markdown

# Workflow Orchestrator Cookiecutter Template

A [Cookiecutter](https://github.com/cookiecutter/cookiecutter) template repository for creating an implementation of
the Workflow Orchestrator.

## What You Get

This cookiecutter template includes the following tools to help you get started to implement your own Workflow
Orchestrator.

- `uv` as package manager
- `ruff` as Python linter and formatter
- `mypy` as type checker
- `pre-commit` hooks wired up to run linting, formatting and type checking
- `pytest` as unit testing framework, with boilerplate code for test cases
- A choice of `Threadpool` or `Celery` as task executor
- A GraphQL API registered alongside the REST API out of the box
- An optional `docker-compose.yml` to run Postgres (and Redis, when using Celery) locally

## Quickstart

[Install `uv`](https://docs.astral.sh/uv/getting-started/installation/) and run:

```shell
uvx orchestrator-cookiecutter
```

This will take you through the generation of a boilerplate project for Workflow Orchestrator.

for development use:

```shell
uv run cookiecutter .
```
