Skip to content

Commit

Permalink
add YAML optional dep doc (#623)
Browse files Browse the repository at this point in the history
<!-- Thank you for submitting a PR to Hera! 🚀 -->

**Pull Request Checklist**
- [ ] Fixes #<!--issue number goes here-->
- [ ] Tests added
- [ ] Documentation/examples added
- [ ] [Good commit messages](https://cbea.ms/git-commit/) and/or PR
title
<!-- Also remember to sign off commits or the DCO check will fail on
your PR! -->

**Description of PR**
<!-- If not linked to an issue, please describe your changes here -->

Currently, the optional YAML dep is not captured by docs

<!-- Piece of cake! ✨🍰✨ -->

Signed-off-by: Flaviu Vadan <flaviuvadan@gmail.com>
  • Loading branch information
flaviuvadan committed May 9, 2023
1 parent b439863 commit f63afb7
Showing 1 changed file with 10 additions and 0 deletions.
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

0 comments on commit f63afb7

Please sign in to comment.