Skip to main content

SQLAlchemy Helpers

Project description

SQLAlchemy Helpers

This project contains a tools to use SQLAlchemy and Alembic in a project.

It has Flask and FastAPI integrations, and other framework integrations could be added in the future.

The full documentation is on ReadTheDocs.

You can install it from PyPI.

PyPI Supported Python versions Build status Documentation

Features

Here's what sqlalchemy-helpers provides:

  • Alembic integration:
    • programmatically create or upgrade your schema,
    • get information about schema versions and status
    • drop your tables without leaving alembic information behind
    • use a function in your env.py script to retrieve the database URL, and thus avoid repeating your configuration in two places.
    • migration helper functions such as is_sqlite() or exists_in_db()
  • SQLAlchemy naming convention for easier schema upgrades
  • Automatically activate foreign keys on SQLite
  • Addition of some useful query properties on your models
  • Functions such as get_or_create() or update_or_create() that you can call directly or use on your model classes
  • Optional Flask integration: you can use sqlalchemy-helpers outside of a Flask app and feel at home
  • The models created with sqlalchemy-helpers work both inside and outside the Flask application context
  • Support for asyncio and FastAPI.

This project has 100% code coverage and aims at reliably sharing some of the basic boilerplate between applications that use SQLAlchemy.

Check out the User Guide to learn how to use it in your application, with or without a web framework.

FAQ

Those projects are great, but we also have apps that are not based on Flask and that would benefit from the features provided by sqlalchemy-helpers.

  • Is it used?

Quite a few applications among the Fedora Infrastructure applications use this library to avoid code duplication. It is unlikely that we'll drop it, unless we drop SQLAlchemy itself, or Python. Which is even more unlikely.

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_helpers-1.0.1.tar.gz (40.7 kB view details)

Uploaded Source

Built Distribution

sqlalchemy_helpers-1.0.1-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

Details for the file sqlalchemy_helpers-1.0.1.tar.gz.

File metadata

  • Download URL: sqlalchemy_helpers-1.0.1.tar.gz
  • Upload date:
  • Size: 40.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for sqlalchemy_helpers-1.0.1.tar.gz
Algorithm Hash digest
SHA256 d1b874b2e22cc7b10bcec030f7b53bf65ccea66f1d4e4dec3f33d8e748298901
MD5 16fd63bc0f87a75252320efbad3796d7
BLAKE2b-256 1fc64109c8b6779ae6e26dace6c3d6794f5371287fcf9a29214d708abd571b75

See more details on using hashes here.

File details

Details for the file sqlalchemy_helpers-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sqlalchemy_helpers-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1a80688c2a145c0edb63d8b6ab63872bd528d206f7da2de006f33ae480daf1a6
MD5 f97ac4b887c28c7732f0e6dc0ae2e304
BLAKE2b-256 83f88db356287709f48419757bec55230104dd37b3977513695def228950cc30

See more details on using hashes here.

Supported by

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