Skip to main content

CLI tool for schema tracking

Project description

Datatrack - Lightweight Schema Change Tracker

Datatrack is a minimal open-source CLI tool to track schema changes across versions in your data systems. It's built for Data Engineers and Platform Teams who want automated schema linting, verification, diffs, and export across snapshots.

Features

  • Snapshot schemas from any SQL-compatible DB
  • Lint schema naming issues
  • Enforce verification rules
  • Compare schema snapshots (diff)
  • Export to JSON/YAML for auditing or CI
  • Full pipeline in one command

Installation

Option 1: Install from GitHub (for development)

git clone https://github.com/nrnavaneet/datatrack.git
cd datatrack
pip install -r requirements.txt
pip install -e .

This method is ideal if you want to contribute or modify the tool.

Option 2: Install from PyPI (production use)

pip install dbtracker

This is the easiest and recommended way to use datatracker as a CLI tool in your workflows.

How to Use

1. Initialize Tracking

datatrack init

Creates .datatrack/, .databases/, and optional initial files.

2. Create Example SQLite DB (Optional)

import sqlite3
from pathlib import Path

Path(".databases").mkdir(parents=True, exist_ok=True)
conn = sqlite3.connect(".databases/example.db")
c = conn.cursor()
c.execute("CREATE TABLE users (id INTEGER, name TEXT, created_at TEXT)")
c.execute("CREATE TABLE orders (order_id INTEGER, user_id INTEGER, amount REAL)")
conn.commit()
conn.close()

3. Take a Schema Snapshot

datatrack snapshot --source sqlite:///.databases/example.db

4. Run Linter

datatrack lint

Warns if ambiguous names, overly generic types, etc.

5. Schema Verification

datatrack verify

By default reads rules from schema_rules.yaml in project root.

6. Show Schema Differences

datatrack diff

Compares latest 2 snapshots.

7. Export Snapshot or Diff

datatrack export --type snapshot --format json --output output/snapshot.json

datatrack export --type diff --format yaml --output output/diff.yaml

8. View Snapshot History

datatrack history

Lists snapshot filenames.

9. Run Full Pipeline

datatrack run --source sqlite:///.databases/example.db

This runs:

  • lint
  • snapshot
  • verify
  • diff
  • export

To change export location:

datatrack run --source sqlite:///.databases/example.db --export-dir my_output_dir

👤 Author

Built with ❤️ by @nrnavaneet

📝 License

MIT 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

dbtracker-0.1.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dbtracker-0.1.1-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file dbtracker-0.1.1.tar.gz.

File metadata

  • Download URL: dbtracker-0.1.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for dbtracker-0.1.1.tar.gz
Algorithm Hash digest
SHA256 91eaa65dfc5ff14f604e2c88bbc8b4b11f528bc7b7e0a38493ce84d043f089ec
MD5 dc7a16f481d7ca26ccc5e2893cd67ce9
BLAKE2b-256 78cb762e827dc2ccaf00a2a742e95783b31d67524a0c5d4958ce9b2e407aa65f

See more details on using hashes here.

File details

Details for the file dbtracker-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: dbtracker-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for dbtracker-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6d0f746524fd41d72f98fbfed2ba86a8c2b491d7239e73f87ceae4ef5f7eebd1
MD5 ab1b1414b7abf0f2cf362f7513da8496
BLAKE2b-256 e2134085c3597e57d403286ad34480796264dac65f540a3b676e3ffe471cda3d

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