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.

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

docs: mark generated python SDK as deprecated #13719

Merged
merged 3 commits into from
Oct 14, 2024

Conversation

Joibel
Copy link
Member

@Joibel Joibel commented Oct 7, 2024

Fixes #13703

Motivation

The Python SDK is auto-generated, and the maintainers of argo-workflows do not wish to invest their limited time improving this situation. There are already two good alternatives for using python to create workflows

This will allow us to close

and probably others

Modifications

The main change is to mark the SDK as deprecated in client-libraries.md, and give a planned removal in 3.7.

There should be a follow up once release/3.6 is branched to actually remove the generation of the code.

Verification

make docs passes

@Joibel Joibel added area/sdks area/docs Incorrect, missing, or mistakes in docs labels Oct 7, 2024
@Joibel Joibel marked this pull request as ready for review October 7, 2024 10:06
@Joibel Joibel added this to the v3.6.0 milestone Oct 7, 2024
Copy link
Member

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sdks/python/README.md should also be updated

There are already two good alternatives for using python to create workflows

Couler does not seem to be actively maintained, but yes Hera ofc is

and probably others

yea there's a small mountain of bugs with the SDKs; some of which are resolved in updating the OpenAPI generator, which is itself a breaking change 🙃

README.md Outdated Show resolved Hide resolved
@agilgur5 agilgur5 changed the title docs: mark python SDK as deprecated docs: mark generated python SDK as deprecated Oct 7, 2024
Signed-off-by: Alan Clucas <alan@clucas.org>
Signed-off-by: Alan Clucas <alan@clucas.org>
@Joibel
Copy link
Member Author

Joibel commented Oct 11, 2024

sdks/python/README.md should also be updated

Eugh, I don't know how I missed this one. Thanks.

There are already two good alternatives for using python to create workflows

Couler does not seem to be actively maintained, but yes Hera ofc is

I've reordered the list and pushed for hera being the suggestion a bit more heavily.

@Joibel Joibel requested a review from agilgur5 October 11, 2024 10:53
sdks/python/README.md Outdated Show resolved Hide resolved
Co-authored-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
Signed-off-by: Isitha Subasinghe <isitha@pipekit.io>
Copy link
Member

@isubasinghe isubasinghe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since Isitha applied my suggestion above, this LGTM now

@agilgur5 agilgur5 enabled auto-merge (squash) October 14, 2024 22:49
@agilgur5 agilgur5 merged commit 405e97a into argoproj:main Oct 14, 2024
28 checks passed
@Joibel Joibel deleted the python-sdk-deprecate branch October 15, 2024 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs area/sdks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate or remove auto-generated Python sdk
3 participants