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

Create warden.toml in your project:

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

Or use environment variables:

DBWARDEN_SQLALCHEMY_URL=postgresql://user:pass@localhost/db
DBWARDEN_ASYNC=false  # or true for async mode

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 mode Show sync/async mode
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

Environment Variables

Variable Description
DBWARDEN_SQLALCHEMY_URL DB connection URL
DBWARDEN_ASYNC Async mode (true/false)
DBWARDEN_MODEL_PATHS Paths to SQLAlchemy models

Supported Databases

  • PostgreSQL (sync + async)
  • SQLite (sync + async)
  • MySQL (sync)

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.1.4.tar.gz (104.5 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.1.4-py3-none-any.whl (38.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dbwarden-0.1.4.tar.gz
Algorithm Hash digest
SHA256 eddf3c3c2604e302a34dc206c7f03281a72b75c78844f121f75b771736962e38
MD5 c6f3e1eda42fb0a41ba0f3924f456eae
BLAKE2b-256 989925ce65d1239fa17b20a3a91b3c0ba1c779424de70887e30788f87691d4df

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for dbwarden-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3860ef7f13eb4f6aec5da7b76cce89992beebf566457ea42e982bb47b8d6d043
MD5 564d54f5b184fa7b43add9278de694c5
BLAKE2b-256 fd7aa093bb611fa66f49aab75f8b72bd37a96b4fb6391ffe2f2e3df906ce70eb

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