Skip to content

docs: clarify OrkesClients OSS compatibility and scan_for_annotated_workers behavior #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nthmost-orkes wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −1
Open

docs: clarify OrkesClients OSS compatibility and scan_for_annotated_workers behavior #394

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Create a `quickstart.py` with the following:
```python
from conductor.client.automator.task_handler import TaskHandler
from conductor.client.configuration.configuration import Configuration
from conductor.client.orkes_clients import OrkesClients
from conductor.client.orkes_clients import OrkesClients # works with OSS Conductor and Orkes Conductor
from conductor.client.workflow.conductor_workflow import ConductorWorkflow
from conductor.client.worker.worker_task import worker_task

Expand All @@ -131,6 +131,8 @@ def main():
workflow.register(overwrite=True)

# Start polling for tasks (one worker subprocess per worker function).
# Note: scan_for_annotated_workers=True only discovers @worker_task functions that have
# already been imported. If workers are in a separate module, import it first.
with TaskHandler(configuration=config, scan_for_annotated_workers=True) as task_handler:
task_handler.start_processes()

Expand Down
Loading