Development Guidance
=====================

Setup Environment
-----------------

We recommend you to use `uv <https://docs.astral.sh/uv/#installation>`__ to setup development environment. Then install dependencies with :code:`uv sync`.

Run Tests
---------

Tests in this project are written with `pytest <https://docs.pytest.org/en/stable/>`__. Go through the official documents before making changes.

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

Build And Publish
-----------------

- Update package version - :code:`uv version --bump major|minor|patch`
- Build package - :code:`uv build`
- Publish package - :code:`uv publish --token ${pypi access token}`

Documentation
-------------

Documents in this project are written in ReStructuredText with `Sphinx <https://www.sphinx-doc.org/en/master/index.html>`__ To quickly understand syntax and how it works, the `example <https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html>`__ could be helpful.

Build document - :code:`uv run -- poe doc-build`