Orchestrator-Core
Production ready Orchestration Framework to manage product lifecycle and workflows. Easy to use, built on top of FastAPI and Pydantic
Documentation
The documentation can be found at workfloworchestrator.org. To run your orchestrator in containers or on Kubernetes, see Running your orchestrator.
Installation (quick start)
Simplified steps to install and use the orchestrator-core. For more details, read the Getting started documentation.
Step 1 - Install the package
Create a virtualenv and install the orchestrator-core.
python -m venv .venv
source .venv/bin/activate
pip install orchestrator-core
Step 2 - Setup the database
Create a postgres database. The server needs
pgvector,
which the pgvector/pgvector Docker images include:
createuser -sP nwa
createdb orchestrator-core -O nwa # set password to 'nwa'
Configure the database URI in your local environment:
export DATABASE_URI=postgresql+psycopg://nwa:nwa@localhost:5432/orchestrator-core
Step 3 - Create main.py and wsgi.py
Create a main.py file for running the CLI.
from orchestrator.core.cli.main import app as core_cli
if __name__ == "__main__":
core_cli()
Create a wsgi.py file for running the web server.
from orchestrator.core import OrchestratorCore
from orchestrator.core.settings import AppSettings
app = OrchestratorCore(base_settings=AppSettings())
app.register_graphql()
Step 4 - Run the database migrations
Initialize the migration environment and database tables.
python main.py db init
python main.py db upgrade heads
Step 5 - Run the app
export OAUTH2_ACTIVE=False
uvicorn --reload --host 127.0.0.1 --port 8080 wsgi:app
Visit the ReDoc or OpenAPI page to view and interact with the API.
Contributing
We use uv to manage dependencies. Unit tests need no services; integration tests use testcontainers to spin up Postgres + Redis on demand (Docker required).
To get started, follow these steps:
# on your local machine
git clone https://github.com/workfloworchestrator/orchestrator-core
cd orchestrator-core
just pytest # Run unit tests
just pytest test/integration_tests # Run integration tests (testcontainers)
just pytest -vx # Stop at first failed test
just pytest --last-failed # re-run only failed tests
For more details please read the development docs.
Also make sure to read the Contribution guidelines.
1 maintainer
Metadata
1 maintainer
Release files for orchestrator-core 5.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| orchestrator_core-5.5.0.tar.gz | 434.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| orchestrator_core-5.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / orchestrator_core-5.5.0.tar.gz
| Download URL | orchestrator_core-5.5.0.tar.gz |
|---|---|
| Size | 434.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b44502d59e25e7616884957c3e124adc5cccbc343a663d1aa602e69b779c941a
|
|
BLAKE2b-256 checksum How to use checksums |
029863d1b2e2092cdf8e87f93f47764b5bb2784cf28677bffbae62dbb05b64f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 14, 2026.
Transparency logRelease files / orchestrator_core-5.5.0-py3-none-any.whl
| Download URL | orchestrator_core-5.5.0-py3-none-any.whl |
|---|---|
| Size | 719.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8f7ed553b94d0bbeb61fc3858620951ff3044a7ad642e4353fd4dd4f688d9201
|
|
BLAKE2b-256 checksum How to use checksums |
50acedf5313b06f9b4a553aa97835db1f36a1c0eb2638ae487b9eae93885e179
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 14, 2026.
Transparency log
