Skip to content

Commit

Permalink
bump: Prepare 0.6.0 (#254)
Browse files Browse the repository at this point in the history
* Bump: Version 0.6.0 and fix dependencies

* CI: Fix reqs in pre-commit
  • Loading branch information
gmuloc authored Jul 7, 2023
1 parent 6928d26 commit 0e9b74e
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 41 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.5.0
current_version = 0.6.0
commit = True
tag = True
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?
Expand Down
13 changes: 6 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,14 @@ repos:
- "aio-eapi==0.3.0"
- "click==8.1.3"
- "click-help-colors==0.9.1"
- "cvprac>=1.2.0"
- "netaddr>=0.8.0"
- "cvprac~=1.3"
- "netaddr==0.8.0"
- "pydantic~=2.0"
- "PyYAML>=6.0"
- "requests"
- "rich>=12.5.1"
- "scp"
- "PyYAML==6.0"
- "requests>=2.27"
- "rich~=13.4"
- "asyncssh==2.13.1"
- "Jinja2>=3.1.2"
- "Jinja2==3.1.2"
- types-PyYAML
- types-paramiko
- types-requests
Expand Down
39 changes: 27 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Arista Network Test Automation (ANTA) Framework

__WARNING:__ A work is in progress to make test definition easier and more scalable starting with PR#173. As it is a breaking change, it is highly recommended to use version published on Pypi until we complete the work.
__WARNING:__ Documentation is work in progress for version 0.6.0 available in Pypi.

This repository is a Python package to automate tests on Arista devices.

Expand All @@ -24,21 +24,36 @@ $ pip install anta
$ anta
Usage: anta [OPTIONS] COMMAND [ARGS]...

Arista Network Test CLI
Arista Network Test Automation (ANTA) CLI

Options:
--username TEXT Username to connect to EOS [env var: ANTA_USERNAME]
--password TEXT Password to connect to EOS [env var: ANTA_PASSWORD]
--timeout INTEGER Connection timeout (default 5) [env var: ANTA_TIMEOUT]
--enable-password TEXT Enable password if required to connect [env var: ANTA_ENABLE_PASSWORD]
-i, --inventory PATH Path to your inventory file [env var: ANTA_INVENTORY]
--timeout INTEGER Connection timeout (default 5) [env var: ANTA_TIMEOUT]
--help Show this message and exit.
--version Show the version and exit.
--username TEXT Username to connect to EOS [env var:
ANTA_USERNAME; required]
--password TEXT Password to connect to EOS [env var:
ANTA_PASSWORD; required]
--timeout INTEGER Global connection timeout [env var:
ANTA_TIMEOUT; default: 5]
--insecure Disable SSH Host Key validation [env var:
ANTA_INSECURE]
--enable-password TEXT Enable password if required to connect [env
var: ANTA_ENABLE_PASSWORD]
-i, --inventory FILE Path to the inventory YAML file [env var:
ANTA_INVENTORY; required]
--log-level, --log [CRITICAL|ERROR|WARNING|INFO|DEBUG]
ANTA logging level [env var:
ANTA_LOG_LEVEL; default: INFO]
--ignore-status Always exit with success [env var:
ANTA_IGNORE_STATUS]
--ignore-error Only report failures and not errors [env
var: ANTA_IGNORE_ERROR]
--help Show this message and exit.

Commands:
exec Execute commands to inventory devices
get Get data from/to ANTA
nrfu Run NRFU against inventory devices
debug Debug commands for building ANTA
exec Execute commands to inventory devices
get Get data from/to ANTA
nrfu Run NRFU against inventory devices
```
<img src="https://github.com/arista-netdevops-community/anta/raw/master/docs/imgs/anta-nrfu-table-group-by-test-output.png"></img>
Expand Down
37 changes: 26 additions & 11 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,34 @@ pip install anta
$ anta
Usage: anta [OPTIONS] COMMAND [ARGS]...

Arista Network Test CLI
Arista Network Test Automation (ANTA) CLI

Options:
--username TEXT Username to connect to EOS [env var: ANTA_USERNAME]
--password TEXT Password to connect to EOS [env var: ANTA_PASSWORD]
--timeout INTEGER Connection timeout (default 5) [env var: ANTA_TIMEOUT]
--enable-password TEXT Enable password if required to connect [env var: ANTA_ENABLE_PASSWORD]
-i, --inventory PATH Path to your inventory file [env var: ANTA_INVENTORY]
--timeout INTEGER Connection timeout (default 5) [env var: ANTA_TIMEOUT]
--help Show this message and exit.
--version Show the version and exit.
--username TEXT Username to connect to EOS [env var:
ANTA_USERNAME; required]
--password TEXT Password to connect to EOS [env var:
ANTA_PASSWORD; required]
--timeout INTEGER Global connection timeout [env var:
ANTA_TIMEOUT; default: 5]
--insecure Disable SSH Host Key validation [env var:
ANTA_INSECURE]
--enable-password TEXT Enable password if required to connect [env
var: ANTA_ENABLE_PASSWORD]
-i, --inventory FILE Path to the inventory YAML file [env var:
ANTA_INVENTORY; required]
--log-level, --log [CRITICAL|ERROR|WARNING|INFO|DEBUG]
ANTA logging level [env var:
ANTA_LOG_LEVEL; default: INFO]
--ignore-status Always exit with success [env var:
ANTA_IGNORE_STATUS]
--ignore-error Only report failures and not errors [env
var: ANTA_IGNORE_ERROR]
--help Show this message and exit.

Commands:
exec Execute commands to inventory devices
get Get data from/to ANTA
nrfu Run NRFU against inventory devices
debug Debug commands for building ANTA
exec Execute commands to inventory devices
get Get data from/to ANTA
nrfu Run NRFU against inventory devices
```
2 changes: 1 addition & 1 deletion docs/contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ $ pip list

# Check version using cli
$ anta --version
anta, version 0.5.0
anta, version 0.6.0
```

### Install development requirements
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements-and-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ which anta

# Chck ANTA version
anta --version
anta, version 0.5.0
anta, version 0.6.0
```

## EOS Requirements
Expand Down
15 changes: 7 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "anta"
version = "v0.5.0"
version = "v0.6.0"
readme = "README.md"
authors = [{ name = "Khelil Sator", email = "[email protected]" }]
maintainers = [
Expand All @@ -20,15 +20,14 @@ dependencies = [
"aio-eapi==0.3.0",
"click==8.1.3",
"click-help-colors==0.9.1",
"cvprac>=1.2.0",
"netaddr>=0.8.0",
"cvprac~=1.3",
"netaddr==0.8.0",
"pydantic~=2.0",
"PyYAML>=6.0",
"requests",
"rich>=12.5.1",
"scp",
"PyYAML==6.0",
"requests>=2.27",
"rich~=13.4",
"asyncssh==2.13.1",
"Jinja2>=3.1.2",
"Jinja2==3.1.2",
]
keywords = ["test", "anta", "Arista", "network", "automation", "networking", "devops", "netdevops"]
classifiers = [
Expand Down

0 comments on commit 0e9b74e

Please sign in to comment.