The `argo-workflows` Python client provides programmatic access to the Argo Workflows API, enabling users to create, manage, and monitor workflows and other resources. It is an OpenAPI-generated client, meaning its version (currently 6.6.19) is closely tied to the Argo Workflows server's API specification. The library is actively maintained, with frequent updates to keep pace with new server features and API changes.
pip install argo-workflowsVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to configure the `argo-workflows` client for authentication (using a bearer token from an environment variable), instantiate the `WorkflowServiceApi`, and list workflows in a specified namespace. Ensure `ARGO_WORKFLOWS_HOST` and `ARGO_WORKFLOWS_TOKEN` (if using auth) are set.
Always use a client version that is recent and intended for your Argo Workflows server version. Consult the official Argo Workflows GitHub for recommendations or regenerate the client if you are tracking custom API changes.
Verify `ARGO_WORKFLOWS_HOST` (e.g., `http://localhost:2746` or `https://argo.example.com`). Ensure `ARGO_WORKFLOWS_TOKEN` (for bearer token auth) or other credentials are correct. For SSL issues, either configure `verify_ssl=True` with `ssl_ca_cert` pointing to your CA certificate or, for development, set `verify_ssl=False` (not recommended for production).
Refer to the Argo Workflows API documentation for the exact schema of workflow objects. Check error messages carefully for missing fields. For advanced use cases or custom resource definitions, consider setting `client_side_validation=False` on the Configuration object if you understand the implications.
Check that the `ARGO_WORKFLOWS_TOKEN` environment variable is set and contains a valid bearer token for the Argo Workflows API. Ensure the token has the necessary permissions. If using other authentication methods, verify those credentials.
Set `verify_ssl=True` in your `Configuration` and provide the path to your CA certificate via `ssl_ca_cert`. Alternatively, if you understand the security risks and for development purposes, set `verify_ssl=False`.
Verify that your `argo-workflows` client version is compatible with your Argo Workflows server version. Update or downgrade the client as necessary. Double-check the attribute name against the official Argo Workflows API documentation.
Ensure all required nested objects (e.g., `metadata`, `spec`, `templates`) are properly initialized when constructing workflow requests. For API responses, add checks for `None` before accessing attributes or dict keys.
No dependency data recorded yet.