orchestrator-core 4.0.0rc4__tar.gz → 4.0.1__tar.gz

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.0.0rc4
+current_version = 4.0.1
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(rc(?P<build>\d+))?

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orchestrator-core
-Version: 4.0.0rc4
+Version: 4.0.1
 Summary: This is the orchestrator workflow engine.
 Requires-Python: >=3.11,<3.14
 Classifier: Intended Audience :: Information Technology
@@ -49,17 +49,17 @@ Requires-Dist: pytz==2025.2
 Requires-Dist: redis==5.1.1
 Requires-Dist: schedule==1.1.0
 Requires-Dist: semver==3.0.4
-Requires-Dist: sentry-sdk[fastapi]~=2.27.0
-Requires-Dist: SQLAlchemy==2.0.40
+Requires-Dist: sentry-sdk[fastapi]~=2.28.0
+Requires-Dist: SQLAlchemy==2.0.41
 Requires-Dist: SQLAlchemy-Utils==0.41.2
 Requires-Dist: structlog
-Requires-Dist: typer==0.15.3
+Requires-Dist: typer==0.15.4
 Requires-Dist: uvicorn[standard]~=0.34.0
 Requires-Dist: nwa-stdlib~=1.9.0
 Requires-Dist: oauth2-lib~=2.4.0
 Requires-Dist: tabulate==0.9.0
 Requires-Dist: strawberry-graphql>=0.246.2
-Requires-Dist: pydantic-forms>=1.4.0, <=2.0.0
+Requires-Dist: pydantic-forms>=1.4.0, <=2.1.0
 Requires-Dist: celery~=5.5.1 ; extra == "celery"
 Requires-Dist: toml ; extra == "dev"
 Requires-Dist: bumpversion ; extra == "dev"

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/docs/getting-started/base.md

@@ -15,29 +15,47 @@ Flask and Django, you install the core library, initialise it with configuration
 
 
 ### Step 1 - Install the package:
-Install the core.
+
+Create a virtualenv and install the core.
+
 <div class="termy">
-``` console
-$ pip install orchestrator-core
----> 100%
-Successfully installed orchestrator-core
+
+```shell
+python -m venv .venv
+source .venv/bin/activate
+pip install orchestrator-core
 ```
+
 </div>
 
 ### Step 2 - Setup the database:
+
 Create a postgres database:
 
 <div class="termy">
-``` shell
-$ createuser -sP nwa
-$ createdb orchestrator-core -O nwa
+
+```shell
+createuser -sP nwa
+createdb orchestrator-core -O nwa
 ```
+
 </div>
 
+Choose a password and remember it for later steps.
+
+As an example, you can run these docker commands in separate shells to start a temporary postgres instance:
+
+```shell
+docker run --rm --name temp-orch-db -e POSTGRES_PASSWORD=rootpassword -p 5432:5432 postgres:15
+
+docker exec -it temp-orch-db su - postgres -c 'createuser -sP nwa && createdb orchestrator-core -O nwa'
+```
+
 ### Step 3 - Create the main.py:
+
 Create a `main.py` file.
 
-``` python
+```python
 from orchestrator import OrchestratorCore
 from orchestrator.cli.main import app as core_cli
 from orchestrator.settings import AppSettings
@@ -48,37 +66,34 @@ if __name__ == "__main__":
     core_cli()
 ```
 
-
 ### Step 4 - Run the database migrations:
 
-Initialize the migration environment.
+Initialize the migration environment and database tables.
+
 <div class="termy">
-``` console
-$ PYTHONPATH=. python main.py db init
-$ PYTHONPATH=. python main.py db upgrade heads
+
+```shell
+export DATABASE_URI=postgresql://nwa:PASSWORD_FROM_STEP_2@localhost:5432/orchestrator-core
+
+python main.py db init
+python main.py db upgrade heads
 ```
+
 </div>
 
 ### Step 5 - Run the app
 
 <div class="termy">
 
