code-specialist/database-setup-tools

Easy to understand and use python tools that help you to create databases and interact with them

Database Setup Tools for SQLModel / SQLAlchemy

Simplified database lifecycle and session management based on SQLModel / SQLAlchemy.

Any contributions are welcome! But we only accept pull requests that come with tests.

Installation

pip install database-setup-tools

Features

• Database creation on app startup
• Thread-safe database session manager
• Opinionated towards SQLModel but feasible with any other framework or pure sqlalchemy
• Easily use a local database in your tests

Usage

In order to use this library, you need some SQLModel or SQLAlchemy tables and a URI to connect to your database. With this in place, the DatabaseSetup instance can be created - which contains all provided tools and also automatically creates the database including all tables.

from sqlmodel import Field, SQLModel
from database_setup_tools import DatabaseSetup


class User(SQLModel, table=True):
    """ User database entity / table """
    id: int = Field(index=True, primary_key=True)
    name: str


# create database & tables, establish connection with session pool
database_setup = DatabaseSetup(
    model_metadata = SQLModel.metadata,
    database_uri="postgresql+psycopg2://postgres:postgres@localhost:5432/database",
)

Note: The DatabaseSetup class acts as singleton, so if you create multiple instances with the same set of parameters, you will always get the same instance back instead of creating a new one.

After the setup is created, you can get a scoped session via the provided session manager and use it for database transactions.

# get scoped session
session = next(database_setup.session_manager.get_session())

# do stuff in session
user = User(name="Alice")
session.add(user)
session.commit()

The DatabaseSetup instance also provides lifecycle methods allowing to manually control the database:

database_setup.create_database()
database_setup.drop_database()

Development

Testing

1. Spin up databases for local integration tests: docker-compose -f tests/docker-compose.yaml up -d
2. Create virtual environment & install dependencies: poetry install
3. Run tests: poetry run pytest

database-setup-tools's Issues

Update Documentation

SSL Support

Integration tests with multiple real databases

Database Migrations

Add support for database migrations using Alembic

Add examples

          > Let's keep it simple. No hosted docs. People use it or they don't. We can't invest that much. At least as long as Tebuto isn't live 😄

hmm yes the repo is probably not big enough to invest the effort 😄 Should we then just have the examples in an own folder with README.md files and link them in the main readme? Like

README.md
examples/
    fastapi/
       README.md
       app.py
       ...
    pytest/
       README.md
       conftest.py
       ...

I think having the examples as real subprojects is more beneficial than having them in the readme - it's more readable and people can fork it more easily

Originally posted by @JonasScholl in #21 (comment)

Introduce truncate method