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.

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

• Why not use Flask-SQLAlchemy and Flask-Migrate?

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.