Note: This project is under active development. 🚧
A template for Python project layout and configuration.
The project management tool uv is recommended! Simply use
uv run <path>to run code with fast, automatic virtual environment synchronization 🚀
This package is developed for Python 3.13+. Best practice is to first create a virtual environment. The package can be installed locally using pip install <path>, where <path> is the top-level directory containing pyproject.toml. Note that the editable option can be included to track any package modifications. To install optional packages, specify extras, as exemplified here. Developers should install the package with pip install -e <path>[dev]. The additional commands below should be run on new environments, activating formatting/linting hooks and static typing support:
pip install --upgrade pip
pre-commit install
mypy --install-types --non-interactive .