Development

Requirements

• Python 3.9+
• Rust 1.70+
• uv package manager
• Linux or MacOS

Before you start: Please make sure you can successfully build and run the Fluss Rust client on your machine. The Python bindings require a working Fluss Rust backend and compatible environment.

Install Development Dependencies

cd bindings/python
uv sync --all-extras

Build Development Version

source .venv/bin/activate
uv run maturin develop

Build Release Version

uv run maturin build --release

Code Formatting and Linting

uv run ruff format python/
uv run ruff check python/

Type Checking

uv run mypy python/

Run Examples

uv run python example/example.py

Build API Docs

uv run pdoc fluss

Release

# Build wheel
uv run maturin build --release

# Publish to PyPI
uv run maturin publish

Project Structure

bindings/python/
├── Cargo.toml            # Rust dependency configuration
├── pyproject.toml         # Python project configuration
├── README.md              # User guide
├── DEVELOPMENT.md         # This file
├── API_REFERENCE.md       # API reference
├── src/                   # Rust source code (PyO3 bindings)
│   ├── lib.rs
│   ├── config.rs
│   ├── connection.rs
│   ├── admin.rs
│   ├── table.rs
│   └── error.rs
├── fluss/                 # Python package
│   ├── __init__.py
│   ├── __init__.pyi       # Type stubs
│   └── py.typed
└── example/
    └── example.py

License

Apache 2.0 License