| Name | orchestrator-core JSON |
| Version |
4.6.1
JSON |
| download |
| home_page | None |
| Summary | This is the orchestrator workflow engine. |
| upload_time | 2025-11-03 15:19:04 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.14,>=3.11 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# Orchestrator-Core
[](https://pepy.tech/project/orchestrator-core)
[](https://codecov.io/gh/workfloworchestrator/orchestrator-core)
[](https://pypi.org/project/orchestrator-core)
[](https://pypi.org/project/orchestrator-core)
<p style="text-align: center"><em>Production ready Orchestration Framework to manage product lifecycle and workflows. Easy to use, built on top of FastAPI and Pydantic</em></p>
## Documentation
The documentation can be found at [workfloworchestrator.org](https://workfloworchestrator.org/orchestrator-core/).
## Installation (quick start)
Simplified steps to install and use the orchestrator-core.
For more details, read the [Getting started](https://workfloworchestrator.org/orchestrator-core/getting-started/base/) documentation.
### Step 1 - Install the package
Create a virtualenv and install the orchestrator-core.
```shell
python -m venv .venv
source .venv/bin/activate
pip install orchestrator-core
```
### Step 2 - Setup the database
Create a postgres database:
```shell
createuser -sP nwa
createdb orchestrator-core -O nwa # set password to 'nwa'
```
Configure the database URI in your local environment:
```
export DATABASE_URI=postgresql://nwa:nwa@localhost:5432/orchestrator-core
```
### Step 3 - Create main.py and wsgi.py
Create a `main.py` file for running the CLI.
```python
from orchestrator.cli.main import app as core_cli
if __name__ == "__main__":
core_cli()
```
Create a `wsgi.py` file for running the web server.
```python
from orchestrator import OrchestratorCore
from orchestrator.settings import AppSettings
app = OrchestratorCore(base_settings=AppSettings())
```
### Step 4 - Run the database migrations
Initialize the migration environment and database tables.
```shell
python main.py db init
python main.py db upgrade heads
```
### Step 5 - Run the app
```shell
export OAUTH2_ACTIVE=False
uvicorn --reload --host 127.0.0.1 --port 8080 wsgi:app
```
Visit the [ReDoc](http://127.0.0.1:8080/api/redoc) or [OpenAPI](http://127.0.0.1:8080/api/docs) page to view and interact with the API.
## Contributing
We use [uv](https://docs.astral.sh/uv/getting-started/installation/) to manage dependencies.
To get started, follow these steps:
```shell
# in your postgres database
createdb orchestrator-core-test -O nwa # set password to 'nwa'
# on your local machine
git clone https://github.com/workfloworchestrator/orchestrator-core
cd orchestrator-core
export DATABASE_URI=postgresql://nwa:nwa@localhost:5432/orchestrator-core-test
uv sync --all-extras --all-groups
uv run pytest
```
For more details please read the [development docs](https://workfloworchestrator.org/orchestrator-core/contributing/development/).
Raw data
{
"_id": null,
"home_page": null,
"name": "orchestrator-core",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "SURF <automation-beheer@surf.nl>",
"download_url": "https://files.pythonhosted.org/packages/8e/f5/ddc085858abc3cdc00733721807d88ffd8a378ec69a3b9a469de9f3f0f73/orchestrator_core-4.6.1.tar.gz",
"platform": null,
"description": "# Orchestrator-Core\n\n[](https://pepy.tech/project/orchestrator-core)\n[](https://codecov.io/gh/workfloworchestrator/orchestrator-core)\n[](https://pypi.org/project/orchestrator-core)\n[](https://pypi.org/project/orchestrator-core)\n\n\n<p style=\"text-align: center\"><em>Production ready Orchestration Framework to manage product lifecycle and workflows. Easy to use, built on top of FastAPI and Pydantic</em></p>\n\n## Documentation\n\nThe documentation can be found at [workfloworchestrator.org](https://workfloworchestrator.org/orchestrator-core/).\n\n## Installation (quick start)\n\nSimplified steps to install and use the orchestrator-core.\nFor more details, read the [Getting started](https://workfloworchestrator.org/orchestrator-core/getting-started/base/) documentation.\n\n### Step 1 - Install the package\n\nCreate a virtualenv and install the orchestrator-core.\n\n```shell\npython -m venv .venv\nsource .venv/bin/activate\npip install orchestrator-core\n```\n\n### Step 2 - Setup the database\n\nCreate a postgres database:\n\n```shell\ncreateuser -sP nwa\ncreatedb orchestrator-core -O nwa # set password to 'nwa'\n```\n\nConfigure the database URI in your local environment:\n\n```\nexport DATABASE_URI=postgresql://nwa:nwa@localhost:5432/orchestrator-core\n```\n\n### Step 3 - Create main.py and wsgi.py\n\nCreate a `main.py` file for running the CLI.\n\n```python\nfrom orchestrator.cli.main import app as core_cli\n\nif __name__ == \"__main__\":\n core_cli()\n```\n\nCreate a `wsgi.py` file for running the web server.\n\n```python\nfrom orchestrator import OrchestratorCore\nfrom orchestrator.settings import AppSettings\n\napp = OrchestratorCore(base_settings=AppSettings())\n```\n\n### Step 4 - Run the database migrations\n\nInitialize the migration environment and database tables.\n\n```shell\npython main.py db init\npython main.py db upgrade heads\n```\n\n### Step 5 - Run the app\n\n```shell\nexport OAUTH2_ACTIVE=False\nuvicorn --reload --host 127.0.0.1 --port 8080 wsgi:app\n```\n\nVisit the [ReDoc](http://127.0.0.1:8080/api/redoc) or [OpenAPI](http://127.0.0.1:8080/api/docs) page to view and interact with the API.\n\n## Contributing\n\nWe use [uv](https://docs.astral.sh/uv/getting-started/installation/) to manage dependencies.\n\nTo get started, follow these steps:\n\n```shell\n# in your postgres database\ncreatedb orchestrator-core-test -O nwa # set password to 'nwa'\n\n# on your local machine\ngit clone https://github.com/workfloworchestrator/orchestrator-core\ncd orchestrator-core\nexport DATABASE_URI=postgresql://nwa:nwa@localhost:5432/orchestrator-core-test\nuv sync --all-extras --all-groups\nuv run pytest\n```\n\nFor more details please read the [development docs](https://workfloworchestrator.org/orchestrator-core/contributing/development/).\n\n",
"bugtrack_url": null,
"license": null,
"summary": "This is the orchestrator workflow engine.",
"version": "4.6.1",
"project_urls": {
"Documentation": "https://workfloworchestrator.org/orchestrator-core",
"Homepage": "https://workfloworchestrator.org/orchestrator-core",
"Source": "https://github.com/workfloworchestrator/orchestrator-core"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c843ebcebde092cdf35814050824a211048d9c07ae35ed2609a9d21a59066d9b",
"md5": "80138b68ee1f05213441521b0911b269",
"sha256": "f03cb148ce94308b3da01999f52d15026613c6f6f5dc484614ac8d3c91751c1b"
},
"downloads": -1,
"filename": "orchestrator_core-4.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "80138b68ee1f05213441521b0911b269",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.11",
"size": 517303,
"upload_time": "2025-11-03T15:19:03",
"upload_time_iso_8601": "2025-11-03T15:19:03.007243Z",
"url": "https://files.pythonhosted.org/packages/c8/43/ebcebde092cdf35814050824a211048d9c07ae35ed2609a9d21a59066d9b/orchestrator_core-4.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8ef5ddc085858abc3cdc00733721807d88ffd8a378ec69a3b9a469de9f3f0f73",
"md5": "7f2cce325bc55292e9a541ebe8891106",
"sha256": "81d1681bbfa289498b834ae5cc7312208879e80c332d2508d3ec21a0895ea4d7"
},
"downloads": -1,
"filename": "orchestrator_core-4.6.1.tar.gz",
"has_sig": false,
"md5_digest": "7f2cce325bc55292e9a541ebe8891106",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.11",
"size": 308035,
"upload_time": "2025-11-03T15:19:04",
"upload_time_iso_8601": "2025-11-03T15:19:04.731002Z",
"url": "https://files.pythonhosted.org/packages/8e/f5/ddc085858abc3cdc00733721807d88ffd8a378ec69a3b9a469de9f3f0f73/orchestrator_core-4.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-03 15:19:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "workfloworchestrator",
"github_project": "orchestrator-core",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "orchestrator-core"
}
