| Name | jsonschema-diff JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A library for comparing JSON schemas and displaying differences |
| upload_time | 2025-08-25 01:55:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2025 Miskler
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
json
schema
diff
comparison
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
rich
pytest
pytest-cov
black
isort
mypy
flake8
pytest-xdist
sphinx
sphinx-autoapi
furo
docutils
types-docutils
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
# 🔍 JSON Schema Diff
<img src="./assets/logo.webp" width="70%" alt="example_working.svg" />
*A powerful, intelligent library for comparing JSON schemas with **beautiful formatted output**, **smart parameter combination**, and **contextual information**.*
[](https://miskler.github.io/jsonschema-diff/tests/tests-report.html)
[](https://miskler.github.io/jsonschema-diff/coverage/)
[](https://python.org)
[](https://pypi.org/project/jsonschema-diff/)
[](LICENSE)
[](https://github.com/psf/black)
[](https://mypy.readthedocs.io/en/stable/index.html)
[](https://discord.gg/UnJnGHNbBp)
[](https://t.me/miskler_dev)
**[⭐ Star us on GitHub](https://github.com/Miskler/jsonschema-diff)** | **[📚 Read the Docs](https://miskler.github.io/jsonschema-diff/basic/quick_start/)** | **[🐛 Report Bug](https://github.com/Miskler/jsonschema-diff/issues)**
## ✨ Features
</div>
- 🎯 **Intelligent Comparison** - Detects and categorizes all types of schema changes
- 🎨 **Beautiful Output** - Colored, formatted differences with clear symbols
- 🔗 **Smart Combination** - Combines related parameters *(e.g., `minimum` + `maximum` = `range`)*
- 📍 **Context Aware** - Shows related fields for better understanding *(e.g., `type` + `format`)*
- ⚡ **High Performance** - Efficient algorithms for large schemas
- 🛠️ **CLI & Python API & Sphinx Extension** - Use programmatically or from command line or in `.rst`
- 🔧 **Highly Configurable** - Customize behavior for your needs
<div align="center">
## 🚀 Quick Start
</div>
### Installation
```bash
# Standard installation
pip install jsonschema-diff
```
### 30-Second Example
```python
from jsonschema_diff import JsonSchemaDiff, ConfigMaker
from jsonschema_diff.color import HighlighterPipeline
from jsonschema_diff.color.stages import (
MonoLinesHighlighter, ReplaceGenericHighlighter, PathHighlighter
)
prop = JsonSchemaDiff(
config=ConfigMaker.make(),
colorize_pipeline=HighlighterPipeline([
MonoLinesHighlighter(),
ReplaceGenericHighlighter(),
PathHighlighter(),
])
)
prop.compare(
old_schema="context.old.schema.json",
new_schema="context.new.schema.json"
)
prop.print(with_legend=True)
```
**Output:**
### CLI Usage
```bash
# Compare schema files
jsonschema-diff schema_v1.json schema_v2.json
# No colors (for logs/CI) and with exit-code
jsonschema-diff --no-color --exit-code schema_v1.json schema_v2.json
# Compare JSON strings
jsonschema-diff "{\"type\":\"string\"}" "{\"type\":\"number\"}"
```
### Sphinx Extension
Use the extension in your build:
```python
extensions += ["jsonschema_diff.sphinx"]
```
You must also configure the extension. Add the following variable to your `conf.py`:
```python
from jsonschema_diff import ConfigMaker, JsonSchemaDiff
from jsonschema_diff.color import HighlighterPipeline
from jsonschema_diff.color.stages import (
MonoLinesHighlighter, PathHighlighter, ReplaceGenericHighlighter,
)
jsonschema_diff = JsonSchemaDiff(
config=ConfigMaker.make(),
colorize_pipeline=HighlighterPipeline(
[MonoLinesHighlighter(), ReplaceGenericHighlighter(), PathHighlighter()],
),
)
```
After that, you can use it in your `.rst` files:
```rst
.. jsonschemadiff:: path/to/file.old.schema.json path/to/file.new.schema.json # from folder `source`
:name: filename.svg # optional
:title: Title in virtual terminal # optional
:no-legend: # optional
```
<div align="center">
## 📊 Output Format
| Symbol | Meaning | Color | Example |
|--------|---------|-------|---------|
| `+` | Added | 🟢 Green | `+ ["new_field"].field: "string"` |
| `-` | Removed | 🔴 Red | `- ["old_field"].field: "string"` |
| `r` | Changed | 🔵 Cyan | `r ["field"].field: "old" -> "new"` |
| `m` | Modified | 🔵 Cyan | `m ["field"]: ...` |
| ` ` | Context | ⚪ None | ` ["related"]: "unchanged"` |
## 🏗️ Architecture
</div>
Modern 6-stage pipeline for clean, testable code:
```
┌─────────────┐ ┌───────────────┐ ┌──────────────────┐
│ DiffFinder │───▶│ CompareFinder │───▶│ CombineProcessor │
└─────────────┘ └───────────────┘ └──────────────────┘
▼
┌─────────────┐ ┌───────────────┐ ┌───────────────┐
│ Formatter │◀───│RenderProcessor│◀─────│ DiffProcessor │
└─────────────┘ └───────────────┘ └───────────────┘
```
1. **DiffFinder**: Finds raw differences
2. **CompareProcessor**: Find class-processors
3. **Combiner**: Combines related parameters
4. **RenderProcessor**: Adds context information and render
5. **Formatter**: Beautiful colored output
<div align="center">
## 🛠️ Development
</div>
### Setup
```bash
git clone https://github.com/Miskler/jsonschema-diff.git
cd jsonschema-diff
python -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
make build
make install-dev
```
### Commands
```bash
# Checks
make test # Run tests with coverage
make lint # Lint code
make type-check # Type checking
# Action
make format # Format code
make docs # Build documentation
```
<div align="center">
## 📚 Documentation
</div>
- **[📖 Full Documentation](https://miskler.github.io/jsonschema-diff/)**
- **[🚀 Quick Start Guide](https://miskler.github.io/jsonschema-diff/basic/quick_start/)**
- **[🔧 API Reference](https://miskler.github.io/jsonschema-diff/reference/api/index.html)**
<div align="center">
## 🤝 Contributing
### ***We welcome contributions!***
### Quick Contribution Setup
</div>
```bash
# Fork the repo, then:
git clone https://github.com/your-username/jsonschema-diff.git
cd jsonschema-diff
# Install
make build
make install-dev
# Ensure everything works
make test
make lint
make type-check
```
<div align="center">
## 📄 License
MIT License - see [LICENSE](LICENSE) file for details.
*Made with ❤️ for developers working with evolving JSON schemas*
</div>
Raw data
{
"_id": null,
"home_page": null,
"name": "jsonschema-diff",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "json, schema, diff, comparison",
"author": null,
"author_email": "Miskler <mail@miskler.ru>",
"download_url": "https://files.pythonhosted.org/packages/2a/04/cd0766c33d91623664be4966f865545142ec11ad0009b3f56e0ab2aecaad/jsonschema_diff-0.1.1.tar.gz",
"platform": null,
"description": "\n<div align=\"center\">\n\n# \ud83d\udd0d JSON Schema Diff\n\n<img src=\"./assets/logo.webp\" width=\"70%\" alt=\"example_working.svg\" />\n\n*A powerful, intelligent library for comparing JSON schemas with **beautiful formatted output**, **smart parameter combination**, and **contextual information**.*\n\n[](https://miskler.github.io/jsonschema-diff/tests/tests-report.html)\n[](https://miskler.github.io/jsonschema-diff/coverage/)\n[](https://python.org)\n[](https://pypi.org/project/jsonschema-diff/)\n[](LICENSE)\n[](https://github.com/psf/black)\n[](https://mypy.readthedocs.io/en/stable/index.html)\n[](https://discord.gg/UnJnGHNbBp)\n[](https://t.me/miskler_dev)\n\n\n**[\u2b50 Star us on GitHub](https://github.com/Miskler/jsonschema-diff)** | **[\ud83d\udcda Read the Docs](https://miskler.github.io/jsonschema-diff/basic/quick_start/)** | **[\ud83d\udc1b Report Bug](https://github.com/Miskler/jsonschema-diff/issues)**\n\n## \u2728 Features\n\n</div>\n\n- \ud83c\udfaf **Intelligent Comparison** - Detects and categorizes all types of schema changes\n- \ud83c\udfa8 **Beautiful Output** - Colored, formatted differences with clear symbols \n- \ud83d\udd17 **Smart Combination** - Combines related parameters *(e.g., `minimum` + `maximum` = `range`)*\n- \ud83d\udccd **Context Aware** - Shows related fields for better understanding *(e.g., `type` + `format`)*\n- \u26a1 **High Performance** - Efficient algorithms for large schemas\n- \ud83d\udee0\ufe0f **CLI & Python API & Sphinx Extension** - Use programmatically or from command line or in `.rst`\n- \ud83d\udd27 **Highly Configurable** - Customize behavior for your needs\n\n<div align=\"center\">\n\n## \ud83d\ude80 Quick Start\n\n</div>\n\n### Installation\n\n```bash\n# Standard installation\npip install jsonschema-diff\n```\n\n### 30-Second Example\n\n```python\nfrom jsonschema_diff import JsonSchemaDiff, ConfigMaker\nfrom jsonschema_diff.color import HighlighterPipeline\nfrom jsonschema_diff.color.stages import (\n MonoLinesHighlighter, ReplaceGenericHighlighter, PathHighlighter\n)\n\nprop = JsonSchemaDiff(\n config=ConfigMaker.make(),\n colorize_pipeline=HighlighterPipeline([\n MonoLinesHighlighter(),\n ReplaceGenericHighlighter(),\n PathHighlighter(),\n ])\n)\n\nprop.compare(\n old_schema=\"context.old.schema.json\",\n new_schema=\"context.new.schema.json\"\n)\n\nprop.print(with_legend=True)\n```\n\n**Output:**\n\n\n\n### CLI Usage\n\n```bash\n# Compare schema files\njsonschema-diff schema_v1.json schema_v2.json\n\n# No colors (for logs/CI) and with exit-code\njsonschema-diff --no-color --exit-code schema_v1.json schema_v2.json\n\n# Compare JSON strings\njsonschema-diff \"{\\\"type\\\":\\\"string\\\"}\" \"{\\\"type\\\":\\\"number\\\"}\"\n```\n\n\n### Sphinx Extension\n\nUse the extension in your build:\n\n```python\nextensions += [\"jsonschema_diff.sphinx\"]\n```\n\nYou must also configure the extension. Add the following variable to your `conf.py`:\n\n```python\nfrom jsonschema_diff import ConfigMaker, JsonSchemaDiff\nfrom jsonschema_diff.color import HighlighterPipeline\nfrom jsonschema_diff.color.stages import (\n MonoLinesHighlighter, PathHighlighter, ReplaceGenericHighlighter,\n)\n\njsonschema_diff = JsonSchemaDiff(\n config=ConfigMaker.make(),\n colorize_pipeline=HighlighterPipeline(\n [MonoLinesHighlighter(), ReplaceGenericHighlighter(), PathHighlighter()],\n ),\n)\n```\n\nAfter that, you can use it in your `.rst` files:\n\n```rst\n.. jsonschemadiff:: path/to/file.old.schema.json path/to/file.new.schema.json # from folder `source`\n :name: filename.svg # optional\n :title: Title in virtual terminal # optional\n :no-legend: # optional\n```\n\n\n<div align=\"center\">\n\n## \ud83d\udcca Output Format\n\n| Symbol | Meaning | Color | Example |\n|--------|---------|-------|---------|\n| `+` | Added | \ud83d\udfe2 Green | `+ [\"new_field\"].field: \"string\"` |\n| `-` | Removed | \ud83d\udd34 Red | `- [\"old_field\"].field: \"string\"` |\n| `r` | Changed | \ud83d\udd35 Cyan | `r [\"field\"].field: \"old\" -> \"new\"` |\n| `m` | Modified | \ud83d\udd35 Cyan | `m [\"field\"]: ...` |\n| ` ` | Context | \u26aa None | ` [\"related\"]: \"unchanged\"` |\n\n## \ud83c\udfd7\ufe0f Architecture\n\n</div>\n\nModern 6-stage pipeline for clean, testable code:\n\n```\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 DiffFinder \u2502\u2500\u2500\u2500\u25b6\u2502 CompareFinder \u2502\u2500\u2500\u2500\u25b6\u2502 CombineProcessor \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n \u25bc\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Formatter \u2502\u25c0\u2500\u2500\u2500\u2502RenderProcessor\u2502\u25c0\u2500\u2500\u2500\u2500\u2500\u2502 DiffProcessor \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n```\n\n1. **DiffFinder**: Finds raw differences\n2. **CompareProcessor**: Find class-processors\n3. **Combiner**: Combines related parameters\n4. **RenderProcessor**: Adds context information and render\n5. **Formatter**: Beautiful colored output\n\n<div align=\"center\">\n\n## \ud83d\udee0\ufe0f Development\n\n</div>\n\n### Setup\n\n```bash\ngit clone https://github.com/Miskler/jsonschema-diff.git\ncd jsonschema-diff\npython -m venv .venv\nsource .venv/bin/activate # On Windows: .venv\\Scripts\\activate\nmake build\nmake install-dev\n```\n\n### Commands\n\n```bash\n# Checks\nmake test # Run tests with coverage\nmake lint # Lint code\nmake type-check # Type checking \n# Action\nmake format # Format code\nmake docs # Build documentation\n```\n\n<div align=\"center\">\n\n## \ud83d\udcda Documentation\n\n</div>\n\n- **[\ud83d\udcd6 Full Documentation](https://miskler.github.io/jsonschema-diff/)**\n- **[\ud83d\ude80 Quick Start Guide](https://miskler.github.io/jsonschema-diff/basic/quick_start/)**\n- **[\ud83d\udd27 API Reference](https://miskler.github.io/jsonschema-diff/reference/api/index.html)**\n\n<div align=\"center\">\n\n## \ud83e\udd1d Contributing\n\n### ***We welcome contributions!***\n\n### Quick Contribution Setup\n\n</div>\n\n```bash\n# Fork the repo, then:\ngit clone https://github.com/your-username/jsonschema-diff.git\ncd jsonschema-diff\n# Install\nmake build\nmake install-dev\n# Ensure everything works\nmake test\nmake lint\nmake type-check\n```\n\n<div align=\"center\">\n\n## \ud83d\udcc4 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n*Made with \u2764\ufe0f for developers working with evolving JSON schemas*\n\n</div>\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Miskler\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "A library for comparing JSON schemas and displaying differences",
"version": "0.1.1",
"project_urls": {
"Documentation": "https://miskler.github.io/jsonschema-diff/basic/quick_start/index.html",
"Homepage": "https://github.com/Miskler/jsonschema-diff",
"Issues": "https://github.com/Miskler/jsonschema-diff/issues",
"Repository": "https://github.com/yourusername/jsonschema-diff"
},
"split_keywords": [
"json",
" schema",
" diff",
" comparison"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b710a28f9b719f26056791f9508ace17459117c086f1e37cfdc235a9357c3168",
"md5": "3521a1fa6804a283fb8b50c27b6c0c2f",
"sha256": "921004ddc4c4e85fa80dc69012ecc3de2d354328039c03b627fb2a0cc3833f1f"
},
"downloads": -1,
"filename": "jsonschema_diff-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3521a1fa6804a283fb8b50c27b6c0c2f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 44619,
"upload_time": "2025-08-25T01:55:52",
"upload_time_iso_8601": "2025-08-25T01:55:52.482927Z",
"url": "https://files.pythonhosted.org/packages/b7/10/a28f9b719f26056791f9508ace17459117c086f1e37cfdc235a9357c3168/jsonschema_diff-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2a04cd0766c33d91623664be4966f865545142ec11ad0009b3f56e0ab2aecaad",
"md5": "91ccba29712d02c1bfbf77eaf7c29698",
"sha256": "2db9bd410d9739fe37995797ffff104445879718f29b842320a337c19b70f42f"
},
"downloads": -1,
"filename": "jsonschema_diff-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "91ccba29712d02c1bfbf77eaf7c29698",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 38344,
"upload_time": "2025-08-25T01:55:54",
"upload_time_iso_8601": "2025-08-25T01:55:54.080599Z",
"url": "https://files.pythonhosted.org/packages/2a/04/cd0766c33d91623664be4966f865545142ec11ad0009b3f56e0ab2aecaad/jsonschema_diff-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-25 01:55:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Miskler",
"github_project": "jsonschema-diff",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "rich",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "black",
"specs": []
},
{
"name": "isort",
"specs": []
},
{
"name": "mypy",
"specs": []
},
{
"name": "flake8",
"specs": []
},
{
"name": "pytest-xdist",
"specs": []
},
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinx-autoapi",
"specs": []
},
{
"name": "furo",
"specs": []
},
{
"name": "docutils",
"specs": []
},
{
"name": "types-docutils",
"specs": []
}
],
"lcname": "jsonschema-diff"
}
