Skip to content

Installation

This guide covers installing protoruf in your Python project.

Prerequisites

  • Python 3.12 or higher
  • pip or uv (recommended)
  • Rust toolchain is NOT required — pre-built wheels are provided

Install via pip

pip install protoruf

uv is a fast Python package manager. If you don't have it:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then install protoruf:

uv pip install protoruf

Development Installation

If you want to contribute or build from source:

1. Clone the repository

git clone https://github.com/EdwinAlkins/protoruf.git
cd protoruf

2. Install dependencies

uv sync --dev

3. Build the Rust extension

uv run maturin develop

Rust Requirement

Building from source requires Rust installed on your system. Pre-built wheels do not require Rust.

Verify Installation

python -c "import protoruf; print(protoruf.__version__)"

You should see the version number printed without errors.

Platform Support

Pre-built wheels are available for:

Platform Architecture
Linux x86_64, aarch64
macOS x86_64, arm64
Windows x86_64

Missing Wheel?

If a pre-built wheel is not available for your platform, pip will attempt to build from source. Ensure Rust is installed in that case.

Next Steps