Installation¶

Requirements¶

Python 3.10 or higher
Supported platforms: macOS, Linux, Windows
Database: SQLite or PostgreSQL

Install Ferro¶

Ferro is distributed as pre-compiled wheels for all major platforms:

# UV
uv add ferro-orm

# Or pip
pip install ferro-orm

With Migration Support¶

For production use with Alembic migrations:

uv add "ferro-orm[alembic]"

This installs Alembic and SQLAlchemy (used only for migration generation, not at runtime).

Database Drivers¶

Ferro uses SQLx under the hood. SQLite and PostgreSQL support are built into Ferro's published packages, so no additional database-specific packages are required for those backends.

SQLite¶

No additional setup needed. SQLite is embedded in Ferro.

PostgreSQL¶

No additional setup needed. PostgreSQL support is built into Ferro.

Optional Dependencies¶

Development Tools¶

For running tests and linting:

uv sync --group dev

This workspace group includes pytest, maturin, docs tooling, and other development dependencies used in this repository.

Building from Source¶

Note

Most users don't need to build from source. Pre-compiled wheels are available for all common platforms.

If you need to build from source (e.g., for an unsupported platform):

Requirements: - Rust 1.70 or higher - Python development headers

# Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install maturin (Rust/Python build tool)
pip install maturin

# Clone and build
git clone https://github.com/syn54x/ferro-orm.git
cd ferro-orm
maturin develop --release

Build time is typically 2-5 minutes depending on your machine.

Next Steps¶

Ready to build your first Ferro application?

Start the tutorial