Skip to content

Developer guide

Setup

Clone the repository and install with development dependencies:

git clone https://github.com/peppedilillo/sedbuilder.git
cd sedbuilder
pip install -e ".[dev]"

Pre-commit Hooks

Install pre-commit hooks to automatically format code before commits:

pre-commit install

This runs black (line length 120) and isort (Google profile) automatically.

Running Tests

pytest

You must first cd into the project directory.

Building Documentation

pip install -e ".[docs]"
mkdocs serve