encommon 0.3.0

Enasis Network Common Library

Enasis Network Common Library

Common classes and functions used in various public and private projects for Enasis Network.

Installing the package

Installing stable from the PyPi repository

pip install encommon

Installing latest from GitHub repository

pip install git+https://github.com/enasisnetwork/encommon

Documentation

Documentation is on Read the Docs. Should you venture into the sections below you will be able to use the sphinx recipe to build documention in the docs/html directory.

Quick start for local development

Start by cloning the repository to your local machine.

git clone https://github.com/enasisnetwork/encommon.git

Set up the Python virtual environments expected by the Makefile.

make -s venv-create

Execute the linters and tests

The comprehensive approach is to use the check recipe. This will stop on any failure that is encountered.

make -s check

However you can run the linters in a non-blocking mode.

make -s linters-pass

And finally run the various tests to validate the code and produce coverage information found in the htmlcov folder in the root of the project.

make -s pytest

Future features and subpackages

netdom subpackage

This package will include class objects for handling network addresses and other functions to assist with validating and normalizing domain names.

formats subpackage

This package will include class objects to help with dealing with verious formats of data. These formats will include Jinja2, CSV, and HTML.