Skip to main content

Orchestrator-Core

Downloads codecov pypi_version Supported python versions Discord

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orchestrator_core-5.1.2.tar.gz (379.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orchestrator_core-5.1.2-py3-none-any.whl (673.3 kB view details)

Uploaded Python 3

File details

Details for the file orchestrator_core-5.1.2.tar.gz.

File metadata

  • Download URL: orchestrator_core-5.1.2.tar.gz
  • Upload date:
  • Size: 379.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for orchestrator_core-5.1.2.tar.gz
Algorithm Hash digest
SHA256 b795e2a8b87f934cdd2ec0a16c4327b96874bb5e298df111d1727fc2d52a2694
MD5 05a48b4655e52ab9d8c36349364c142e
BLAKE2b-256 9e2e454cb4e12d16baf4581760509b751421f4670fbdb43b364db3a7d59f7644

See more details on using hashes here.

Provenance

The following attestation bundles were made for orchestrator_core-5.1.2.tar.gz:

Publisher: publish-package.yml on workfloworchestrator/orchestrator-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file orchestrator_core-5.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for orchestrator_core-5.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9a3a55cb3272175d88c81095fe37d4868b925dcf7bc3fa6a49b7792dc315805f
MD5 7fb9563843c993715df33e086acf7d11
BLAKE2b-256 4a6b2f340645071e700eaffbe6b712a16ff17b15f5f2a77b1cc7b3c85462cf47

See more details on using hashes here.

Provenance

The following attestation bundles were made for orchestrator_core-5.1.2-py3-none-any.whl:

Publisher: publish-package.yml on workfloworchestrator/orchestrator-core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

5.3.0

2 files

5.2.0

2 files

5.1.3

2 files

This release

5.1.2 This release

2 files

5.1.1

2 files

5.1.0

2 files

5.0.5

2 files

5.0.4

2 files

5.0.3

2 files

5.0.2

2 files

5.0.1

2 files

5.0.0

2 files

5.0.0a1

2 files

4.8.2

2 files

4.8.1

2 files

4.8.0

2 files

4.7.2

2 files

4.7.1

2 files

4.7.0

2 files

4.6.5

2 files

4.6.4

2 files

4.6.3

2 files

4.6.2

2 files

4.6.1

2 files

4.6.0

2 files

4.5.3

2 files

4.5.2

2 files

4.5.1

2 files

4.5.0

2 files

4.4.2

2 files

4.4.1

2 files

4.4.0

2 files

4.3.1

2 files

4.3.0

2 files

4.2.0

2 files

4.1.0

2 files

4.0.4

2 files

4.0.3

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

3.2.3

2 files

3.2.2

2 files

3.2.1

2 files

3.2.0

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.10.0

2 files

2.9.2

2 files

2.9.1

2 files

2.9.0

2 files

2.8.0

2 files

2.7.6

2 files

2.7.5

2 files

2.7.4

2 files

2.7.3

2 files

2.7.2

2 files

2.7.1

2 files

2.7.0

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.5.1

2 files

2.5.0

2 files

2.4.0

2 files

2.3.1

2 files

2.3.0

2 files

2.2.2

2 files

2.2.1

2 files

2.2.0

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.7

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.8

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.14

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page