Metadata-Version: 2.3
Name: santai-sdk
Version: 0.1.0
Summary: The official santai SDK.
Author: Santai
Requires-Dist: python-dotenv
Requires-Dist: requests
Requires-Dist: mkdocs>=1.6.0 ; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5.0 ; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.26.0 ; extra == 'docs'
Requires-Dist: pymdown-extensions>=10.0 ; extra == 'docs'
Requires-Dist: ruff>=0.14.14 ; extra == 'docs'
Requires-Dist: pytest>=8.0.0 ; extra == 'test'
Requires-Python: >=3.10
Provides-Extra: docs
Provides-Extra: test
Description-Content-Type: text/markdown

# Santai SDK

## Setup

```bash
uv sync

```

## Documentation

Build and view the documentation locally:

```bash
# Install with documentation dependencies
uv sync --extra docs

# Serve docs locally with live reload
uv run mkdocs serve

# Build static documentation to site/
uv run mkdocs build
```

The documentation is automatically generated from source code docstrings using
[mkdocstrings](https://mkdocstrings.github.io/). To update the docs, simply
enhance the docstrings in the source code and rebuild.

Visit <http://127.0.0.1:8000> after running `mkdocs serve` to view the docs.

## Development

This project uses several programmatic tools for code quality. Read the
documentation on some of these tools to understand their functionality and basic
commands for running quality checks.

```bash
uv tool install codespell
uv tool install ruff
uv tool install rumdl
uv tool install ty
```

This project also uses pre-commit (prek) for ensuring that each commit passes
the code quality checks. See the
[pre-commit configuration](.pre-commit-config.yaml)

```bash
uv tool install prek
```

### Quality Checks

Run code quality checks before committing:

```bash
# Format code
uv run ruff format

# Lint code
uv run ruff check --fix

# Check spelling
uv tool run codespell

# Lint markdown
uv tool run rumdl docs/
```
