Documentation

Install python-makelib.

git clone --recurse-submodules [email protected]:yhttp/yhttp.git

Create virtual environment:

make venv

Delete virtual environment:

make venv-delete

Activate the virtual environment:

source ./activate.sh

Install this project as editable mode and all other development dependencies:

make env

Execute all tests:

make test

Execute specific test(s) using wildcard:

make test F=tests/test_db*
make test F=tests/test_form.py::test_querystringform

refer to pytest documentation for more info about invoking tests.

Execute tests and report coverage result:

make cover
make cover F=tests/test_static.py
make cover-html

make lint

Execute these commands to create Python's standard distribution packages at dist directory:

make sdist
make wheel

Or

make dist

to create both sdidst and wheel packages.

Execute:

make clean

to clean-up previous dist/* and build/* directories.

WARNING: Do not do this if you'r not responsible as author and or maintainer of this project.

Execute

make clean
make pypi

to upload sdists and wheel packages on PyPI.

make doc
make livedoc
make doctest

Or

cd sphinx
make doctest
make html
make livehtml