poetryto manage development dependencies.
pre-committo run various linters and formatters.
pytestfor testing and
mypyfor static type-checking.
mkdocswith the Material theme for documentation.
To set up a local development environment after cloning the repository:
poetry shellto create a virtual environment for
spieland spawn a new shell session with that virtual environment activated. In the future you'll run
poetry shellagain to activate the virtual environment.
poetry installto install Spiel's dependencies.
pre-commit installto configure
pre-commit's integration with
git. Do not commit without
Running Tests and Type-Checking
pytest to run tests.
mypy to check types.
Building the Docs Locally
To build the docs and start a local web server to view the results of your edits with live reloading, run