diff options
Diffstat (limited to 'docs/README.md')
| -rwxr-xr-x | docs/README.md | 32 |
1 files changed, 27 insertions, 5 deletions
diff --git a/docs/README.md b/docs/README.md index 1fe8734..378867f 100755 --- a/docs/README.md +++ b/docs/README.md @@ -19,14 +19,31 @@ ANTA is Python framework that automates tests for Arista devices. - Automate NRFU (Network Ready For Use) test on a preproduction network - Automate tests on a live network (periodically or on demand) - ANTA can be used with: - - The [ANTA CLI](cli/overview.md) - As a [Python library](advanced_usages/as-python-lib.md) in your own application + - The [ANTA CLI](cli/overview.md)  +## Install ANTA library + +The library will **NOT** install the necessary dependencies for the CLI. + +```bash +# Install ANTA as a library +pip install anta +``` + +## Install ANTA CLI + +If you plan to use ANTA only as a CLI tool you can use `pipx` to install it. +[`pipx`](https://pipx.pypa.io/stable/) is a tool to install and run python applications in isolated environments. Refer to `pipx` instructions to install on your system. +`pipx` installs ANTA in an isolated python environment and makes it available globally. + +**This is not recommended if you plan to contribute to ANTA** + ```bash -# Install ANTA CLI -$ pip install anta +# Install ANTA CLI with pipx +$ pipx install anta[cli] # Run ANTA CLI $ anta --help @@ -52,8 +69,11 @@ Commands: nrfu Run ANTA tests on devices ``` -> [!WARNING] -> The ANTA CLI options have changed after version 0.11 and have moved away from the top level `anta` and are now required at their respective commands (e.g. `anta nrfu`). This breaking change occurs after users feedback on making the CLI more intuitive. This change should not affect user experience when using environment variables. +You can also still choose to install it with directly with `pip`: + +```bash +$ pip install anta[cli] +``` ## Documentation @@ -65,4 +85,6 @@ Contributions are welcome. Please refer to the [contribution guide](contribution ## Credits +Thank you to [Jeremy Schulman](https://github.com/jeremyschulman) for [aio-eapi](https://github.com/jeremyschulman/aio-eapi/tree/main/aioeapi). + Thank you to [Angélique Phillipps](https://github.com/aphillipps), [Colin MacGiollaEáin](https://github.com/colinmacgiolla), [Khelil Sator](https://github.com/ksator), [Matthieu Tache](https://github.com/mtache), [Onur Gashi](https://github.com/onurgashi), [Paul Lavelle](https://github.com/paullavelle), [Guillaume Mulocher](https://github.com/gmuloc) and [Thomas Grimonet](https://github.com/titom73) for their contributions and guidances. |