Skip to content

duduz/argo-client-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
Marek Cermak
Oct 30, 2019
c35973a Β· Oct 30, 2019

History

62 Commits
Sep 16, 2019
Oct 30, 2019
Oct 30, 2019
Oct 30, 2019
Oct 22, 2019
Oct 25, 2019
Sep 16, 2019
Sep 16, 2019
Oct 30, 2019
Sep 7, 2019
Oct 22, 2019
Oct 30, 2019
Oct 30, 2019
Oct 25, 2019
Oct 30, 2019
Oct 17, 2019

Repository files navigation

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"

⚠️ 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.

About

Python client for Argo Workflows

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.4%
  • Other 0.6%