Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: mark generated python SDK as deprecated #13719

Merged
merged 3 commits into from
Oct 14, 2024
Merged

docs: mark generated python SDK as deprecated #13719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c1dc6b
docs: mark python SDK as deprecated
Joibel Oct 7, 2024
a9ee8b5
docs: code review updates
Joibel Oct 11, 2024
f3da4bb
Update sdks/python/README.md
isubasinghe Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/client-libraries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@ Client libraries often handle common tasks such as authentication for you.
The following client libraries are auto-generated using [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator-cli).
Please expect very minimal support from the Argo team.

| Language | Client Library | Examples/Docs |
|----------|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
| Golang | [`apiclient.go`](https://github.com/argoproj/argo-workflows/blob/main/pkg/apiclient/apiclient.go) | [Example](https://github.com/argoproj/argo-workflows/blob/main/cmd/argo/commands/submit.go) |
| Java | [Java](https://github.com/argoproj/argo-workflows/blob/main/sdks/java) | |
| Python | [Python](https://github.com/argoproj/argo-workflows/blob/main/sdks/python) | |
| Language | Client Library | Examples/Docs |
|----------|---------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| Golang | [`apiclient.go`](https://github.com/argoproj/argo-workflows/blob/main/pkg/apiclient/apiclient.go) | [Example](https://github.com/argoproj/argo-workflows/blob/main/cmd/argo/commands/submit.go) |
| Java | [Java](https://github.com/argoproj/argo-workflows/blob/main/sdks/java) | |
| Python | ⚠️ deprecated [Python](https://github.com/argoproj/argo-workflows/blob/main/sdks/python) | Use one of the [community-maintained](#community-maintained-client-libraries) instead. Will be removed in version 3.7 |

## Community-maintained client libraries

The following client libraries are provided and maintained by their authors, not the Argo team.

| Language | Client Library | Examples/Docs |
|----------|---------------------------------------------------------|--------------------------------------------------------------------------|
| Python | [Couler](https://github.com/couler-proj/couler) | Multi-workflow engine support Python SDK |
| Python | [Hera](https://github.com/argoproj-labs/hera-workflows) | Easy and accessible Argo workflows construction and submission in Python |
| Python | [Couler](https://github.com/couler-proj/couler) | Multi-workflow engine support Python SDK. May be unmaintained. |
4 changes: 4 additions & 0 deletions sdks/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This is the Python SDK for Argo Workflows.

> [!WARNING]
> This SDK is deprecated and will be removed in version 3.7 of Argo Workflows.
> We recommend migrating to [Hera](https://github.com/argoproj-labs/hera).

## Requirements

Python >= 3.6
Expand Down
Loading