Tip
This package is part of the ComPWA Organization. For more information about how to contribute to the packages, go to compwa.github.io/develop!
To contribute to the project, you need to install the package in a virtual environment. This can be done best with uv
(see installation instructions here). For this, you first need to get the source code with Git:
git clone https://github.com/ComPWA/sphinx-pybtex-etal-style
cd sphinx-pybtex-etal-style
Now it's simply a matter of creating and activating the virtual environment with uv sync
. The dependencies for the project are 'pinned' in each commit through the uv.lock
file.
uv sync --all-extras
source .venv/bin/activate
Formatting and linting checks are automatically performed when committing changes. This is done with pre-commit. To install the hooks in your local repository, run install pre-commit
with uv
:
uv tool install pre-commit --with pre-commit-uv --force-reinstall
and pre-commit install
once:
pre-commit install --install-hooks
In addition, it may be handy to install tox
:
uv tool install tox --with tox-uv
If the repository provides a Tox configuration under pyproject.toml
, you can see which jobs it defines with:
tox list