-``` shell
-$ uvicorn --reload --host 127.0.0.1 --port 8080 main:app
-INFO:     Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)
-INFO:     Started reloader process [62967] using watchgod
-ujson module not found, using json
-msgpack not installed, MsgPackSerializer unavailable
-2021-09-28 09:42:14 [warning  ] Database object configured, all methods referencing `db` should work. [orchestrator.db]
-INFO:     Started server process [62971]
-2021-09-28 09:42:14 [info     ] Started server process [62971] [uvicorn.error]
-INFO:     Waiting for application startup.
-2021-09-28 09:42:14 [info     ] Waiting for application startup. [uvicorn.error]
-INFO:     Application startup complete.
-2021-09-28 09:42:14 [info     ] Application startup complete.  [uvicorn.error]
+```shell
+export DATABASE_URI=postgresql://nwa:PASSWORD_FROM_STEP_2@localhost:5432/orchestrator-core
+export OAUTH2_ACTIVE=False
+
+uvicorn --reload --host 127.0.0.1 --port 8080 main:app
 ```
+
 </div>
 
 ### Step 6 - Profit :boom: :grin:
 
-Visit [the app](http://127.0.0.1:8080/api/redoc) to view the api documentation.
+Visit the [ReDoc](http://127.0.0.1:8080/api/redoc) or [OpenAPI](http://127.0.0.1:8080/api/docs) to view and interact with the API.

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/docs/getting-started/orchestration-ui.md

@@ -18,15 +18,34 @@ Before running an installation of the Workflow Orchestrator UI make sure to have
 
 ### Installation
 
--   Clone the example ui repository
-    `git clone https://github.com/workfloworchestrator/example-orchestrator-ui`
--   Install the npm packages
-    `npm i`
--   Set the correct env variables. The defaults from .env.example will work out of the box with the example orchestrator backend
-    `cp .env.example .env`
--   Run the application
-    `npm run dev`
--   The orchestrator ui now runs on http://localhost:3000
+Clone the example UI repository:
+
+```
+mkdir orchestrator-ui
+cd orchestrator-ui
+git clone https://github.com/workfloworchestrator/example-orchestrator-ui .
+```
+
+Install the npm packages:
+
+```
+npm i
+```
+
+Set the correct env variables.
+To run the UI against the dockerized example orchestrator setup, it's recommended to use the `orchestrator-ui.env` env-file.
+
+```
+wget -O .env https://raw.githubusercontent.com/workfloworchestrator/example-orchestrator/refs/heads/master/docker/orchestrator-ui/orchestrator-ui.env
+```
+
+Run the application:
+
+```
+npm run dev
+```
+
+The Orchestrator UI now runs on http://localhost:3000
 
 
 

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/docs/getting-started/prepare-source-folder.md

@@ -22,11 +22,10 @@ valid Git repository.
 
 ### Migrations folder and local Alembic head
 
-The `migrations` folder is created when running `python main.py db ini`.  This
-folder is used to store the local Alembic database migrations. The
-orchestrator-core package also contains Alembic database migrations, the Alembic
-head in the core is labeled `schema`.  The local Alembic head should be labeled
-`data`.
+The `migrations` folder is created when running `python main.py db init`.
+This folder is used to store the local Alembic database migrations.
+The orchestrator-core package also contains Alembic database migrations, the Alembic head in the core is labeled `schema`.
+The local Alembic head should be labeled `data`.
 
 When you already have product(s), workflow(s) or product template(s) defined,
 the local Alembic head can be created by running either `python main.py db

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/docs/migration-guide/4.0.md

@@ -23,10 +23,14 @@ The change of the `SYSTEM` target to `VALIDATE` is a breaking change, as it will
 In the Steps section below we describe how to update your workflows to use the new `VALIDATE` target.
 
 ## Steps
+Follow these steps to upgrade:
 
+### Caching domain models
 To use 4.0.0, all workflows must have run to completion. The `cache_domain_models` step no longer is part of the codebase
 therefore `in flight` workflows will fail.
 
+
+### Upgrading to use the VALIDATE target
 After running the migration `(2025-05-08_cdf8758831d4_add_is_task_to_workflow.py)`, the workflow table should look like this:
 
 ```sql
@@ -50,7 +54,7 @@ Tasks are `SYSTEM` or `VALIDATE` workflows that are run in the context of a syst
 Example on how to update the `target` and `is_task` for all workflows that start with `validate_`:
 
 ```sql
-UPDATE workflow
+UPDATE workflows
 SET target = 'VALIDATE', is_task = TRUE
 WHERE name LIKE 'validate_%';
 ```
@@ -58,7 +62,7 @@ WHERE name LIKE 'validate_%';
 Example on how to update the `target` and `is_task` for all workflows that are `SYSTEM` or `VALIDATE`:
 
 ```sql
-UPDATE workflow
+UPDATE workflows
 SET is_task = TRUE
 WHERE target IN ('SYSTEM', 'VALIDATE');
 ```

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/mkdocs.yml

@@ -150,7 +150,7 @@ nav:
           - Prerequisites: getting-started/versions.md
           - Base Application:
                 - Preparing source folder: getting-started/prepare-source-folder.md
-                - Python Virtualenv: getting-started/base.md
+                - Base application: getting-started/base.md
           - Docker: getting-started/docker.md
           - Orchestrator UI: getting-started/orchestration-ui.md
     - Reference Documentation:

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/orchestrator/__init__.py

@@ -13,7 +13,7 @@
 
 """This is the orchestrator workflow engine."""
 
-__version__ = "4.0.0rc4"
+__version__ = "4.0.1"
 
 from orchestrator.app import OrchestratorCore
 from orchestrator.settings import app_settings

{orchestrator_core-4.0.0rc4 → orchestrator_core-4.0.1}/orchestrator/api/api_v1/endpoints/subscriptions.py

@@ -163,6 +163,7 @@ def subscriptions_search(
 @router.get(
     "/workflows/{subscription_id}",
     response_model=SubscriptionWorkflowListsSchema,
+    response_model_by_alias=True,
     response_model_exclude_none=True,
     deprecated=True,
     description="This endpoint is deprecated and will be removed in a future release. Please use the GraphQL query",