The conductor-python
repository provides the client SDKs to build task workers in Python.
Building the task workers in Python mainly consists of the following steps:
- Setup conductor-python package
- Create and run task workers
- Create workflows using code
- Create a virtual environment to build your package
virtualenv conductor
source conductor/bin/activate
- Get Conductor Python SDK
python3 -m pip install conductor-python
Everything related to server settings should be done within the Configuration
class by setting the required parameter (when initializing an object) like this:
configuration = Configuration(
server_api_url='https://play.orkes.io/api',
debug=True
)
- server_api_url : Conductor server address. For example, if you are running locally, it would look like;
http://localhost:8000/api
. - debug: It can take the values true/false.
true
for verbose loggingfalse
to display only the errors
Configure the authentication settings if your Conductor server requires authentication.
See Access Control for more details on role-based access control with Conductor and generating API keys for your environment.
configuration = Configuration(
authentication_settings=AuthenticationSettings(
key_id='key',
key_secret='secret'
)
)
Conductor uses Prometheus to collect metrics.
metrics_settings = MetricsSettings(
directory='/path/to/folder',
file_name='metrics_file_name.extension',
update_interval=0.1,
)
directory
: Directory to store the metrics.- Ensure that you have already created this folder, or the program should have permission to create it for you.
file_name
: File where the metrics are stored.- example:
metrics.log
- example:
update_interval
: Time interval in seconds to refresh metrics into the file.- example:
0.1
means metrics are updated every 0.1s or 100ms.
- example:
The next step is to create and run task workers.
Finally, you can create workflows using code.