pyappengine/README.md

pyapp-engine

Development

Installation

pip install -e ".[dev,docs]"

Running the tests

pytest

Coverage report is displayed automatically in the terminal. Other formats:

pytest --cov-report=html    # htmlcov/index.html  (browsable)
pytest --cov-report=xml     # coverage.xml        (CI tools)
pytest --cov-report=term    # terminal summary only

Reports can be combined:

pytest --cov-report=term-missing --cov-report=html

Documentation

Preview locally:

mkdocs serve
# available at http://127.0.0.1:8000

Build the static site:

mkdocs build
# output in site/

License

The pyapp-engine module was written by François Dausseur fdausseur@free.fr.

pyapp-engine is released under the CeCILL-C license.

See the file LICENSE for more details.