Skip to content

pycomole

Test Coookiecutter - Wolt


Documentation: https://ziyunli.github.io/pycomole

Source Code: https://github.com/ziyunli/pycomole


Coding exercises in Python.

Development

Requirements:

Activate the development environment

devenv shell
poetry env use python
poetry install

Testing

pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github project page automatically as part each release.

You can run it locally via:

mkdocs serve

Pre-commit

Pre-commit hooks run all the auto-formatters (e.g. black, isort), linters (e.g. mypy, flake8), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

This project was generated using the wolt-python-package-cookiecutter template.