Skip to content

Commit 53d1695

Browse files
committed
docs: clarify OrkesClients OSS compatibility and scan_for_annotated_workers import requirement (conductor-oss/getting-started#43, #45)
1 parent a751eba commit 53d1695

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Create a `quickstart.py` with the following:
105105
```python
106106
from conductor.client.automator.task_handler import TaskHandler
107107
from conductor.client.configuration.configuration import Configuration
108-
from conductor.client.orkes_clients import OrkesClients
108+
from conductor.client.orkes_clients import OrkesClients # works with OSS Conductor and Orkes Conductor
109109
from conductor.client.workflow.conductor_workflow import ConductorWorkflow
110110
from conductor.client.worker.worker_task import worker_task
111111

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

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

0 commit comments

Comments
 (0)