Skip to main content

Readable JSON comparison with colorized terminal output

Project description

philiprehberger-json-diff

Tests PyPI version License

Readable JSON/dict comparison with colorized terminal output.

Installation

pip install philiprehberger-json-diff

Usage

from philiprehberger_json_diff import diff, format_diff, diff_summary

old = {"name": "Alice", "age": 30, "city": "NYC"}
new = {"name": "Alice", "age": 31, "country": "US"}

changes = diff(old, new)

# Pretty-print with colors
print(format_diff(changes))

# Get a summary
summary = diff_summary(changes)
# {"added": 1, "removed": 1, "modified": 1, "total": 3}

Nested Comparison

old = {"user": {"name": "Alice", "settings": {"theme": "dark"}}}
new = {"user": {"name": "Alice", "settings": {"theme": "light"}}}

changes = diff(old, new)
# Reports: modified user.settings.theme: 'dark' -> 'light'

Ignore Paths

changes = diff(old, new, ignore={"user.settings.theme"})

API

  • diff(old, new, ignore=None) — Compare two dicts, returns list of Change objects
  • format_diff(changes, color=True) — Format changes as readable string with optional ANSI colors
  • diff_summary(changes) — Return dict with counts by change type

Development

pip install -e .
python -m pytest tests/ -v

License

MIT

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

philiprehberger_json_diff-0.1.5.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

philiprehberger_json_diff-0.1.5-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_json_diff-0.1.5.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_json_diff-0.1.5.tar.gz
Algorithm Hash digest
SHA256 569178e604e819f44b7963d787d5ff397bc2ad9547d91490ab2e3348e2b05954
MD5 6793810699af6de8b0e582684896d94f
BLAKE2b-256 4828535bda730d5e74b62c9641566af240ea334c38fb3d9295665e55d75432f0

See more details on using hashes here.

File details

Details for the file philiprehberger_json_diff-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_json_diff-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ecc5725c4c6b960b8cf97f48915e22374337df9772e3f850210200ba4269dfc0
MD5 3dc3eadefd603814ef151d9ba2136906
BLAKE2b-256 2ad932d4e107651edbe7c3ce7ca39e326b1615135a9acd178b3c36076303effa

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