Development Guide

This guide covers the development workflow for django-ldaporm contributors.

Setting Up the Development Environment

Clone the repository:

git clone https://github.com/your-repo/django-ldaporm.git
cd django-ldaporm

Install development dependencies:

# Using uv (recommended)
uv sync --dev

# Or using pip
pip install -e ".[dev]"

Install pre-commit hooks:

pre-commit install

django-ldaporm follows these coding standards:

Format your code with Ruff:

ruff format ldaporm/

Run type checking with mypy:

mypy ldaporm/

Run linting with ruff:

ruff check ldaporm/
ruff check --fix ldaporm/

Note

We use like pytest for testing, but don’t have any tests yet.

Run the test suite:

pytest

Build the documentation:

cd doc
make html

View the documentation:

# Open doc/build/html/index.html in your browser
open doc/build/html/index.html

When adding new features:

Write tests first (TDD approach):

# tests/test_new_feature.py
def test_new_feature():
    # Write your test
    pass

Implement the feature:

# ldaporm/new_feature.py
def new_feature():
    # Implement your feature
    pass

Add documentation:
- Update docstrings in Sphinx Napoleon format
- Add examples to the documentation
- Update the API reference

Run all checks:

ruff check ldaporm/
ruff check --fix ldaporm/
mypy ldaporm/
pytest