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.3.tar.gz (99.0 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.3-py3-none-any.whl (37.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbwarden-0.1.3.tar.gz
  • Upload date:
  • Size: 99.0 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.3.tar.gz
Algorithm Hash digest
SHA256 10ed44bdee2cf64c7f6b893f619da293884e0dde93d0704c22a511f46bf2717f
MD5 0952a7f30265c3e183888eddd7bd5724
BLAKE2b-256 e2f8650c48ab205606f25a3ab9207c8e1e47f3085db7368edf15d74854ca6c28

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dbwarden-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 37.6 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 39c3670385be2074ab107a0836782a0a4ccecee937c900d0d2712b6832072fd8
MD5 ed061a02fcce58cef907b35d9fcfbb25
BLAKE2b-256 535bae1be772f3197519eb056942e058bee42f564a77daaec385fc042043340e

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