CONTRIBUTING.md

Setting up the environment

Install dependencies

we use uv to manage dependencies and build the package.

# Install uv if you don't have it already
curl -sSf https://install.pypa.io/get-pip.py | python3 -
pip install uv

Coding style

• Install pre-commit hooks: pre-commit install
• Setup you preferred editor to use ruff formatter

  • e.g., you might need to install ruff formatter extension in VS Code or Cursor, and configure the setting as below

    {
        "[python]": {
          "editor.formatOnSave": true,
          "editor.defaultFormatter": "charliermarsh.ruff",
          "editor.codeActionsOnSave": {
            "source.organizeImports.ruff": "always"
          }
        }
    }

Run tests

# run unit tests
uv run pytest tests/unit

# run integration tests
# make sure the aci account you use has no app configurations nor linked accounts
export ACI_API_KEY=<your-api-key>
export OPENAI_API_KEY=<your-openai-api-key>
uv run pytest tests/it

Build and publish the package

uv sync
uv build
uv publish --token $PYPI_API_TOKEN