development.md

Developing Dante

This document describes how to develop Dante. For the user documentation, see the README and API Reference documentation.

The Zen of Dante

Goals:

• zero-setup
• sync and async
• easy to use
• simple API with no nasty surprises

Code guidelines:

• feature-parity across sync and async (with identical API where applicable)
• 100% test coverage
• 100% coverage with type hints
• explicit is better than implicit (and, really, everything from the Zen of Python)

Setup

We recommend using uv, but you can also use other tools to build and test Dante.

1. Clone the repository:

   git clone [email protected]:senko/dante
   cd dante

2. Set up the virtual environment and install the dependencies:

   uv sync --dev
   source .venv/bin/activate

3. Set up git pre-commit hooks:

   pre-commit install

Tests

Run the tests with coverage plugin:

pytest --cov=dante

This will show the coverage summary. To build a detailed HTML report, then run:

coverage html

The report will be saved in the htmlcov directory.

Linting and formatting

We use ruff for formatting and linting, with the default rules. To run the checks:

ruff check --fix
ruff format

Publishing the package

To publish the package, follow these steps:

1. Run pytest, ruff check, and ruff format to ensure everything is in order.
2. Bump the version in pyproject.toml, commit the version bump, and create a tag for it.
3. Push the package to GitHub and wait for the tests to pass.
4. Build the package: uvx --from build pyproject-build --installer uv
5. Upload the package to PyPI: uvx twine upload dist/*
6. Clear the dist directory: rm -rf dist/
7. Create a release on GitHub with the release notes, referencing the newly created tag.