Enasis Network Project Basics

This project has not released its first major version.

Support functions useful in a wide variety of development projects.

Documentation

Read project documentation built using the Sphinx project. Should you venture into the sections below you will be able to use the sphinx recipe to build documention in the sphinx/html directory.

Installing the package

Installing stable from the PyPi repository

pip install enbasics

Installing latest from GitHub repository

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

Additional package dependencies

• enbasics[badges] for constructing project badges.

Constructing project badges

python -m enbasics.execution.badges \
  --output "path/to/badge.png" \
  --label "Badge" \
  --value "failure"

See this project's document.yml for ideas!

Quick start for local development

Start by cloning the repository to your local machine.

git clone https://github.com/enasisnetwork/enbasics.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

Version management

⚠️ Ensure that no changes are pending.

1. Rebuild the environment.

   make -s check-revenv
   

2. Update the version.txt file.

3. Push to the main branch.

4. Create repository release.

5. Build the Python package.
   Be sure no uncommited files in tree.

   make -s pypackage
   

6. Upload Python package to PyPi test.

   make -s pypi-upload-test
   

7. Upload Python package to PyPi prod.

   make -s pypi-upload-prod