orchestrator-core 3.1.2rc1__py3-none-any.whl → 3.1.2rc3__py3-none-any.whl

orchestrator/__init__.py

@@ -13,7 +13,7 @@
 
 """This is the orchestrator workflow engine."""
 
-__version__ = "3.1.2rc1"
+__version__ = "3.1.2rc3"
 
 from orchestrator.app import OrchestratorCore
 from orchestrator.settings import app_settings

orchestrator/api/api_v1/endpoints/processes.py

@@ -58,6 +58,7 @@ from orchestrator.services.processes import (
     load_process,
     resume_process,
     start_process,
+    update_awaiting_process_progress,
 )
 from orchestrator.services.settings import get_engine_settings
 from orchestrator.settings import app_settings
@@ -197,6 +198,28 @@ def continue_awaiting_process_endpoint(
         raise_status(HTTPStatus.NOT_FOUND, str(e))
 
 
+@router.post(
+    "/{process_id}/callback/{token}/progress",
+    response_model=None,
+    status_code=HTTPStatus.OK,
+    dependencies=[Depends(check_global_lock, use_cache=False)],
+)
+def update_progress_on_awaiting_process_endpoint(
+    process_id: UUID,
+    token: str,
+    data: str | State = Body(...),
+) -> None:
+    process = _get_process(process_id)
+
+    if process.last_status != ProcessStatus.AWAITING_CALLBACK:
+        raise_status(HTTPStatus.CONFLICT, "This process is not in an awaiting state.")
+
+    try:
+        update_awaiting_process_progress(process, token=token, data=data)
+    except AssertionError as exc:
+        raise_status(HTTPStatus.NOT_FOUND, str(exc))
+
+
 @router.put(
     "/resume-all", response_model=ProcessResumeAllSchema, dependencies=[Depends(check_global_lock, use_cache=False)]
 )

orchestrator/services/processes.py

@@ -43,9 +43,10 @@ from orchestrator.targets import Target
 from orchestrator.types import BroadcastFunc
 from orchestrator.utils.datetime import nowtz
 from orchestrator.utils.errors import error_state_to_dict
-from orchestrator.websocket import broadcast_invalidate_status_counts
+from orchestrator.websocket import broadcast_invalidate_status_counts, broadcast_process_update_to_websocket
 from orchestrator.workflow import (
     CALLBACK_TOKEN_KEY,
+    DEFAULT_CALLBACK_PROGRESS_KEY,
     Failed,
     ProcessStat,
     ProcessStatus,
@@ -566,6 +567,39 @@ def resume_process(
     return resume_func(process, user_inputs=user_inputs, user=user, broadcast_func=broadcast_func)
 
 
+def ensure_correct_callback_token(pstat: ProcessStat, *, token: str) -> None:
+    """Ensure that a callback token matches the expected value in state.
+
+    Args:
+        pstat: ProcessStat of process.
+        token: The token which was generated for the process.
+
+    Raises:
+        AssertionError: if the supplied token does not match the generated process token.
+
+    """
+    state = pstat.state.unwrap()
+
+    # Check if the token matches
+    token_from_state = state.get(CALLBACK_TOKEN_KEY)
+    if token != token_from_state:
+        raise AssertionError("Invalid token")
+
+
+def replace_current_step_state(process: ProcessTable, *, new_state: State) -> None:
+    """Replace the state of the current step in a process.
+
+    Args:
+        process: Process from database
+        new_state: The new state
+
+    """
+    current_step = process.steps[-1]
+    current_step.state = new_state
+    db.session.add(current_step)
+    db.session.commit()
+
+
 def continue_awaiting_process(
     process: ProcessTable,
     *,
@@ -589,10 +623,7 @@ def continue_awaiting_process(
     pstat = load_process(process)
     state = pstat.state.unwrap()
 
-    # Check if the token matches
-    token_from_state = state.get(CALLBACK_TOKEN_KEY)
-    if token != token_from_state:
-        raise AssertionError("Invalid token")
+    ensure_correct_callback_token(pstat, token=token)
 
     # We need to pass the callback data to the worker executor. Currently, this is not supported.
     # Therefore, we update the step state in the db and kick-off resume_workflow
@@ -600,16 +631,47 @@ def continue_awaiting_process(
     result_key = state.get("__callback_result_key", "callback_result")
     state = {**state, result_key: input_data}
 
-    current_step = process.steps[-1]
-    current_step.state = state
-    db.session.add(current_step)
-    db.session.commit()
+    replace_current_step_state(process, new_state=state)
 
     # Continue the workflow
     resume_func = get_execution_context()["resume"]
     return resume_func(process, broadcast_func=broadcast_func)
 
 
+def update_awaiting_process_progress(
+    process: ProcessTable,
+    *,
+    token: str,
+    data: str | State,
+) -> UUID:
+    """Update progress for a process awaiting data from a callback.
+
+    Args:
+        process: Process from database
+        token: The token which was generated for the process. This must match.
+        data: Progress data posted to the callback
+
+    Returns:
+        process id
+
+    Raises:
+        AssertionError: if the supplied token does not match the generated process token.
+
+    """
+    pstat = load_process(process)
+
+    ensure_correct_callback_token(pstat, token=token)
+
+    state = pstat.state.unwrap()
+    progress_key = state.get(DEFAULT_CALLBACK_PROGRESS_KEY, "callback_progress")
+    state = {**state, progress_key: data} | {"__remove_keys": [progress_key]}
+
+    replace_current_step_state(process, new_state=state)
+    broadcast_process_update_to_websocket(process.process_id)
+
+    return process.process_id
+
+
 async def _async_resume_processes(
     processes: Sequence[ProcessTable],
     user_name: str,

orchestrator/workflow.py

@@ -69,6 +69,7 @@ step_log_fn_var: contextvars.ContextVar[StepLogFuncInternal] = contextvars.Conte
 
 DEFAULT_CALLBACK_ROUTE_KEY = "callback_route"
 CALLBACK_TOKEN_KEY = "__callback_token"  # noqa: S105
+DEFAULT_CALLBACK_PROGRESS_KEY = "callback_progress"  # noqa: S105
 
 
 @runtime_checkable

orchestrator_core-3.1.2rc3.dist-info/METADATA

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: orchestrator-core
+Version: 3.1.2rc3
+Summary: This is the orchestrator workflow engine.
+Requires-Python: >=3.11,<3.14
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Internet :: WWW/HTTP
+License-File: LICENSE
+Requires-Dist: alembic==1.15.1
+Requires-Dist: anyio>=3.7.0
+Requires-Dist: click==8.*
+Requires-Dist: deprecated
+Requires-Dist: deepmerge==2.0
+Requires-Dist: fastapi~=0.115.2
+Requires-Dist: fastapi-etag==0.4.0
+Requires-Dist: more-itertools~=10.6.0
+Requires-Dist: itsdangerous
+Requires-Dist: Jinja2==3.1.6
+Requires-Dist: orjson==3.10.15
+Requires-Dist: psycopg[binary]==3.2.6
+Requires-Dist: pydantic[email]~=2.8.2
+Requires-Dist: pydantic-settings~=2.8.0
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: python-rapidjson>=1.18,<1.21
+Requires-Dist: pytz==2025.1
+Requires-Dist: redis==5.1.1
+Requires-Dist: schedule==1.1.0
+Requires-Dist: sentry-sdk[fastapi]~=2.22.0
+Requires-Dist: SQLAlchemy==2.0.39
+Requires-Dist: SQLAlchemy-Utils==0.41.2
+Requires-Dist: structlog
+Requires-Dist: typer==0.15.2
+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
+Requires-Dist: celery~=5.4.0 ; extra == "celery"
+Requires-Dist: toml ; extra == "dev"
+Requires-Dist: bumpversion ; extra == "dev"
+Requires-Dist: mypy_extensions ; extra == "dev"
+Requires-Dist: pre-commit ; extra == "dev"
+Requires-Dist: pydocstyle ; extra == "dev"
+Requires-Dist: python-dotenv ; extra == "dev"
+Requires-Dist: watchdog ; extra == "dev"
+Requires-Dist: mkdocs ; extra == "doc"
+Requires-Dist: mkdocs-material[imaging] ; extra == "doc"
+Requires-Dist: mkdocs-render-swagger-plugin ; extra == "doc"
+Requires-Dist: mkdocs-include-markdown-plugin ; extra == "doc"
+Requires-Dist: mkdocstrings[python] ; extra == "doc"
+Requires-Dist: mkdocs-open-in-new-tab ; extra == "doc"
+Requires-Dist: mkdocs-macros-plugin ; extra == "doc"
+Requires-Dist: mkdocs-embed-external-markdown ; extra == "doc"
+Requires-Dist: apache-license-check ; extra == "test"
+Requires-Dist: black ; extra == "test"
+Requires-Dist: blinker ; extra == "test"
+Requires-Dist: deepdiff ; extra == "test"
+Requires-Dist: dirty-equals ; extra == "test"
+Requires-Dist: jsonref ; extra == "test"
+Requires-Dist: mypy==1.9 ; extra == "test"
+Requires-Dist: pyinstrument ; extra == "test"
+Requires-Dist: pytest==8.3.5 ; extra == "test"
+Requires-Dist: pytest-asyncio==0.21.2 ; extra == "test"
+Requires-Dist: pytest-codspeed ; extra == "test"
+Requires-Dist: pytest-cov ; extra == "test"
+Requires-Dist: pytest-httpx ; extra == "test"
+Requires-Dist: pytest-xdist ; extra == "test"
+Requires-Dist: requests-mock ; extra == "test"
+Requires-Dist: ruff ; extra == "test"
+Requires-Dist: sqlalchemy[mypy] ; extra == "test"
+Requires-Dist: urllib3-mock ; extra == "test"
+Requires-Dist: types-Deprecated ; extra == "test"
+Requires-Dist: types-Jinja2 ; extra == "test"
+Requires-Dist: types-aiofiles ; extra == "test"
+Requires-Dist: types-certifi ; extra == "test"
+Requires-Dist: types-click ; extra == "test"
+Requires-Dist: types-itsdangerous ; extra == "test"
+Requires-Dist: types-orjson ; extra == "test"
+Requires-Dist: types-python-dateutil ; extra == "test"
+Requires-Dist: types-pytz ; extra == "test"
+Requires-Dist: types-redis ; extra == "test"
+Requires-Dist: types-requests ; extra == "test"
+Requires-Dist: types-setuptools ; extra == "test"
+Requires-Dist: types-tabulate ; extra == "test"
+Requires-Dist: types-toml ; extra == "test"
+Requires-Dist: types-ujson ; extra == "test"
+Requires-Dist: types-PyYAML ; extra == "test"
+Project-URL: Documentation, https://workfloworchestrator.org/orchestrator-core/
+Project-URL: Source, https://github.com/workfloworchestrator/orchestrator-core
+Provides-Extra: celery
+Provides-Extra: dev
+Provides-Extra: doc
+Provides-Extra: test

{orchestrator_core-3.1.2rc1.dist-info → orchestrator_core-3.1.2rc3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-orchestrator/__init__.py,sha256=ZP1Jysb045z9lRfVO6EzA1vnZiG_nSFXoDDnIg34onM,1058
+orchestrator/__init__.py,sha256=SRujUPF8rKeTg1Ixeu8yyiXCPAlFG-1XYRWLEWtP0SQ,1058
 orchestrator/app.py,sha256=8GMzoHjdR0bkgRBCejiG8nIUjeo43f12I3WNNZ89pKE,11659
 orchestrator/exception_handlers.py,sha256=UsW3dw8q0QQlNLcV359bIotah8DYjMsj2Ts1LfX4ClY,1268
 orchestrator/log_config.py,sha256=1tPRX5q65e57a6a_zEii_PFK8SzWT0mnA5w2sKg4hh8,1853
@@ -8,7 +8,7 @@ orchestrator/settings.py,sha256=lrNKPtJMxZtbEZcUZ1MDGEpIDCJv_swWVoVJvwcooCY,4614
 orchestrator/targets.py,sha256=q_IMCdVUUYWcyKHqyls38fJPveJDBNfSzMKj_U2hLsk,768
 orchestrator/types.py,sha256=4vDeL5teRnugXoet3O2dMv8WwTsEyimrIfzagx9jQRo,15451
 orchestrator/version.py,sha256=b58e08lxs47wUNXv0jXFO_ykpksmytuzEXD4La4W-NQ,1366
-orchestrator/workflow.py,sha256=sdHAuxOsMNzHf3xum-9Lm9FE0OfCm2VcauroOTYn1fw,43051
+orchestrator/workflow.py,sha256=eQEmi7IwnipDuwCmv1ipYWJbmOuxSG0_nH0-DMfUJog,43117
 orchestrator/api/__init__.py,sha256=GyHNfEFCGKQwRiN6rQmvSRH2iYX7npjMZn97n8XzmLU,571
 orchestrator/api/error_handling.py,sha256=YrPCxSa-DSa9KwqIMlXI-KGBGnbGIW5ukOPiikUH9E4,1502
 orchestrator/api/helpers.py,sha256=s0QRHYw8AvEmlkmRhuEzz9xixaZKUF3YuPzUVHkcoXk,6933
@@ -17,7 +17,7 @@ orchestrator/api/api_v1/__init__.py,sha256=GyHNfEFCGKQwRiN6rQmvSRH2iYX7npjMZn97n
 orchestrator/api/api_v1/api.py,sha256=Q_Yh9w_SBoyx06jV_kf6leGFrAMXoGjF8UikIAie_us,2858
 orchestrator/api/api_v1/endpoints/__init__.py,sha256=GyHNfEFCGKQwRiN6rQmvSRH2iYX7npjMZn97n8XzmLU,571
 orchestrator/api/api_v1/endpoints/health.py,sha256=iaxs1XX1_250_gKNsspuULCV2GEMBjbtjsmfQTOvMAI,1284
-orchestrator/api/api_v1/endpoints/processes.py,sha256=VPNqzogjgK9Y-70b9r-tqPSJD-6PyMj9kOrmhPC__lc,12763
+orchestrator/api/api_v1/endpoints/processes.py,sha256=l85OZ-gs6YeVjFVsGhq6z_Hwkl-oY5YUagXlgzyivx8,13481
 orchestrator/api/api_v1/endpoints/product_blocks.py,sha256=kZ6ywIOsS_S2qGq7RvZ4KzjvaS1LmwbGWR37AKRvWOw,2146
 orchestrator/api/api_v1/endpoints/products.py,sha256=BfFtwu9dZXEQbtKxYj9icc73GKGvAGMR5ytyf41nQlQ,3081
 orchestrator/api/api_v1/endpoints/resource_types.py,sha256=gGyuaDyOD0TAVoeFGaGmjDGnQ8eQQArOxKrrk4MaDzA,2145
@@ -248,7 +248,7 @@ orchestrator/services/celery.py,sha256=DHruqocnORNZUca9WDIti9GXYk9Q38BFyeJy7-N7l
 orchestrator/services/fixed_inputs.py,sha256=kyz7s2HLzyDulvcq-ZqefTw1om86COvyvTjz0_5CmgI,876
 orchestrator/services/input_state.py,sha256=HF7wl9fWdaAW8pdCCqbuYoKyNj8dY0g8Ff8vXis8z5A,2211
 orchestrator/services/process_broadcast_thread.py,sha256=D44YbjF8mRqGuznkRUV4SoRn1J0lfy_x1H508GnSVlU,4649
-orchestrator/services/processes.py,sha256=pucntLu1f-2ZTgSQG7l3qDX5zQGFhat4-iaq7ecglGo,27618
+orchestrator/services/processes.py,sha256=NuxNHaaXc2IlLhMp0rf9-EPgsDjybDCfglQd9wBhOP0,29405
 orchestrator/services/products.py,sha256=w6b6sSA3MstmbM_YN8xWEvkb_YnuCQFph48wYU3_Lx4,1935
 orchestrator/services/resource_types.py,sha256=_QBy_JOW_X3aSTqH0CuLrq4zBJL0p7Q-UDJUcuK2_qc,884
 orchestrator/services/settings.py,sha256=u-834F4KWloXS8zi7R9mp-D3cjl-rbVjKJRU35IqhXo,2723
@@ -291,7 +291,7 @@ orchestrator/workflows/tasks/resume_workflows.py,sha256=R0I3jxGToiqDr5mF3YjDd6dN
 orchestrator/workflows/tasks/validate_product_type.py,sha256=5FwhRQyMNgtys5DM846EIIY0uXKvnSYy3Orf7lOg0DA,3176
 orchestrator/workflows/tasks/validate_products.py,sha256=5uXX7MXMDDP13cXRvfLDNvvCp4nG7zLQBm_IYdf8BSs,8513
 orchestrator/workflows/translations/en-GB.json,sha256=ST53HxkphFLTMjFHonykDBOZ7-P_KxksktZU3GbxLt0,846
-orchestrator_core-3.1.2rc1.dist-info/licenses/LICENSE,sha256=b-aA5OZQuuBATmLKo_mln8CQrDPPhg3ghLzjPjLn4Tg,11409
-orchestrator_core-3.1.2rc1.dist-info/WHEEL,sha256=_2ozNFCLWc93bK4WKHCO-eDUENDlo-dgc9cU3qokYO4,82
-orchestrator_core-3.1.2rc1.dist-info/METADATA,sha256=y1VUynKBYQow9miuCnXpMg_4VkNQdyODnTBr8X6v-xU,11160
-orchestrator_core-3.1.2rc1.dist-info/RECORD,,
+orchestrator_core-3.1.2rc3.dist-info/licenses/LICENSE,sha256=b-aA5OZQuuBATmLKo_mln8CQrDPPhg3ghLzjPjLn4Tg,11409
+orchestrator_core-3.1.2rc3.dist-info/WHEEL,sha256=_2ozNFCLWc93bK4WKHCO-eDUENDlo-dgc9cU3qokYO4,82
+orchestrator_core-3.1.2rc3.dist-info/METADATA,sha256=jh6W7fea4ZKjoqBM-q5LM_zvE5F1mgHEwV2_O2qO-mk,4993
+orchestrator_core-3.1.2rc3.dist-info/RECORD,,

orchestrator_core-3.1.2rc1.dist-info/METADATA

@@ -1,321 +0,0 @@
-Metadata-Version: 2.4
-Name: orchestrator-core
-Version: 3.1.2rc1
-Summary: This is the orchestrator workflow engine.
-Author-email: SURF <automation-beheer@surf.nl>
-Requires-Python: >=3.11,<3.14
-Description-Content-Type: text/markdown
-License-Expression: Apache-2.0
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: System Administrators
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python
-Classifier: Topic :: Internet
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: Software Development
-Classifier: Typing :: Typed
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Web Environment
-Classifier: Framework :: AsyncIO
-Classifier: Framework :: FastAPI
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Telecommunications Industry
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
-Classifier: Topic :: Internet :: WWW/HTTP
-License-File: LICENSE
-Requires-Dist: alembic==1.15.1
-Requires-Dist: anyio>=3.7.0
-Requires-Dist: click==8.*
-Requires-Dist: deprecated
-Requires-Dist: deepmerge==2.0
-Requires-Dist: fastapi~=0.115.2
-Requires-Dist: fastapi-etag==0.4.0
-Requires-Dist: more-itertools~=10.6.0
-Requires-Dist: itsdangerous
-Requires-Dist: Jinja2==3.1.6
-Requires-Dist: orjson==3.10.15
-Requires-Dist: psycopg[binary]==3.2.6
-Requires-Dist: pydantic[email]~=2.10.6
-Requires-Dist: pydantic-settings~=2.8.0
-Requires-Dist: python-dateutil==2.8.2
-Requires-Dist: python-rapidjson>=1.18,<1.21
-Requires-Dist: pytz==2025.1
-Requires-Dist: redis==5.1.1
-Requires-Dist: schedule==1.1.0
-Requires-Dist: sentry-sdk[fastapi]~=2.22.0
-Requires-Dist: SQLAlchemy==2.0.39
-Requires-Dist: SQLAlchemy-Utils==0.41.2
-Requires-Dist: structlog
-Requires-Dist: typer==0.15.2
-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
-Requires-Dist: celery~=5.4.0 ; extra == "celery"
-Requires-Dist: toml ; extra == "dev"
-Requires-Dist: bumpversion ; extra == "dev"
-Requires-Dist: mypy_extensions ; extra == "dev"
-Requires-Dist: pre-commit ; extra == "dev"
-Requires-Dist: pydocstyle ; extra == "dev"
-Requires-Dist: python-dotenv ; extra == "dev"
-Requires-Dist: watchdog ; extra == "dev"
-Requires-Dist: mkdocs ; extra == "doc"
-Requires-Dist: mkdocs-material[imaging] ; extra == "doc"
-Requires-Dist: mkdocs-render-swagger-plugin ; extra == "doc"
-Requires-Dist: mkdocs-include-markdown-plugin ; extra == "doc"
-Requires-Dist: mkdocstrings[python] ; extra == "doc"
-Requires-Dist: mkdocs-open-in-new-tab ; extra == "doc"
-Requires-Dist: mkdocs-macros-plugin ; extra == "doc"
-Requires-Dist: mkdocs-embed-external-markdown ; extra == "doc"
-Requires-Dist: apache-license-check ; extra == "test"
-Requires-Dist: black ; extra == "test"
-Requires-Dist: blinker ; extra == "test"
-Requires-Dist: deepdiff ; extra == "test"
-Requires-Dist: dirty-equals ; extra == "test"
-Requires-Dist: jsonref ; extra == "test"
-Requires-Dist: mypy==1.9 ; extra == "test"
-Requires-Dist: pyinstrument ; extra == "test"
-Requires-Dist: pytest==8.3.5 ; extra == "test"
-Requires-Dist: pytest-asyncio==0.21.2 ; extra == "test"
-Requires-Dist: pytest-codspeed ; extra == "test"
-Requires-Dist: pytest-cov ; extra == "test"
-Requires-Dist: pytest-httpx ; extra == "test"
-Requires-Dist: pytest-xdist ; extra == "test"
-Requires-Dist: requests-mock ; extra == "test"
-Requires-Dist: ruff ; extra == "test"
-Requires-Dist: sqlalchemy[mypy] ; extra == "test"
-Requires-Dist: urllib3-mock ; extra == "test"
-Requires-Dist: types-Deprecated ; extra == "test"
-Requires-Dist: types-Jinja2 ; extra == "test"
-Requires-Dist: types-aiofiles ; extra == "test"
-Requires-Dist: types-certifi ; extra == "test"
-Requires-Dist: types-click ; extra == "test"
-Requires-Dist: types-itsdangerous ; extra == "test"
-Requires-Dist: types-orjson ; extra == "test"
-Requires-Dist: types-python-dateutil ; extra == "test"
-Requires-Dist: types-pytz ; extra == "test"
-Requires-Dist: types-redis ; extra == "test"
-Requires-Dist: types-requests ; extra == "test"
-Requires-Dist: types-setuptools ; extra == "test"
-Requires-Dist: types-tabulate ; extra == "test"
-Requires-Dist: types-toml ; extra == "test"
-Requires-Dist: types-ujson ; extra == "test"
-Requires-Dist: types-PyYAML ; extra == "test"
-Project-URL: documentation, https://workfloworchestrator.org/orchestrator-core/
-Project-URL: releasenotes, https://github.com/workfloworchestrator/orchestrator-core/releases
-Project-URL: source, https://github.com/workfloworchestrator/orchestrator-core
-Provides-Extra: celery
-Provides-Extra: dev
-Provides-Extra: doc
-Provides-Extra: test
-
-# Orchestrator-Core
-[![Downloads](https://pepy.tech/badge/orchestrator-core/month)](https://pepy.tech/project/orchestrator-core)
-[![codecov](https://codecov.io/gh/workfloworchestrator/orchestrator-core/branch/main/graph/badge.svg?token=5ANQFI2DHS)](https://codecov.io/gh/workfloworchestrator/orchestrator-core)
-[![pypi_version](https://img.shields.io/pypi/v/orchestrator-core?color=%2334D058&label=pypi%20package)](https://pypi.org/project/orchestrator-core)
-[![Supported python versions](https://img.shields.io/pypi/pyversions/orchestrator-core.svg?color=%2334D058)](https://pypi.org/project/orchestrator-core)
-![Discord](https://img.shields.io/discord/1295834294270558280?style=flat&logo=discord&label=discord&link=https%3A%2F%2Fdiscord.gg%2FKNgF6gE8)
-
-<p style="text-align: center"><em>Production ready Orchestration Framework to manage product lifecycle and workflows. Easy to use, Built on top of FastAPI</em></p>
-
-
-## Documentation
-Can be found [here](https://workfloworchestrator.org/orchestrator-core/)
-
-## Usage
-This project can be installed as follows:
-
-#### Step 1:
-Install the core.
-```shell
-pip install orchestrator-core
-```
-
-#### Step 2:
-Create a postgres database:
-```shell
-createuser -sP nwa
-createdb orchestrator-core -O nwa
-```
-
-#### Step 3 (optional):
-When using multiple workers, you will need a redis server for live updates with websockets.
-
-By default it will use memory which works with only one worker.
-```shell
-export WEBSOCKET_BROADCASTER_URL="memory://"
-```
-
-For the redis connection you need to set the env variable with the connection url.
-```shell
-export WEBSOCKET_BROADCASTER_URL="redis://localhost:6379"
-```
-
-
-Websockets can also be turned off with:
-```shell
-export ENABLE_WEBSOCKETS=False
-```
-
-If you want to use pickle for CACHE serialization you will need to set the `CACHE_HMAC_SECRET`:
-```shell
-export CACHE_HMAC_SECRET="SOMESECRET"
-```
-**NOTE**: The key can be any length. However, the recommended size is 1024 bits.
-
-#### Step 4:
-Create a `main.py` file.
-
-```python
-from orchestrator import OrchestratorCore
-from orchestrator.cli.main import app as core_cli
-from orchestrator.settings import AppSettings
-
-app = OrchestratorCore(base_settings=AppSettings())
-
-if __name__ == "__main__":
-    core_cli()
-```
-
-#### Step 5 (Optional):
-OrchestratorCore comes with a graphql interface that can to be registered after you create your OrchestratorApp.
-If you add it after registering your `SUBSCRIPTION_MODEL_REGISTRY` it will automatically create graphql types for them.
-More info can be found in `docs/architecture/application/graphql.md`
-
-example:
-```python
-from orchestrator import OrchestratorCore
-from orchestrator.settings import AppSettings
-
-app = OrchestratorCore(base_settings=AppSettings())
-# register SUBSCRIPTION_MODEL_REGISTRY
-app.register_graphql()
-```
-
-#### Step 6:
-Initialize the migration environment.
-```shell
-PYTHONPATH=. python main.py db init
-PYTHONPATH=. python main.py db upgrade heads
-```
-
-### Step 7:
-Profit :)
-
-Authentication and authorization are default enabled, to disable set `OAUTH2_ACTIVE` and `OAUTH2_AUTHORIZATION_ACTIVE` to `False`.
-
-```shell
-uvicorn --reload --host 127.0.0.1 --port 8080 main:app
-```
-
-Visit [http://127.0.0.1:8080/api/redoc](http://127.0.0.1:8080/api/redoc) to view the api documentation.
-
-
-## Setting up a development environment
-
-To add features to the repository follow the following procedure to setup a working development environment.
-
-### Installation (Development standalone)
-Install the project and its dependencies to develop on the code.
-
-#### Step 1 - install flit:
-
-```shell
-python3 -m venv venv
-source venv/bin/activate
-pip install flit
-```
-
-#### Step 2 - install the development code:
-
-!!! danger
-    Make sure to use the flit binary that is installed in your environment. You can check the correct
-    path by running
-    ```shell
-    which flit
-    ```
-
-To be sure that the packages will be installed against the correct venv you can also prepend the python interpreter
-that you want to use:
-
-```shell
-flit install --deps develop --symlink --python venv/bin/python
-```
-
-
-### Running tests
-Run the unit-test suite to verify a correct setup.
-
-#### Step 1 - Create a database
-
-```shell
-createuser -sP nwa
-createdb orchestrator-core-test -O nwa
-```
-
-#### Step 2 - Run tests
-```shell
-pytest test/unit_tests
-```
-or with xdist:
-
-```shell
-pytest -n auto test/unit_tests
-```
-
-If you do not encounter any failures in the test, you should be able to develop features in the orchestrator-core.
-
-### Installation (Development symlinked into orchestrator SURF)
-
-If you are working on a project that already uses the `orchestrator-core` and you want to test your new core features
-against it, you can use some `flit` magic to symlink the dev version of the core to your project. It will
-automatically replace the pypi dep with a symlink to the development version
-of the core and update/downgrade all required packages in your own orchestrator project.
-
-#### Step 1 - install flit:
-
-```shell
-python - m venv venv
-source venv/bin/activate
-pip install flit
-```
-
-### Step 2 - symlink the core to your own project
-
-```shell
-flit install --deps develop --symlink --python /path/to/a/orchestrator-project/venv/bin/python
-```
-
-So if you have the core and your own orchestrator project repo in the same folder and the main project folder is
-`orchestrator` and you want to use relative links, this will be last step:
-
-```shell
-flit install --deps develop --symlink --python ../orchestrator/venv/bin/python
-```
-
-# Increasing the version number for a (pre) release.
-
-When your PR is accepted you will get a version number.
-
-You can do the necessary change with a clean, e.g. every change committed, branch:
-
-```shell
-bumpversion patch --new-version 0.4.1-rc3
-```
-
-### Changing the Core database schema
-When you would like to change the core database schema, execute the following steps.
-
-- Create the new model `orchestrator/database/models.py`
-- `cd orchestrator/migrations`
-- `alembic revision --autogenerate -m "Name of the migratioin"`
-