fastapi-restkit 0.1.0

Pagination utilities for FastAPI with SQLModel ORM

FastAPI RestKit

Pagination utilities for FastAPI with SQLModel ORM.

Features

• 🚀 Easy pagination for SQLModel queries
• 📦 Generic response models with type hints
• ⚡ FastAPI dependencies ready to use
• 🔍 Async support out of the box

Installation

pip install fastapi-restkit

Or with uv:

uv add fastapi-restkit

Quick Start

from fastapi import FastAPI, Depends
from sqlmodel import Session
from fastapi_restkit import PaginationParams, paginate, PaginatedResponse

app = FastAPI()

@app.get("/items", response_model=PaginatedResponse[Item])
async def list_items(
    session: Session = Depends(get_session),
    pagination: PaginationParams = Depends(),
):
    return await paginate(session, select(Item), pagination)

Development

Setup

# Clone the repository
git clone https://github.com/cacenot/fastapi-restkit.git
cd fastapi-restkit

# Install dependencies with uv
uv sync --dev

# Run tests
uv run pytest

# Run linter
uv run ruff check .

# Run formatter
uv run ruff format .

Project Structure

fastapi-restkit/
├── src/
│   └── fastapi_restkit/
│       ├── __init__.py
│       ├── pagination.py     # Core pagination logic
│       ├── models.py         # Response models
│       └── dependencies.py   # FastAPI dependencies
├── tests/
├── docs/
└── pyproject.toml

License

MIT License - see LICENSE for details.