Mini Vouchers

A minimal implementation of a voucher system.

Installation

Simply install using the setup command, e.g. within a virtual environment:

$ virtualenv -p python3 venv
$ . ./venv/bin/activate
(venv)$ pip install .

Requirements

Python 3.6 is required.

Documentation

The main entrypoint is documented as a regular command line interface:

$ mini-vouchers --help
...

The project itself is mainly documented through its docstrings.

If you are so enclined, you can generate a standalone documentation with Sphinx:

$ virtualenv -p python3 venv
$ . ./venv/bin/activate
(venv)$ pip install -r requirements-dev.txt
(venv)$ cd docs
(venv)$ make html
# or `make help` to list all possible targets

Development

The Python files are formatted with Black and linted with flake8 and pylint. A pre-commit hook is defined to automate the mundane work.

To start developing, initialise the development environment and install the pre-commit hook with:

$ virtualenv -p python3 venv
$ . ./venv/bin/activate
(venv)$ pip install -r requirements-dev.txt
(venv)$ pre-commit install

License

This project is free software and licensed under the GNU General Public License v3 or later.

Authors

mini-vouchers was written by Borjan Tchakaloff.

Credits

This package was created with Cookiecutter and is based on the audreyr/cookiecutter-pypackage and kragniz/cookiecutter-pypackage-minimal project templates.