Community Maintained Python client for Argo Workflows

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for flaviuvadan from gravatar.com flaviuvadan Avatar for terrytangyuan from gravatar.com terrytangyuan

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

Argo Workflows Python Client

Python client for Argo Workflows

Argo Version: 2.11.8

Installation

pip install argo-workflows

Examples

A quick start example with one of the example workflow

import yaml
import requests
from argo.workflows.client import (ApiClient,
                                   WorkflowServiceApi,
                                   Configuration,
                                   V1alpha1WorkflowCreateRequest)

# assume we ran `kubectl -n argo port-forward deployment/argo-server 2746:2746`

config = Configuration(host="http://localhost:2746")
client = ApiClient(configuration=config)
service = WorkflowServiceApi(api_client=client)
WORKFLOW = 'https://raw.githubusercontent.com/argoproj/argo/v2.11.8/examples/dag-diamond-steps.yaml'

resp = requests.get(WORKFLOW)
manifest: dict = yaml.safe_load(resp.text)

service.create_workflow('argo', V1alpha1WorkflowCreateRequest(workflow=manifest))

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ArchivedWorkflowServiceApi deleteArchivedWorkflow DELETE /api/v1/archived-workflows/{uid}
ArchivedWorkflowServiceApi getArchivedWorkflow GET /api/v1/archived-workflows/{uid}
ArchivedWorkflowServiceApi listArchivedWorkflows GET /api/v1/archived-workflows
ClusterWorkflowTemplateServiceApi createClusterWorkflowTemplate POST /api/v1/cluster-workflow-templates
ClusterWorkflowTemplateServiceApi deleteClusterWorkflowTemplate DELETE /api/v1/cluster-workflow-templates/{name}
ClusterWorkflowTemplateServiceApi getClusterWorkflowTemplate GET /api/v1/cluster-workflow-templates/{name}
ClusterWorkflowTemplateServiceApi lintClusterWorkflowTemplate POST /api/v1/cluster-workflow-templates/lint
ClusterWorkflowTemplateServiceApi listClusterWorkflowTemplates GET /api/v1/cluster-workflow-templates
ClusterWorkflowTemplateServiceApi updateClusterWorkflowTemplate PUT /api/v1/cluster-workflow-templates/{name}
CronWorkflowServiceApi createCronWorkflow POST /api/v1/cron-workflows/{namespace}
CronWorkflowServiceApi deleteCronWorkflow DELETE /api/v1/cron-workflows/{namespace}/{name}
CronWorkflowServiceApi getCronWorkflow GET /api/v1/cron-workflows/{namespace}/{name}
CronWorkflowServiceApi lintCronWorkflow POST /api/v1/cron-workflows/{namespace}/lint
CronWorkflowServiceApi listCronWorkflows GET /api/v1/cron-workflows/{namespace}
CronWorkflowServiceApi updateCronWorkflow PUT /api/v1/cron-workflows/{namespace}/{name}
EventServiceApi receiveEvent POST /api/v1/events/{namespace}/{discriminator}
InfoServiceApi getInfo GET /api/v1/info
InfoServiceApi getUserInfo GET /api/v1/userinfo
InfoServiceApi getVersion GET /api/v1/version
WorkflowServiceApi createWorkflow POST /api/v1/workflows/{namespace}
WorkflowServiceApi deleteWorkflow DELETE /api/v1/workflows/{namespace}/{name}
WorkflowServiceApi getWorkflow GET /api/v1/workflows/{namespace}/{name}
WorkflowServiceApi lintWorkflow POST /api/v1/workflows/{namespace}/lint
WorkflowServiceApi listWorkflows GET /api/v1/workflows/{namespace}
WorkflowServiceApi podLogs GET /api/v1/workflows/{namespace}/{name}/{podName}/log
WorkflowServiceApi resubmitWorkflow PUT /api/v1/workflows/{namespace}/{name}/resubmit
WorkflowServiceApi resumeWorkflow PUT /api/v1/workflows/{namespace}/{name}/resume
WorkflowServiceApi retryWorkflow PUT /api/v1/workflows/{namespace}/{name}/retry
WorkflowServiceApi setWorkflow PUT /api/v1/workflows/{namespace}/{name}/set
WorkflowServiceApi stopWorkflow PUT /api/v1/workflows/{namespace}/{name}/stop
WorkflowServiceApi submitWorkflow POST /api/v1/workflows/{namespace}/submit
WorkflowServiceApi suspendWorkflow PUT /api/v1/workflows/{namespace}/{name}/suspend
WorkflowServiceApi terminateWorkflow PUT /api/v1/workflows/{namespace}/{name}/terminate
WorkflowServiceApi watchEvents GET /api/v1/stream/events/{namespace}
WorkflowServiceApi watchWorkflows GET /api/v1/workflow-events/{namespace}
WorkflowTemplateServiceApi createWorkflowTemplate POST /api/v1/workflow-templates/{namespace}
WorkflowTemplateServiceApi deleteWorkflowTemplate DELETE /api/v1/workflow-templates/{namespace}/{name}
WorkflowTemplateServiceApi getWorkflowTemplate GET /api/v1/workflow-templates/{namespace}/{name}
WorkflowTemplateServiceApi lintWorkflowTemplate POST /api/v1/workflow-templates/{namespace}/lint
WorkflowTemplateServiceApi listWorkflowTemplates GET /api/v1/workflow-templates/{namespace}
WorkflowTemplateServiceApi updateWorkflowTemplate PUT /api/v1/workflow-templates/{namespace}/{name}

