Contributing

Git workflow

• Fork the repository
• Make your changes in your fork
• Open a pull request to upstream repository - main branch

Development

Install the package in editable mode with test dependencies:

pip install -e '.[test]'

Code away!

Standards

dj-notebook follows these standards:

• Styleguide: PEP-8
• Code of Conduct: Contributor Covenant
• Boring Technology for Packaging: setuptools and build

Code quality

Linting and formatting is done with Black and Ruff:

make lint

Testing

make test

---

Advanced

Odds are you won't need these things.

Building the project locally

Go to the project root

pip install --upgrade build
python -m build

Test the project, forcing reinstall if necessary

pip install dist/*.whl --force-reinstall