CONTRIBUTING.md

Contributing to erdantic

...

Local development

This project is set up using nox for automation. We recommend you install nox as a global tool with pipx:

pipx install nox

Many of the nox sessions are configured to use conda environments. erdantic depends on graphviz, a C library, so conda is handy for installing it together alongside the Python dependencies. We recommend you install conda through the miniforge distribution, which automatically comes with the faster mamba installer.

Development environment

To create a development environment, run:

nox -s dev

This will create a conda environment in .nox/dev. You can activate it with:

conda activate .nox/dev

Tests

To run the full test matrix on all Python versions, run:

nox -s tests

To run tests for a specific version, use tests-{python-version}, e.g.,

nox -s tests-3.11

Code quality

We use ruff for linting and formatting, and we use mypy for type-checking. You can run them with the following nox sessions:

nox -s lint
nox -s typecheck