Metadata-Version: 2.1
Name: nwa-stdlib
Version: 1.6.0
Summary: The NWA-stdlib module.
Home-page: https://github.com/workfloworchestrator/nwa-stdlib
Author: SURF
Author-email: automation-beheer@surf.nl
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: anyio>=3.7.0
Requires-Dist: colorama~=0.4.3
Requires-Dist: pydantic>=2.4.0
Requires-Dist: pydantic_settings
Requires-Dist: strawberry-graphql
Requires-Dist: redis>=4.6, <4.7.0
Requires-Dist: structlog~=22.1.0
Requires-Dist: bumpversion ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: types-redis ; extra == "dev"
Requires-Dist: anyio ; extra == "test"
Requires-Dist: black ; extra == "test"
Requires-Dist: fakeredis ; extra == "test"
Requires-Dist: fastapi ; extra == "test"
Requires-Dist: httpx ; extra == "test"
Requires-Dist: mypy==1.6.1 ; extra == "test"
Requires-Dist: mypy_extensions ; extra == "test"
Requires-Dist: pytest ; extra == "test"
Requires-Dist: pytest-asyncio ; extra == "test"
Requires-Dist: redis ; extra == "test"
Requires-Dist: ruff ; extra == "test"
Project-URL: Documentation, https://workfloworchestrator.org/
Provides-Extra: dev
Provides-Extra: test

# Network Automation Standard Library

[![pypi_version](https://img.shields.io/pypi/v/nwa-stdlib?color=%2334D058&label=pypi%20package)](https://pypi.org/project/nwa-stdlib)
[![Supported python versions](https://img.shields.io/pypi/pyversions/nwa-stdlib.svg?color=%2334D058)](https://pypi.org/project/nwa-stdlib)

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

## Getting started

If you want to use a virtual environment first create the environment:

```bash
pip install flit
```
And then run the following commands:

If you want to enhance or develop bug fixes for `nwastdlib` it's easiest to run the following commands:
```bash
flit install --deps develop --symlink
```

## Development
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
```bash
bumpversion patch
```

## To run tests
```
pytest
```

## Supported Python versions

nwa-stdlib must support the same python versions as [orchestrator-core](https://github.com/workfloworchestrator/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

