search

argoproj / argo-workflows

Workflow Engine for Kubernetes
https://argo-workflows.readthedocs.io/
Apache License 2.0
14.87k stars 3.17k forks source link

Documentation for the Python SDK #9016

Open samunaai opened 2 years ago

samunaai commented 2 years ago

Summary

👋🏾👋🏾 Hello! We are working on a serious project with Argo Python SDK and hoped to inquire about the documentation to better understanding how we can correctly use the API.

Use Cases

For now, it appears that most of the documentation for the Argo Python SDK centers on the hello world example [in the README].

However, we are also looking for if there are any additional documentation we can use for this. We are specifically interested in how to use a mounted volume, how to pass artifacts, and, most importantly, how to trigger memoization using the Python SDK.

As per the screenshot below, we are asked to visit [this link] for additional examples. However, the link currently contains a unit test corresponding to the "hello world" example which is present in the read me.

We also had a look at the [API reference], but it mostly contains details of how to use the various classes which have been implemented using the API.

Would the argo workflows team kindly have any examples that may have been used in unit testing for some other parts of API reference? Or just any documentation links that may be on another website, which would be helpful for us?

Warm regards,

stack

Message from the maintainers:

Love this enhancement proposal? Give it a 👍. We prioritise the proposals with the most 👍.

terrytangyuan commented 2 years ago

Yes I agree that we lack of examples currently. Feel free to help convert existing YAML examples to Python.

samunaai commented 2 years ago

Thank you very much @terrytangyuan . If I may ask, is there an easy way to know how to convert the YAML to Python? Right now I am not perfectly sure how to correctly use the Python Classes which have been provided. Do you have any recommendations as I work this out?🙏🏿🙏🏿

caelan-io commented 2 years ago

Sidenote: There are a couple other Python SDK options that may have more documentation/ active users & maintainers for your needs:

  1. Hera
  2. Couler
samunaai commented 2 years ago

Indeed! Thank you @caelan-io I used both these APIs as well, and they were great, but were a bit slower to catch up to newer Argo features. The API reference for the Python SDK was quite comprehensive

flaviuvadan commented 1 year ago

@munachisonwadike Hera v5 offers a fully featured Argo Workflows + Events SDK now!