Installation
Prerequisites
| Requirement | Version | Why |
|---|---|---|
| Rust | 1.83+ | Compiles the core engine |
| Python | 3.10+ | Runtime for the ORM layer |
| maturin | latest | Builds Rust into a Python extension |
Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup update stable
Install maturin
pip install maturin
Install Ryx
For Users (Quick Install)
- uv add
- uv pip
- pip
uv add ryx
uv pip install ryx
pip install ryx
tip
Ryx requires Rust to be installed on your system even for pip installs, as it ships a pre-compiled binary. If no binary is available for your platform, maturin will compile from source.
From Source (Recommended for Development)
git clone https://github.com/AllDotPy/Ryx
cd Ryx
maturin develop
With Database Features (Source)
Ryx supports three database backends. Enable them as Cargo features:
- PostgreSQL
- MySQL
- SQLite
- All Backends
maturin develop --features postgres
maturin develop --features mysql
maturin develop --features sqlite
maturin develop --features postgres,mysql,sqlite
Verify Installation
python -c "import ryx; print(ryx.__version__)"
You should see 0.1.0 printed.
Next Steps
→ Quick Start — Write your first queries in 5 minutes