Skip to main content

Repository and Django-like QuerySet layers for SQLAlchemy with async support

Project description

📦 sqlalchemy-repository

Django-like Repository & QuerySet layer for SQLAlchemy (async-first)

sqlalchemy-repository brings a familiar, expressive, and powerful QuerySet API on top of SQLAlchemy, inspired by Django ORM — but designed for modern async Python.

It helps you write cleaner, composable database logic with support for:

  • 🔍 Django-style filtering (Q, F)
  • 🔗 Relation traversal via __ syntax
  • 📊 Aggregations (Count, Min, Max, etc.)
  • ⚡ Async-first design
  • 🧱 Repository patterns
  • 🧠 Type-safe and extensible

🚀 Features

  • QuerySet API

    await repo.objects.filter(Q(price__gt=100) & Q(active=True)).all()
    
  • Django-style lookups

    Q(name__icontains="bmw")
    Q(category__parent__id=1)
    
  • F expressions (field references)

    await repo.objects.update(price=F("price") * 1.1)
    
  • Aggregations

    await repo.objects.annotate(total=Count("id"), max_price=Max("price"))
    
  • Annotations

    await repo.objects.annotate(total=F("qty") * F("unit_price"))
    
  • Async support (SQLAlchemy 2.0+)

  • Composable query expressions

  • Repository pattern abstraction


📦 Installation

pip install sqlalchemy-repository

⚙️ Requirements

  • Python 3.11+
  • SQLAlchemy 2.0+

🏗 Basic Usage

Define repository

from sqlalchemy_repository import BaseRepository

class ProductRepository(BaseRepository[Product]):
    model = Product

Querying

products = await repo.objects.filter(
    Q(price__gt=100),
    Q(category__name="Engine")
).order_by("-price").all()

Get single object

product = await repo.objects.get(id=1)

Create

await repo.create(
    name="Brake Pad",
    price=50
)

Update with F expressions

await repo.objects.filter(id=1).update(
    price=F("price") * 1.2
)

Delete

await repo.objects.filter(price__lt=10).delete()

🔗 Relationships via __

await repo.objects.filter(
    category__parent__name="Auto Parts"
)

No manual joins needed — handled internally.


🔍 Q Expressions

from sqlalchemy_repository import Q

query = Q(price__gt=100) & (Q(stock__lt=5) | Q(discount=True))

await repo.objects.filter(query).all()

🧮 Aggregations

from sqlalchemy_repository import Count, Max

result = await repo.objects.annotate(
    total=Count("id"),
    max_price=Max("price")
)

🏷 Annotations

qs = repo.objects.annotate(
    total_price=F("quantity") * F("unit_price")
)

data = await qs.all()

🛠 Development

Install dev dependencies:

pip install -e .[dev]

Run linters:

ruff check .
mypy .

🤝 Contributing

Contributions are welcome.

  1. Fork the repo
  2. Create a feature branch
  3. Write tests
  4. Open a PR

📄 License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqlalchemy_repository-1.1.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqlalchemy_repository-1.1.1-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file sqlalchemy_repository-1.1.1.tar.gz.

File metadata

  • Download URL: sqlalchemy_repository-1.1.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sqlalchemy_repository-1.1.1.tar.gz
Algorithm Hash digest
SHA256 1169442b5192990fdbf087195f0728d600fec61895dcbc4f35e29cbf39782272
MD5 49daa52ee8fb916391244727320d87fe
BLAKE2b-256 8c917392e23891e3f0ec802e6197701fe4a9d9d7dc18b14743693129911982bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqlalchemy_repository-1.1.1.tar.gz:

Publisher: release.yml on AstralMortem/sqlalchemy-repository

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sqlalchemy_repository-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sqlalchemy_repository-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 927d0f3f01241f1ba84b5a35448cccc254994c8bf2c7cfae69a218a645e5edca
MD5 45ca5129fef766a3882305929c54d4b4
BLAKE2b-256 103b02b72332c5a56eb983075713ec14de85170f3ac7decab478511e6d066fc5

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqlalchemy_repository-1.1.1-py3-none-any.whl:

Publisher: release.yml on AstralMortem/sqlalchemy-repository

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page