nwa-stdlib 1.11.2

The NWA-stdlib module.

Network Automation Standard Library

This library contains the functions and utilities that are shared by most Network Automation projects built at SURF.

Installation

To install the package from PyPI:

pip install nwa-stdlib

Development

Virtual Environment

Steps to setup a virtual environment.

Step 1:

Create and activate a python3 virtualenv.

Step 2:

Install flit to enable you to develop on this repository:

pip install flit

Step 3:

To install all development dependencies:

flit install --deps develop

All steps combined into 1 command:

python -m venv .venv && source .venv/bin/activate && pip install -U pip && pip install flit && flit install --deps develop

Unit tests

Activate the virtualenv and run the unit tests with:

pytest

Pre-commit

This project uses pre-commit to automatically run a number of checks before making a git commit. The same checks will be performed in the CI pipeline so this can save you some time.

First ensure you have pre-commit installed. It is recommended to install it outside the virtualenv. On Linux and Mac, pre-commit is available in most package managers. Alternatively you can install it globally with pipx.

Once pre-commit is installed, go into the project root and enable it:

pre-commit install

This should output pre-commit installed at .git/hooks/pre-commit. The next time you run git commit the pre-commit hooks will validate your changes.

Bump version

Depending on the feature type, run bumpversion (patch|minor|major) to increment the version you are working on. For example to update the increment the patch version use

bumpversion patch

Supported Python versions

nwa-stdlib must support the same python versions as orchestrator-core.

Exceptions to this rule are:

• A new python version is released: nwa-stdlib should support the new version before orchestrator-core does
• Support for an old python version is dropped: nwa-stdlib should drop the python version after orchestrator-core does