Community Maintained Python client for Argo Workflows
Project description
Argo Workflows Python Client
Python client for Argo Workflows
Installation
pip install argo-workflows
Usage
If you're familiar with Kubernetes client, the Argo client follows the same behaviour.
from argo.workflows.client import V1alpha1Api
from argo.workflows.config import load_kube_config
load_kube_config() # loads local configuration from ~/.kube/config
And to list Workflows from a namespace (say argo):
v1alpha1 = V1alpha1Api()
wfs = v1alpha1.list_namespaced_workflows(namespace="argo")
To submit a Workflow, one would simply load it from a YAML* and submit it as such:
import requests
import yaml
namespace = "argo"
# hello-world example
resp = requests.get("https://raw.githubusercontent.com/argoproj/argo/master/examples/hello-world.yaml")
resp.raise_for_status()
manifest: dict = yaml.safe_load(resp.text)
# Submit the Workflow to the `argo` namespace
v1alpha1.create_namespaced_workflow(namespace, manifest)
When working on a higher level of abstraction, check out the following projects:
- Couler that provides a simplified and unified interface for constructing and managing workflows
- Argo Python DSL
Versioning
The client is generated from the Argo and Kubernetes OpenAPI specification.
We follow semantic versioning, the client starts at version 1.0 which matches Argo release 2.3.0 and continues onwards.
Compatibility matrix
| Argo 2.3 | Argo 2.4 | Argo 2.5 | |
|---|---|---|---|
| client-python 1.0 | ✓ | - | - |
| client-python 2.0 | + | ✓ | - |
| client-python 3.0 | + | + | ✓ |
Key:
✓Exactly the same features / API objects in both client-python and the Kubernetes version.+client-python has features or api objects that may not be present in the Kubernetes cluster, but everything they have in common will work.-The Kubernetes cluster has features the client-python library can't use (additional API objects, etc).
We try to be consistent with Argo as much as possible and hence we created special branches for user convenience --- for example argo/v2.4.0 is identical with Argo release v2.4.0.
These can be then installed directly from github:
pip install -e "git+git://github.com/CermakM/argo-client-python@argo/v2.4.0#egg=argo-workflows"
:warning: The compatibility for such cases is not guaranteed
Code generation
If you wish to generate code yourself, you can do so by running make generate with the ARGO_VERSION environment variable being set to the you want to generate the client for.
Before
in the Makefile:
- make sure to select a compatible
KUBERNETES_BRANCHaccording to Argo's Gopkg.toml - make sure to select a compatible version of kubernetes-client
- update requirements.txt and Pipfile
For additional configuration check out the Makefile.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file argo-workflows-3.5.0.tar.gz.
File metadata
- Download URL: argo-workflows-3.5.0.tar.gz
- Upload date:
- Size: 226.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.6.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 598641b20ed6b522d39a914e7df491ce850bae31709eeddaf6b12045171c748b |
|
| MD5 | 46e37fc65493039680459ffa5f6f865e |
|
| BLAKE2b-256 | 44f6db2a6b8750503b390b53cdc323e4b5ef0540dbf028f44de307d7d4d3f18f |
File details
Details for the file argo_workflows-3.5.0-py3-none-any.whl.
File metadata
- Download URL: argo_workflows-3.5.0-py3-none-any.whl
- Upload date:
- Size: 379.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.6.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3832b9912410db92986665b893ddc1bd10ea06eff80fd20df2361e8917fa9885 |
|
| MD5 | f8869cc5eb8bb1675cea79b072338daf |
|
| BLAKE2b-256 | 8380f2e43b49cb0d373b4d44cbf8874ece164e245ad6703f7e92113a594c40b0 |
