Skip to content


Pull requests are welcomed and automatically built and tested against multiple versions of Python through GitHub Actions.

Except for unit tests, testing is only supported on Python 3.9.

The project is packaged with a light development environment based on Docker to help with the local development of the project and to run tests within GitHub Actions.

The project is following Network to Code software development guidelines and are leveraging the following:

  • Black, Pylint, Bandit, Mypy, flake8, and pydocstyle for Python linting and formatting.
  • pytest, coverage, and unittest for unit tests.

There are a number of things that are required in order to have a successful PR.

  • All new functions must contain at least 1 example in their docstrings.
  • Docstrings must conform to the google docstring convention.
  • Unit test for newly added functions are required.
  • If applicable, tests related to config parsing and compliance must be added.
  • Update the jinja2 filter (netutils.utils.jinja2_convenience_function) for any new functions (see below for details).
  • If you create a new file in the netutils folder, you must add a new file for including Python and update mkdocs.yml to include the addition (see below for details).
  • Your PR must not introduce any required dependencies. You can introduce optional or development dependencies.

Documentation is built using mkdocs. The Docker based development environment can be started by running invoke docs http://localhost:8001 that auto-refreshes when you make any changes to your local files.

Adding docs for a new python file

If adding a new python file, the docs must be updated to account for the new file.

  1. Create a new markdown file in docs/dev/code_reference matching the name of your new file such as
  2. Apply the following pattern to the newly created file.
  3. Update the mydocs.yml to point to the new file

::: netutils.dns
        show_submodules: True

Update the mkdocs as appropriate, as shown in this truncated example of adding DNS.

  - Developer Guide:
      - Extending the Library: "dev/"
      - Contributing to the Library: "dev/"
      - Development Environment: "dev/"
      - Development Config: "dev/"
      - Code Attribution to the Library: "dev/"
      - Code Reference:
          - "dev/code_reference/"
          - ASN: "dev/code_reference/"
          - Bandwidth: "dev/code_reference/"
          - Banner: "dev/code_reference/"
          - Configs: "dev/code_reference/"
          - DNS: "dev/code_reference/" <<-- Added

Adding Lib Mapper, jinja2 filter, or Config Parser

When adding to any of these features, you must run the development_scripts from the root directory. This process requires having Jinja2 on the machine that will run the process. This is automatically tested via pytest.

Adding to the jinja2 filter function

To add a new function to the jinja2 filter, add a new entry to the _JINJA2_FUNCTION_MAPPINGS located in the file. When adding an entry, the key corresponds with the name to call the function and the value to the path to find the function.

Branching Policy

The branching policy includes the following tenets:

  • The develop branch is the primary branch to develop off of.
  • If there is a reason to have a patch version, the maintainers may use cherry-picking strategy.
  • PRs intended to add new features should be sourced from the develop branch.
  • PRs intended to address bug fixes and security patches should be sourced from the develop branch.
  • PRs intended to add new features that break backward compatibility should be discussed before a PR is created.

Netutils will observe semantic versioning, as of 1.0. This may result in an quick turn around in minor versions to keep pace with an ever growing feature set.

Release Policy

Netutils has currently no intended scheduled release schedule, and will release new features in minor versions.

When a new release is created the following should happen.

  • A release PR is created with:
    • Update to the changelog in docs/admin/release_notes/version_<major>.<minor>.md file to reflect the changes.
    • Change the version from <major>.<minor>.<patch>-beta to <major>.<minor>.<patch> in pyproject.toml.
    • Set the PR to the main
  • Ensure the tests for the PR pass.
  • Merge the PR.
  • Create a new tag:
    • The tag should be in the form of v<major>.<minor>.<patch>.
    • The title should be in the form of v<major>.<minor>.<patch>.
    • The description should be the changes that were added to the version_<major>.<minor>.md document.
  • If merged into main, then push from main to develop, in order to retain the merge commit created when the PR was merged
  • A post release PR is created with.
    • Change the version from <major>.<minor>.<patch> to <major>.<minor>.<patch + 1>-beta pyproject.toml.
    • Set the PR to the develop.
    • Once tests pass, merge.