Scripts to watch Pokémon games being played on an emulator
The package provides a src
directory, under which Python modules and packages sit.
Tests are placed under the tests
directory, and documentation under the docs
directory.
This package sets up various tox
environments for static checks, testing, building and publishing.
It is also configured with pre-commit
hooks to perform static checks and automatic formatting.
If you do not use tox
, you can build the package with build
and install a development version with pip
.
Assume cd
into the repository's root.
To install the pre-commit
hooks:
pre-commit install
To run type checking:
tox -e typecheck
To run linting tools:
tox -e lint
To run automatic formatting:
tox -e format
To run tests:
tox
To run manual tests:
tox -e debug
To build the package:
tox -e build
To build the package (with build
):
python -m build
To build a standalone executable for the host platform (output in ./dist
):
tox -e exe
To clean the previous build files:
tox -e clean
To test package publication (publish to Test PyPI):
tox -e publish
To publish the package to PyPI:
tox -e publish -- --repository pypi
To install an editable version:
pip install -e .