dbwarden 1.0.0__tar.gz

dbwarden-1.0.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

dbwarden-1.0.0/.gitignore

@@ -0,0 +1,160 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

dbwarden-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Emiliano Gandini Outeda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dbwarden-1.0.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: dbwarden
+Version: 1.0.0
+Summary: Professional database migration system for Python/SQLAlchemy projects
+Author-email: DBWarden <dbwarden@example.com>
+License: MIT
+License-File: LICENSE
+Keywords: database,fastapi,migrations,postgres,sqlalchemy
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: aiosqlite>=0.22.1
+Requires-Dist: asyncpg<0.32.0,>=0.29.0
+Requires-Dist: packaging>=25.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=12.2.0
+Requires-Dist: sqlalchemy>=2.0.10
+Requires-Dist: typer>=0.12.3
+Provides-Extra: dev
+Requires-Dist: psycopg2-binary>=2.9.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest>=8.4.2; extra == 'dev'
+Provides-Extra: postgres-async
+Requires-Dist: asyncpg<0.32.0,>=0.29.0; extra == 'postgres-async'
+Requires-Dist: sqlalchemy[postgresql]>=2.0.10; extra == 'postgres-async'
+Provides-Extra: postgres-sync
+Requires-Dist: psycopg2-binary>=2.9.11; extra == 'postgres-sync'
+Provides-Extra: sqlite-async
+Requires-Dist: aiosqlite>=0.22.1; extra == 'sqlite-async'
+Description-Content-Type: text/markdown
+
+# DBWarden
+
+**DBWarden** is a database migration system for Python/SQLAlchemy projects.
+
+## Installation
+
+```bash
+pip install dbwarden
+```
+
+## Configuration
+
+Create `.env` in your project:
+
+```env
+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/`:
+
+```python
+# 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
+
+```bash
+# 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)
+
+## License
+
+MIT

dbwarden-1.0.0/README.md

@@ -0,0 +1,87 @@
+# DBWarden
+
+**DBWarden** is a database migration system for Python/SQLAlchemy projects.
+
+## Installation
+
+```bash
+pip install dbwarden
+```
+
+## Configuration
+
+Create `.env` in your project:
+
+```env
+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/`:
+
+```python
+# 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
+
+```bash
+# 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)
+
+## License
+
+MIT

dbwarden-1.0.0/dbwarden/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.0.0"

dbwarden-1.0.0/dbwarden/cli/__init__.py

@@ -0,0 +1,3 @@
+from dbwarden.cli.main import app
+
+__all__ = ["app"]

dbwarden-1.0.0/dbwarden/cli/main.py

@@ -0,0 +1,181 @@
+import typer
+
+from dbwarden.cli.validators import validate_directory
+from dbwarden.commands import (
+    handle_check_db,
+    handle_diff,
+    handle_env,
+    handle_history,
+    handle_init,
+    handle_lock_status,
+    handle_make_migrations,
+    handle_migrate,
+    handle_mode,
+    handle_new,
+    handle_rollback,
+    handle_squash,
+    handle_status,
+    handle_unlock,
+    handle_version,
+)
+from dbwarden.logging import get_logger
+
+app = typer.Typer(
+    help="DBWarden - Professional database migration system for Python models",
+    add_completion=False,
+)
+
+
+@app.command()
+def init():
+    """Initialize the migrations directory."""
+    handle_init()
+
+
+@app.command()
+def make_migrations(
+    description: str = typer.Argument(None, help="Description for the migration"),
+    verbose: bool = typer.Option(
+        False, "--verbose", "-v", help="Enable verbose logging"
+    ),
+):
+    """Auto-generate SQL migration from SQLAlchemy models."""
+    validate_directory()
+    handle_make_migrations(description=description, verbose=verbose)
+
+
+@app.command()
+def new(
+    description: str = typer.Argument(..., help="Description of the migration"),
+    version: str = typer.Option(
+        None, "--version", "-v", help="Version of the migration"
+    ),
+):
+    """Create a new manual migration file."""
+    validate_directory()
+    handle_new(description=description, version=version)
+
+
+@app.command()
+def migrate(
+    count: int = typer.Option(
+        None, "--count", "-c", help="Number of migrations to apply"
+    ),
+    to_version: str = typer.Option(
+        None, "--to-version", "-t", help="Migrate to a specific version"
+    ),
+    verbose: bool = typer.Option(
+        False, "--verbose", "-v", help="Enable verbose logging"
+    ),
+):
+    """Apply pending migrations to the database."""
+    validate_directory()
+    handle_migrate(count=count, to_version=to_version, verbose=verbose)
+
+
+@app.command()
+def rollback(
+    count: int = typer.Option(
+        None, "--count", "-c", help="Number of migrations to rollback"
+    ),
+    to_version: str = typer.Option(
+        None, "--to-version", "-t", help="Rollback to a specific version"
+    ),
+    verbose: bool = typer.Option(
+        False, "--verbose", "-v", help="Enable verbose logging"
+    ),
+):
+    """Rollback the last applied migration."""
+    validate_directory()
+    handle_rollback(count=count, to_version=to_version, verbose=verbose)
+
+
+@app.command()
+def history():
+    """Show the full migration history."""
+    validate_directory()
+    handle_history()
+
+
+@app.command()
+def status():
+    """Show migration status (applied and pending)."""
+    validate_directory()
+    handle_status()
+
+
+@app.command()
+def check_db(
+    output: str = typer.Option(
+        "txt", "--out", "-o", help="Output format (json, yaml, sql, txt)"
+    ),
+):
+    """Inspect the live database schema."""
+    validate_directory()
+    handle_check_db(output_format=output)
+
+
+@app.command()
+def diff(
+    diff_type: str = typer.Argument(
+        "all", help="Type of diff (models, migrations, all)"
+    ),
+    verbose: bool = typer.Option(
+        False, "--verbose", "-v", help="Enable verbose logging"
+    ),
+):
+    """Show structural differences between models and database."""
+    validate_directory()
+    handle_diff(diff_type=diff_type, verbose=verbose)
+
+
+@app.command()
+def mode():
+    """Display whether execution is sync or async."""
+    handle_mode()
+
+
+@app.command()
+def squash(
+    verbose: bool = typer.Option(
+        False, "--verbose", "-v", help="Enable verbose logging"
+    ),
+):
+    """Merge multiple consecutive migrations into one."""
+    validate_directory()
+    handle_squash(verbose=verbose)
+
+
+@app.command()
+def env():
+    """Display relevant environment variables without leaking secrets."""
+    handle_env()
+
+
+@app.command()
+def version():
+    """Display DBWarden version and compatibility information."""
+    handle_version()
+
+
+@app.command()
+def lock_status():
+    """Check if migration is currently locked."""
+    validate_directory()
+    handle_lock_status()
+
+
+@app.command()
+def unlock():
+    """Release the migration lock."""
+    validate_directory()
+    handle_unlock()
+
+
+def main() -> None:
+    """Main entry point for DBWarden CLI."""
+    app()
+
+
+if __name__ == "__main__":
+    main()

