Skip to main content

Client for Argo Workflows

Project description

Argo Workflows 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")

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
client-python 1.0 -
client-python 2.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:

For additional configuration check out the Makefile.

Project details


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

argo-workflows-2.1.4.tar.gz (87.1 kB view details)

Uploaded Source

Built Distribution

argo_workflows-2.1.4-py3-none-any.whl (114.3 kB view details)

Uploaded Python 3

File details

Details for the file argo-workflows-2.1.4.tar.gz.

File metadata

  • Download URL: argo-workflows-2.1.4.tar.gz
  • Upload date:
  • Size: 87.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for argo-workflows-2.1.4.tar.gz
Algorithm Hash digest
SHA256 00a0c0e14ecccd9694b14cce9895e83a161929818ccf2c4c6d1e3681762d9539
MD5 14a1fa014de7d99cb28455feeb3f0ced
BLAKE2b-256 206928fc5094ff6aacee346f8799dc9dff2d0d7d14447c92ad5c369d025f6526

See more details on using hashes here.

File details

Details for the file argo_workflows-2.1.4-py3-none-any.whl.

File metadata

  • Download URL: argo_workflows-2.1.4-py3-none-any.whl
  • Upload date:
  • Size: 114.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for argo_workflows-2.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1d36d0e56c472c9af98cdfc21a0a9d3087227ee8d118310f2ac6649df124c5d5
MD5 f9865850ed513071a3efe100658699eb
BLAKE2b-256 283acc0cf40062f5f52c67e0870b56a2c12888023bcc48f0796531535702a9e6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page