Development Guidance

Setup Environment

We recommend you to use uv to setup development environment. Then install dependencies with uv sync.

Run Tests

Tests in this project are written with pytest. Go through the official documents before making changes.

To run test cases, run uv run -- poe test under project root.

Build And Publish

• Update package version - uv version --bump major|minor|patch

• Build package - uv build

• Publish package - uv publish --token ${pypi access token}

Documentation

Documents in this project are written in ReStructuredText with Sphinx To quickly understand syntax and how it works, the example could be helpful.

Build document - uv run -- poe doc-build