Skip to content

DEV_README.md

Latest commit

 

History

History
55 lines (33 loc) · 1.36 KB

DEV_README.md

File metadata and controls

55 lines (33 loc) · 1.36 KB

Hirundo Python SDK Development

This repo contains the source code for the Hirundo Python SDK.

Usage

For SDK usage, see:

Note: We currently support CPython 3.10, 3.11, 3.12, and 3.13. PyPy support may be introduced in the future.

Development workflow

Before opening a PR, install dev dependencies and run Ruff:

ruff check
ruff format

Install dev dependencies

Note: You need to install and use uv as a faster drop-in replacement for pip for our project.

Then you can install the dependencies with:

uv sync --all-groups

Install git hooks (optional)

pre-commit install

Build the package

python -m build

Documentation

We use sphinx to generate our documentation. Note: If you want to manually create the HTML files from your documentation, you must install the dev dependency group.

Documentation releases

Documentation releases are published via GitHub Actions when changes are merged to main.

PyPI releases

New versions of hirundo are released via a GitHub Actions workflow that opens a PR with the new version. The package is published to PyPI when that PR is merged.