Documentation for Models

Code generation

The generated SDK will correspond to the argo version specified in the ARGO_VERSION file.

If you wish to generate code yourself, you can do so by reproducing the build environment (image): make builder_image, then running make builder_make to generate the client.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for flaviuvadan from gravatar.com flaviuvadan Avatar for terrytangyuan from gravatar.com terrytangyuan

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

6.6.0

6.6.0rc4 pre-release

6.6.0rc3 pre-release

6.6.0rc2 pre-release

6.6.0rc1 pre-release

6.5.12

6.5.11

6.5.10

6.5.9

6.5.8

6.5.7

6.5.6

6.5.5

6.5.4

6.5.3

6.5.2

6.5.1

6.5.0

6.5.0rc2 pre-release

6.5.0rc1 pre-release

6.4.17

6.4.16

6.4.15

6.4.14

6.4.13

6.4.12

6.4.11

6.4.10

6.4.9

6.4.8

6.4.7

6.4.6

6.4.5

6.4.4

6.4.3

6.4.2

6.4.1

6.4.0

6.4.0rc4 pre-release

6.4.0rc3 pre-release

6.4.0rc2 pre-release

6.4.0rc1 pre-release

6.3.10

6.3.9

6.3.8

6.3.7

6.3.6

6.3.5

6.3.4

6.3.3

6.3.2

6.3.2rc1 pre-release

6.3.1

6.3.0

6.3.0rc10 pre-release

6.3.0rc9 pre-release

6.3.0rc8 pre-release

6.3.0rc7 pre-release

6.3.0rc6 pre-release

6.3.0rc5 pre-release

6.3.0rc4 pre-release

6.3.0rc3 pre-release

6.3.0rc2 pre-release

5.0.0

4.0.1

This version

4.0.0

3.6.1

3.6.0

3.5.1

3.5.0

3.2.0

3.1.1

3.1.0

3.0.3

3.0.2

3.0.0

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.0

1.3.0

1.2.0

1.1.0

1.0.0

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-4.0.0.tar.gz (279.6 kB view details)

Uploaded Source

Built Distribution

argo_workflows-4.0.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: argo-workflows-4.0.0.tar.gz
  • Upload date:
  • Size: 279.6 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

Hashes for argo-workflows-4.0.0.tar.gz
Algorithm Hash digest
SHA256 eac456d030d1830fc0d87ba58afe23902a64a80aa46ca232fabcc54253a82092
MD5 b072491ede4b998aee17f0cbbf6c939c
BLAKE2b-256 6fe5a908cda5b30cca084eab905c6d5bf6fde478538d6215a73944cd2c9be169

See more details on using hashes here.

File details

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

File metadata

  • Download URL: argo_workflows-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.9 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

Hashes for argo_workflows-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba174344dc205063d1253669ab45cf13b3cb9bec64619de2c511a9f9dc4386df
MD5 7f77b92771f22b3a8c6613fcd73c16c5
BLAKE2b-256 d0f96661408cae70dcb469097f99b25a7e5ff213187e23bcf6faf1da84dd981b

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