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.1.tar.gz (437.7 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.1-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbwarden-0.2.1.tar.gz
  • Upload date:
  • Size: 437.7 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.1.tar.gz
Algorithm Hash digest
SHA256 a048a23559ddf0341cc9d70b115a153c6fc45099a2948bfbc07611db93ef1bb5
MD5 9d8f26d241545d98952e05318122d882
BLAKE2b-256 91b3bbda89a34636b1f0f0391d8d8670c5ba6d52238c5a7332e264b38fddac25

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dbwarden-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 37.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9598c6cd2cca88d2d7d862bfe25ce2b63fe0a677c380905a0b5366b1bb37b3be
MD5 6a7d39b33ba095a7c5feb2859e0c712f
BLAKE2b-256 498fcbf3a64810b4dbe392340b03a996b44a8835685678bebdc19189ad61c20d

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