https://github.com/fedora-infra/sqlalchemy-helpers

A set of helpers to integrate SQLAlchemy and Alembic in a project, with sane defaults
https://github.com/fedora-infra/sqlalchemy-helpers

Last synced: about 1 month ago
JSON representation

A set of helpers to integrate SQLAlchemy and Alembic in a project, with sane defaults

• Host: GitHub
• URL: https://github.com/fedora-infra/sqlalchemy-helpers
• Owner: fedora-infra
• License: lgpl-3.0
• Created: 2021-12-17T11:49:10.000Z (almost 3 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-22T00:41:07.000Z (7 months ago)
• Last Synced: 2024-04-22T00:42:08.367Z (7 months ago)
• Language: Python
• Homepage:
• Size: 722 KB
• Stars: 11
• Watchers: 5
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://sqlalchemy-helpers.readthedocs.io).

You can install it [from PyPI](https://pypi.org/project/sqlalchemy-helpers/).

![PyPI](https://img.shields.io/pypi/v/sqlalchemy-helpers.svg)

![Supported Python versions](https://img.shields.io/pypi/pyversions/sqlalchemy-helpers.svg)

![Build status](https://github.com/fedora-infra/sqlalchemy-helpers/actions/workflows/main.yml/badge.svg?branch=develop)

![Documentation](https://readthedocs.org/projects/sqlalchemy-helpers/badge/?version=latest)

## 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](https://sqlalchemy-helpers.readthedocs.io/en/latest/user.html) to learn

how to use it in your application, with or without a web framework.

## FAQ

- Why not use [Flask-SQLAlchemy](https://flask-sqlalchemy.palletsprojects.com) and

  [Flask-Migrate](https://github.com/miguelgrinberg/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.