Skip to content

Contributing

We welcome contributions to the Voxta Python Client!

Development Setup

This project uses uv for dependency management and Ruff for linting and formatting.

1. Clone the repository

git clone https://github.com/dion-labs/voxta-client.git
cd voxta-client

2. Install dependencies

uv sync --all-extras

3. Install pre-commit hooks

uv run pre-commit install

4. Run tests

uv run pytest

5. Build documentation locally

uv run mkdocs serve

Pull Request Process

  1. Create a new branch for your changes.
  2. Ensure tests pass and the code is properly formatted (ruff format .).
  3. Submit a pull request with a clear description of your changes.