python3-nethsec

Python3 library for NethSecurity

Requirements:

• Python3
• pyuci

Usage

The nethsec library is composed by the following sub-packages:

• utils
• firewall

Usage example:

from euci import EUci
from nethsec import firewall

u = EUci()
firewall.add_to_lan(u, 'tunrw')
firewall.add_service(u, 'openvpn_rw', '1194', ['udp', 'tcp'])
firewall.apply(u)

Documentation

Documentation can be generated using pydoctor or pydoc.

Documentation is automatically generated at each new commit on master branch. Online doc is hosted on GitHub pages.

Generate doc using pydoctor:

pip install -U pydoctor
pydoctor  \
  --project-name=python3-nethsec \
  --project-url=https://github.com/nethserver/python3-nethsec \
  --make-html \
  --html-output=./apidocs \
  --project-base-dir="$(pwd)" \
  --docformat=restructuredtext \
  --intersphinx=https://docs.python.org/3/objects.inv \
  ./src/nethsec

Generate doc using pydoc:

cd src
python3 -m pydoc nethsec.firewall
python3 -m pydoc nethsec.utils

Build

Execute:

python3 -m pip install --upgrade build
python3 -m pip install wheel
python3 -m build

Tests

Tests run inside a podman container based on Ubuntu with Python 3.10.

To start the tests, first make sure to have podman installed. Then, from the repository root directory execute:

./test.sh