Module Description
- Python >= 3.6
It is highly recommended to use a venv
for installation. Leveraging a venv
will ensure the installed dependency files will not impact other python projects or system level requirements.
The instruction below make use of a bash shell and a Makefile. All commands should be able to be run individually of your shell does not support make
Clone this repo and enter root directory of repo:
$ git clone https://github.com/Preocts/[MODULE_NAME]
$ cd [MODULE_NAME]
Create and activate venv
:
$ python3 -m venv venv
$ . venv/bin/activate
Your command prompt should now have a (venv)
prefix on it.
Install editable library and development requirements:
(venv) $ pip install -r requirements-dev.txt
(venv) $ pip install --editable .
Run tests
(venv) $ tox
To exit the venv
:
(venv) $ deactivate
This repo has a Makefile with some quality of life scripts if your system supports make
.
update
: Clean all artifacts, update pip, update requirements, install everythingclean-pyc
: Deletes python/mypy artifactsclean-tests
: Deletes tox, coverage, and pytest artifactsbuild-dist
: Build source distribution and wheel distribution