jsonschema-diff 0.1.0__tar.gz

jsonschema_diff-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+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.

jsonschema_diff-0.1.0/PKG-INFO

@@ -0,0 +1,292 @@
+Metadata-Version: 2.4
+Name: jsonschema-diff
+Version: 0.1.0
+Summary: A library for comparing JSON schemas and displaying differences
+Author-email: Miskler <mail@miskler.ru>
+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.
+        
+Project-URL: Homepage, https://github.com/Miskler/jsonschema-diff
+Project-URL: Repository, https://github.com/yourusername/jsonschema-diff
+Project-URL: Documentation, https://miskler.github.io/jsonschema-diff/basic/quick_start/index.html
+Project-URL: Issues, https://github.com/Miskler/jsonschema-diff/issues
+Keywords: json,schema,diff,comparison
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rich
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-autoapi; extra == "dev"
+Requires-Dist: furo; extra == "dev"
+Requires-Dist: docutils; extra == "dev"
+Requires-Dist: types-docutils; extra == "dev"
+Dynamic: license-file
+
+
+<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**.*
+
+[![Tests](https://miskler.github.io/jsonschema-diff/tests-badge.svg)](https://miskler.github.io/jsonschema-diff/tests/tests-report.html)
+[![Coverage](https://miskler.github.io/jsonschema-diff/coverage.svg)](https://miskler.github.io/jsonschema-diff/coverage/)
+[![Python](https://img.shields.io/badge/python-3.10+-blue)](https://python.org)
+[![PyPI - Package Version](https://img.shields.io/pypi/v/jsonschema-diff?color=blue)](https://pypi.org/project/jsonschema-diff/)
+[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+[![BlackCode](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
+[![Discord](https://img.shields.io/discord/792572437292253224?label=Discord&labelColor=%232c2f33&color=%237289da)](https://discord.gg/UnJnGHNbBp)
+[![Telegram](https://img.shields.io/badge/Telegram-24A1DE)](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:**
+![example_working.svg](./assets/example_working.svg)
+
+
+### 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>

jsonschema_diff-0.1.0/README.md

@@ -0,0 +1,230 @@
+
+<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**.*
+
+[![Tests](https://miskler.github.io/jsonschema-diff/tests-badge.svg)](https://miskler.github.io/jsonschema-diff/tests/tests-report.html)
+[![Coverage](https://miskler.github.io/jsonschema-diff/coverage.svg)](https://miskler.github.io/jsonschema-diff/coverage/)
+[![Python](https://img.shields.io/badge/python-3.10+-blue)](https://python.org)
+[![PyPI - Package Version](https://img.shields.io/pypi/v/jsonschema-diff?color=blue)](https://pypi.org/project/jsonschema-diff/)
+[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
+[![BlackCode](https://img.shields.io/badge/code%20style-black-black)](https://github.com/psf/black)
+[![Discord](https://img.shields.io/discord/792572437292253224?label=Discord&labelColor=%232c2f33&color=%237289da)](https://discord.gg/UnJnGHNbBp)
+[![Telegram](https://img.shields.io/badge/Telegram-24A1DE)](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:**
+![example_working.svg](./assets/example_working.svg)
+
+
+### 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>

jsonschema_diff-0.1.0/jsonschema_diff/__init__.py

@@ -0,0 +1,17 @@
+from importlib import import_module
+from types import ModuleType
+
+from .config_maker import ConfigMaker
+from .pypi_interface import JsonSchemaDiff
+
+
+# Lazy-import подмодуля sphinx (тянет Rich → Sphinx только по требованию)
+def __getattr__(name: str) -> ModuleType:  # pragma: no cover
+    if name == "sphinx":
+        return import_module("jsonschema_diff.sphinx")
+    raise AttributeError(name)
+
+
+__all__ = ["JsonSchemaDiff", "ConfigMaker"]
+
+__version__ = "0.1.0"