Skip to main content

Database migration system for Python/SQLAlchemy projects

Project description

DBWarden

A database migration system for Python/SQLAlchemy projects.

Documentation Ask DeepWiki

Installation

pip install dbwarden

Configuration

⚠️ Warning

This is an experimental package. Your fuckups are not mine to fix. You have been warned.

Even though this is an experimental package, I added lots of failsafes to protect the connected DB as to avoid issues.

Create warden.toml in your project:

sqlalchemy_url = "sqlite:///./development.db"

Basic Commands

Command Description
dbwarden init Initialize migrations directory
dbwarden make-migrations "name" Generate SQL from SQLAlchemy models
dbwarden migrate Apply pending migrations
dbwarden migrate --verbose Apply with detailed logging
dbwarden rollback Revert the last migration
dbwarden history Show migration history
dbwarden status Show current status
dbwarden config Show current configuration
dbwarden check-db Inspect DB schema
dbwarden diff Show models vs DB differences

SQLAlchemy Models

DBWarden automatically detects models in models/:

# models/user.py
from sqlalchemy import Column, Integer, String
from sqlalchemy.orm import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True)
    name = Column(String(100))
    email = Column(String(255), unique=True)

Complete Example

# 1. Initialize
dbwarden init

# 2. Create models in models/

# 3. Generate migration from models
dbwarden make-migrations "create users table"

# 4. Apply
dbwarden migrate --verbose

# 5. View history
dbwarden history

# 6. Check configuration
dbwarden config

Supported Databases

  • PostgreSQL
  • SQLite
  • MySQL

Docs

For more information, see DBWarden Docs or DBWarden DeepWiki page

License

This Project is Licensed under the MIT License. See 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

dbwarden-0.2.0.tar.gz (436.9 kB view details)

Uploaded Source

Built Distribution

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

dbwarden-0.2.0-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

Details for the file dbwarden-0.2.0.tar.gz.

File metadata

  • Download URL: dbwarden-0.2.0.tar.gz
  • Upload date:
  • Size: 436.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for dbwarden-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f2e507bfa64f42c31770dbe94e8e3f3fd3afdc4e891a98b95536d0260b0dfe41
MD5 096fa510383bf647b613a4b6e775b8d9
BLAKE2b-256 15c34a15b97f4b0babd276b77fbacc3354de41d83d1c64bf9031d6a9eb107096

See more details on using hashes here.

File details

Details for the file dbwarden-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: dbwarden-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 37.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for dbwarden-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6c20c37579519760aaa8580a78edb0ccfc15b34cbddf6b698d763bac1fd24986
MD5 1c9c782e9848fab1f298eec3814ad8b1
BLAKE2b-256 ea2a6baa876922f9e80a7bdcee8b7407cc0465c8bdfb00d170c836141c49017f

See more details on using hashes here.

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