dbit 0.1.1

Git-like CLI tool for database schema version control with multi-database support

dbit - Database Schema Version Control

A Git-like CLI tool for managing database schemas with version control capabilities.

Features

• Git-like interface for database schema management
• Support for PostgreSQL, MySQL, and SQLite
• Schema snapshots and version tracking
• Schema quality validation
• Change detection and comparison

Installation

Using PyPI (Recommended)

pip install dbit

Using GitHub (Latest)

pip install git+https://github.com/nrnavaneet/dbit.git

From Source (Development)

git clone https://github.com/nrnavaneet/dbit.git
cd dbit
python -m venv venv
source venv/bin/activate
pip install -e .

With Docker

docker pull ghcr.io/nrnavaneet/dbit:latest
# Or build locally for development:
docker build --target development -t dbit:dev .

Usage Example

For a full list of commands and options, run:

dbit help
# or
dbit --help
# or
dbit -h

Common usage:

# Initialize a dbit repository in your project
dbit init

# Connect to your database
dbit connect --db-url postgresql://user:password@localhost/dbname

# Take a schema snapshot
dbit snapshot

# See changes since last snapshot
dbit status

# View schema change history
dbit log

# Run schema quality checks
dbit verify

Commands

---

Command	Description
dbit --help	For full list of commands
dbit init	Initialize a new dbit repository
dbit connect --db-url <url>	Connect to a database
dbit disconnect	Disconnect from current database
dbit snapshot [--content N]	Create schema snapshot
dbit status [--content N].	Show changes since last snapshot
dbit log	Show change history
dbit verify	Verify schema quality

---

Connection Strings

# PostgreSQL
postgresql://user:password@host:port/database

# MySQL
mysql://user:password@host:port/database

# SQLite
sqlite:///path/to/database.db

Configuration

dbit stores configuration in .dbit/schema.yaml:

db: postgresql://user:password@localhost/dbname
migrations: []
current_version: v1.json

Documentation

• Contributing Guide
• Code of Conduct

Contributing

If you want to contribute to dbit, follow these steps:

Quick Developer Setup

Use the provided script to set up your environment:

./scripts/setup-dev.sh

This will:

• Check your Python version (3.8+ required)
• Create and activate a virtual environment (venv)
• Upgrade pip
• Install all development dependencies
• Install pre-commit hooks
• Run pre-commit on all files

After setup, activate your environment with:

source venv/bin/activate

Run tests with:

pytest

Run all pre-commit checks manually with:

pre-commit run --all-files

Manual Setup (Alternative)

1. Fork the repository
2. Clone your fork: git clone https://github.com/YOUR_USERNAME/dbit.git
3. Create a virtual environment and activate it:

   python -m venv venv
   source venv/bin/activate
   

4. Install development dependencies:

   pip install -e ".[dev]"
   

5. Install pre-commit hooks:

   pre-commit install
   

6. Create a feature branch, make your changes, run tests (pytest), and submit a pull request.

Development with Docker

# Build development image
docker build --target development -t dbit:dev .

# Run development container
# Mount your code for live editing
# (from project root)
docker run -it --rm -v $(pwd):/app dbit:dev

License

MIT License - see LICENSE file for details.

Author

N R Navaneet