<!-- omit in toc -->
# DB Drift
[](https://badge.fury.io/py/db-drift)
[](https://pepy.tech/project/db-drift)
[](https://github.com/dyka3773/db-drift/actions)
[](https://github.com/astral-sh/ruff)
A command-line tool to visualize the differences between two DB states.
<!-- omit in toc -->
## Table of Contents
- [Installation](#installation)
- [Features](#features)
- [How to Use](#how-to-use)
- [Examples](#examples)
- [Options](#options)
- [Supported DBMS Types](#supported-dbms-types)
- [Troubleshooting](#troubleshooting)
- [Common Issues](#common-issues)
- [Getting Help](#getting-help)
- [Contributing](#contributing)
- [License](#license)
## Installation
Install the package from PyPI:
```bash
# Using pip
pip install db-drift
# Using pipx
pipx install db-drift
# Using poetry
poetry add db-drift
# Using pipenv
pipenv install db-drift
# Using uv
uv add db-drift
```
## Features
- Compare two database states and visualize the differences.
## How to Use
Basic usage:
```bash
db-drift --source "sqlite:///source.db" --target "sqlite:///target.db"
```
The tool will generate an HTML report showing the differences between the two database states.
## Examples
```bash
# Compare two SQLite databases
db-drift --source "sqlite:///old_version.db" --target "sqlite:///new_version.db"
# Specify custom output file
db-drift --source "sqlite:///db1.db" --target "sqlite:///db2.db" --output "my_report.html"
# Show version information
db-drift --version
```
## Options
| Option | Description | Default | Required |
|--------|-------------|---------|----------|
| `-v`, `--version` | Show version information and exit | - | No |
| `--dbms` | Specify the type of DBMS | `sqlite` | No |
| `-o`, `--output` | Output filename for the drift report | `drift_report.html` | No |
| `--source` | Connection string for the source database | - | **Yes** |
| `--target` | Connection string for the target database | - | **Yes** |
| `--verbose` | Enable verbose logging output | No | No |
### Supported DBMS Types
Currently supported database management systems:
- `sqlite` - SQLite databases
*Note: Support for PostgreSQL, MySQL, and Oracle is planned for future releases.*
## Troubleshooting
### Common Issues
### Getting Help
- Check the [examples](examples/) directory for working samples
- Review the [issues](https://github.com/dyka3773/db-drift/issues) page for known problems
- Create a new issue if you encounter a bug or have a feature request
## Contributing
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.
Please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for more details.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "db-drift",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "cli, command-line, database, db-drift, diff, visualization",
"author": null,
"author_email": "Hercules Konsoulas <dyka3773@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/12/b5/a6fd417642f4d07b4f295b20a9efa81d9225155b1eecef83f22933f327a1/db_drift-1.2.0.tar.gz",
"platform": null,
"description": "<!-- omit in toc -->\n# DB Drift\n\n[](https://badge.fury.io/py/db-drift)\n\n\n[](https://pepy.tech/project/db-drift)\n[](https://github.com/dyka3773/db-drift/actions)\n[](https://github.com/astral-sh/ruff)\n\nA command-line tool to visualize the differences between two DB states.\n\n<!-- omit in toc -->\n## Table of Contents\n- [Installation](#installation)\n- [Features](#features)\n- [How to Use](#how-to-use)\n- [Examples](#examples)\n- [Options](#options)\n - [Supported DBMS Types](#supported-dbms-types)\n- [Troubleshooting](#troubleshooting)\n - [Common Issues](#common-issues)\n - [Getting Help](#getting-help)\n- [Contributing](#contributing)\n- [License](#license)\n\n\n## Installation\n\nInstall the package from PyPI:\n\n```bash\n# Using pip\npip install db-drift\n\n# Using pipx\npipx install db-drift\n\n# Using poetry\npoetry add db-drift\n\n# Using pipenv\npipenv install db-drift\n\n# Using uv\nuv add db-drift\n```\n\n## Features\n- Compare two database states and visualize the differences.\n\n## How to Use\n\nBasic usage:\n\n```bash\ndb-drift --source \"sqlite:///source.db\" --target \"sqlite:///target.db\"\n```\n\nThe tool will generate an HTML report showing the differences between the two database states.\n\n## Examples\n\n```bash\n# Compare two SQLite databases\ndb-drift --source \"sqlite:///old_version.db\" --target \"sqlite:///new_version.db\"\n\n# Specify custom output file\ndb-drift --source \"sqlite:///db1.db\" --target \"sqlite:///db2.db\" --output \"my_report.html\"\n\n# Show version information\ndb-drift --version\n```\n\n## Options\n\n| Option | Description | Default | Required |\n|--------|-------------|---------|----------|\n| `-v`, `--version` | Show version information and exit | - | No |\n| `--dbms` | Specify the type of DBMS | `sqlite` | No |\n| `-o`, `--output` | Output filename for the drift report | `drift_report.html` | No |\n| `--source` | Connection string for the source database | - | **Yes** |\n| `--target` | Connection string for the target database | - | **Yes** |\n| `--verbose` | Enable verbose logging output | No | No |\n\n### Supported DBMS Types\n\nCurrently supported database management systems:\n- `sqlite` - SQLite databases\n\n*Note: Support for PostgreSQL, MySQL, and Oracle is planned for future releases.*\n\n## Troubleshooting\n\n### Common Issues\n\n### Getting Help\n\n- Check the [examples](examples/) directory for working samples\n- Review the [issues](https://github.com/dyka3773/db-drift/issues) page for known problems\n- Create a new issue if you encounter a bug or have a feature request\n\n## Contributing\n\nContributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.\n\nPlease read our [CONTRIBUTING.md](CONTRIBUTING.md) file for more details.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.",
"bugtrack_url": null,
"license": null,
"summary": "A command line tool to visualize the differences between two DB states.",
"version": "1.2.0",
"project_urls": {
"documentation": "https://dyka3773.github.io/db-drift/",
"source": "https://github.com/dyka3773/db-drift"
},
"split_keywords": [
"cli",
" command-line",
" database",
" db-drift",
" diff",
" visualization"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5b94021210299232564992f6c7a222dad86fafcd72a3cfea95fecdcf45d86b45",
"md5": "b19532248d0ed5143eb73c5016aaae70",
"sha256": "08fe83bc8c8f3fa90ed634038e2d87e6b89761e09d0e821c4a94c1dac51bcd44"
},
"downloads": -1,
"filename": "db_drift-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b19532248d0ed5143eb73c5016aaae70",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13870,
"upload_time": "2025-10-19T12:04:51",
"upload_time_iso_8601": "2025-10-19T12:04:51.577142Z",
"url": "https://files.pythonhosted.org/packages/5b/94/021210299232564992f6c7a222dad86fafcd72a3cfea95fecdcf45d86b45/db_drift-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "12b5a6fd417642f4d07b4f295b20a9efa81d9225155b1eecef83f22933f327a1",
"md5": "7d11ef52f3d9fee130e589a6091da821",
"sha256": "b81e07690c0edc687a29c894ab8325c0a22dadd1a25f0078713af8cd6c7bbf6f"
},
"downloads": -1,
"filename": "db_drift-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "7d11ef52f3d9fee130e589a6091da821",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 182129,
"upload_time": "2025-10-19T12:04:52",
"upload_time_iso_8601": "2025-10-19T12:04:52.411372Z",
"url": "https://files.pythonhosted.org/packages/12/b5/a6fd417642f4d07b4f295b20a9efa81d9225155b1eecef83f22933f327a1/db_drift-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-19 12:04:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dyka3773",
"github_project": "db-drift",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "db-drift"
}
JSON
