Skip to main content

Installation

pip install pypaginate

Python 3.11+. The native engine ships inside the wheel (built with PyO3 + maturin), so there's no Rust toolchain to install and no separate native package to manage. Prebuilt wheels cover Linux (manylinux + musllinux), macOS, and Windows on x86-64 and arm64.

The core has zero runtime dependencies. Pydantic is not a core dependency — install an extra only for the adapter you use.

Extras

pip install "pypaginate[sqlalchemy]" # SQLAlchemy 2.0 offset + keyset (sync + async)
pip install "pypaginate[fastapi]" # FastAPI dependencies (+ Pydantic request models)
pip install "pypaginate[django]" # Django Q-object builders
pip install "pypaginate[all]" # everything above
ExtraPulls inFor
sqlalchemySQLAlchemy[asyncio]>=2.0SQLAlchemy integration
fastapifastapi>=0.95, pydantic>=2.0FastAPI integration
djangoDjango>=4.2Django integration

Ranked and fuzzy/trigram search needs no extra — it runs in the native engine.

With uv

uv add pypaginate
uv add "pypaginate[all]"

Verify

import pypaginate
print(pypaginate.__version__)

Next

  • Quickstart — paginate, filter, sort, and search in a few lines.