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

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

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.0.tar.gz (9.9 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.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dbtracker-0.1.0.tar.gz
  • Upload date:
  • Size: 9.9 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.0.tar.gz
Algorithm Hash digest
SHA256 b5512cb5eecf298cd982c92eaa7cb66869fe4ea327d60282f893557466e3836b
MD5 803dd94e534e8f076fd11713e46fdf95
BLAKE2b-256 1e98047a161116471cbc082c7014eadb9e07c54a8c5b8ad3fe225a3b84ee6031

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dbtracker-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 11.1 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1eb7cbfb80bad16073d175be17da98edf147474db5f3084413563e9a133dbf9e
MD5 2dd416a73585925e4298fe8d929eef4b
BLAKE2b-256 0f141dbd8308d3a710de2d7a85da40f9db1eca3efff3edf7c2cc92ffe49714f3

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