dbwarden-1.0.0/dbwarden/cli/validators.py

@@ -0,0 +1,22 @@
+from pathlib import Path
+
+from dbwarden.constants import MIGRATIONS_DIR
+from dbwarden.exceptions import DirectoryNotFoundError
+
+
+def validate_directory() -> None:
+    """
+    Ensure command is run from a project directory with migrations/ folder.
+
+    Raises:
+        DirectoryNotFoundError: If no valid migrations directory is found.
+    """
+    current_dir = Path.cwd()
+
+    migrations_dir = current_dir / MIGRATIONS_DIR
+    if migrations_dir.exists() and migrations_dir.is_dir():
+        return
+
+    raise DirectoryNotFoundError(
+        "migrations directory not found. Please run 'dbwarden init' first."
+    )

dbwarden-1.0.0/dbwarden/commands/__init__.py

@@ -0,0 +1,103 @@
+from dbwarden.commands.check_db import check_db_cmd
+from dbwarden.commands.extra import diff_cmd, lock_status_cmd, squash_cmd, unlock_cmd
+from dbwarden.commands.history import history_cmd
+from dbwarden.commands.init import init_cmd
+from dbwarden.commands.make_migrations import make_migrations_cmd, new_migration_cmd
+from dbwarden.commands.migrate import migrate_cmd
+from dbwarden.commands.rollback import rollback_cmd
+from dbwarden.commands.status import status_cmd
+from dbwarden.commands.utils import env_cmd, mode_cmd, version_cmd
+from dbwarden.exceptions import DirectoryNotFoundError
+from dbwarden.logging import get_logger
+
+
+def handle_init() -> None:
+    """Handle init command."""
+    init_cmd()
+
+
+def handle_make_migrations(description: str | None, verbose: bool) -> None:
+    """Handle make-migrations command."""
+    logger = get_logger(verbose=verbose)
+    logger.log_execution_mode("async" if is_async_enabled() else "sync")
+    make_migrations_cmd(description=description, verbose=verbose)
+
+
+def handle_new(description: str, version: str | None) -> None:
+    """Handle new command."""
+    new_migration_cmd(description=description, version=version)
+
+
+def handle_migrate(
+    count: int | None,
+    to_version: str | None,
+    verbose: bool,
+) -> None:
+    """Handle migrate command."""
+    migrate_cmd(count=count, to_version=to_version, verbose=verbose)
+
+
+def handle_rollback(
+    count: int | None,
+    to_version: str | None,
+    verbose: bool,
+) -> None:
+    """Handle rollback command."""
+    rollback_cmd(count=count, to_version=to_version, verbose=verbose)
+
+
+def handle_history() -> None:
+    """Handle history command."""
+    history_cmd()
+
+
+def handle_status() -> None:
+    """Handle status command."""
+    status_cmd()
+
+
+def handle_check_db(output_format: str) -> None:
+    """Handle check-db command."""
+    check_db_cmd(output_format=output_format)
+
+
+def handle_diff(diff_type: str, verbose: bool) -> None:
+    """Handle diff command."""
+    diff_cmd(diff_type=diff_type, verbose=verbose)
+
+
+def handle_mode() -> None:
+    """Handle mode command."""
+    mode_cmd()
+
+
+def handle_squash(verbose: bool) -> None:
+    """Handle squash command."""
+    squash_cmd(verbose=verbose)
+
+
+def handle_env() -> None:
+    """Handle env command."""
+    env_cmd()
+
+
+def handle_version() -> None:
+    """Handle version command."""
+    version_cmd()
+
+
+def handle_lock_status() -> None:
+    """Handle lock-status command."""
+    lock_status_cmd()
+
+
+def handle_unlock() -> None:
+    """Handle unlock command."""
+    unlock_cmd()
+
+
+def is_async_enabled() -> bool:
+    """Check if async mode is enabled."""
+    from dbwarden.database.connection import is_async_enabled
+
+    return is_async_enabled()