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

add YAML optional dep doc #623

Merged
merged 2 commits into from
May 9, 2023
Merged
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@ and its crew were specially protected by the goddess Hera.
[![Versions](https://img.shields.io/pypi/pyversions/hera.svg)](https://github.com/argoproj-labs/hera)

### Stats after the [rename to Hera](https://github.com/argoproj-labs/hera/discussions/532)

[![Downloads](https://pepy.tech/badge/hera)](https://pepy.tech/project/hera)
[![Downloads/month](https://pepy.tech/badge/hera/month)](https://pepy.tech/project/hera)
[![Downloads/week](https://pepy.tech/badge/hera/week)](https://pepy.tech/project/hera)

### Stats before the [rename to Hera](https://github.com/argoproj-labs/hera/discussions/532)

[![Downloads](https://pepy.tech/badge/hera-workflows)](https://pepy.tech/project/hera-workflows)
[![Downloads/month](https://pepy.tech/badge/hera-workflows/month)](https://pepy.tech/project/hera-workflows)
[![Downloads/week](https://pepy.tech/badge/hera-workflows/week)](https://pepy.tech/project/hera-workflows)
Expand Down Expand Up @@ -76,6 +78,14 @@ publishes releases to both `hera` and `hera-workflows` for backwards compatibili
| [Conda](https://anaconda.org/conda-forge/hera-workflows) | `conda install -c conda-forge hera-workflows` |
| [GitHub repo](https://github.com/argoproj-labs/hera) | `python -m pip install git+https://github.com/argoproj-labs/hera --ignore-installed`/`pip install .` |

## Optional dependencies

### yaml

- Install via `hera[yaml]`
- [PyYAML](https://pypi.org/project/PyYAML/) is required for the `yaml` output format, which is accessible via
`hera.workflows.Workflow.to_yaml(*args, **kwargs)`. This enables GitOps practices and easier debugging

# Examples

### Single step script
Expand Down