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.
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:
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file orchestrator_core-5.1.1.tar.gz.
File metadata
- Download URL: orchestrator_core-5.1.1.tar.gz
- Upload date:
- Size: 378.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
30628aa3395e4d1e44543f5044d05e5a7aba7b31ba58037f886afeeaf8b1a641
|
|
| MD5 |
cc1a3073114cd749d5ec74769d24b372
|
|
| BLAKE2b-256 |
f38d31a768f89478fb840defb486de59963d0a74adc77371564e30b00ff64fb0
|
Provenance
The following attestation bundles were made for orchestrator_core-5.1.1.tar.gz:
Publisher:
publish-package.yml on workfloworchestrator/orchestrator-core
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
orchestrator_core-5.1.1.tar.gz -
Subject digest:
30628aa3395e4d1e44543f5044d05e5a7aba7b31ba58037f886afeeaf8b1a641 - Sigstore transparency entry: 2171780988
- Sigstore integration time:
-
Permalink:
workfloworchestrator/orchestrator-core@056a732823d2dae5f1e35cc0fac2c4545ec48d99 -
Branch / Tag:
refs/tags/5.1.1 - Owner: https://github.com/workfloworchestrator
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-package.yml@056a732823d2dae5f1e35cc0fac2c4545ec48d99 -
Trigger Event:
release
-
Statement type:
File details
Details for the file orchestrator_core-5.1.1-py3-none-any.whl.
File metadata
- Download URL: orchestrator_core-5.1.1-py3-none-any.whl
- Upload date:
- Size: 672.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8900c313d54a90fb454ec6c9343d51b4d94ddfbd97e6aa548670be364069f2e5
|
|
| MD5 |
d360278ec23b546fd689aaed0ebf0b8a
|
|
| BLAKE2b-256 |
11ca305b34c10a9fb30dd8433514c1e254edc2a8a32d7a44fdd06f9a96a23239
|
Provenance
The following attestation bundles were made for orchestrator_core-5.1.1-py3-none-any.whl:
Publisher:
publish-package.yml on workfloworchestrator/orchestrator-core
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
orchestrator_core-5.1.1-py3-none-any.whl -
Subject digest:
8900c313d54a90fb454ec6c9343d51b4d94ddfbd97e6aa548670be364069f2e5 - Sigstore transparency entry: 2171780998
- Sigstore integration time:
-
Permalink:
workfloworchestrator/orchestrator-core@056a732823d2dae5f1e35cc0fac2c4545ec48d99 -
Branch / Tag:
refs/tags/5.1.1 - Owner: https://github.com/workfloworchestrator
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-package.yml@056a732823d2dae5f1e35cc0fac2c4545ec48d99 -
Trigger Event:
release
-
Statement type:
