pytest-jsonschema 1.0.0__tar.gz

pytest_jsonschema-1.0.0/.editorconfig

@@ -0,0 +1,35 @@
+
+# EditorConfig Configuration file, for more details see:
+# https://EditorConfig.org
+# EditorConfig is a convention description, that could be interpreted
+# by multiple editors to enforce common coding conventions for specific
+# file types
+
+# top-most EditorConfig file:
+# Will ignore other EditorConfig files in Home directory or upper tree level.
+root = true
+
+
+[*]  # For All Files
+# Unix-style newlines with a newline ending every file
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+# Set default charset
+charset = utf-8
+# Indent style default
+indent_style = space
+
+[*.{py,cfg,ini}]
+# 4 space indentation
+indent_size = 4
+
+[*.{html,dtml,pt,zpt,xml,zcml,js,json,ts,less,scss,css,sass,yml,yaml}]
+# 2 space indentation
+indent_size = 2
+
+[{Makefile,.gitmodules}]
+# Tab indentation (no size specified, but view as 4 spaces)
+indent_style = tab
+indent_size = unset
+tab_width = unset

pytest_jsonschema-1.0.0/.flake8

@@ -0,0 +1,11 @@
+[flake8]
+doctests = 1
+ignore =
+    # black takes care of line length
+    E501,
+    # black takes care of where to break lines
+    W503,
+    # black takes care of spaces within slicing (list[:])
+    E203,
+    # black takes care of spaces after commas
+    E231,

pytest_jsonschema-1.0.0/.gitignore

@@ -0,0 +1,45 @@
+# python related
+*.egg-info
+*.pyc
+*.pyo
+
+# tools related
+__pycache__/
+.coverage
+.mypy_cache
+.pytest_cache
+.ruff_cache
+/build/
+coverage.xml
+dist/
+docs/_build
+node_modules/
+
+# venv / buildout related
+.eggs/
+.installed.cfg
+.mr.developer.cfg
+.venv/
+bin/
+develop-eggs/
+eggs/
+etc/
+include/
+lib/
+lib64
+parts/
+pyvenv.cfg
+var/
+
+# mxdev
+.installed.txt
+.lock
+/.make-sentinels/
+/*-mxdev.txt
+/instance/
+/reports/
+/sources/
+/venv/
+constraints*.txt
+requirements*.txt
+.coverage*

pytest_jsonschema-1.0.0/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "charliermarsh.ruff",
+        "ms-python.python"
+    ]
+}

pytest_jsonschema-1.0.0/.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+  "flake8.args": ["--config=pyproject.toml"],
+  "ruff.organizeImports": true,
+  "python.terminal.activateEnvironment": true,
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "[markdown]": {
+    "editor.formatOnSave": false
+  }  
+}

pytest_jsonschema-1.0.0/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+<!-- You should *NOT* be adding new change log entries to this file.
+     You should create a file in the news directory instead.
+     For helpful instructions, please see:
+     https://6.docs.plone.org/volto/developer-guidelines/contributing.html#create-a-pull-request
+-->
+
+<!-- towncrier release notes start -->
+
+## 1.0.0 (2025-11-07)
+
+
+### New features:
+
+- Update schemas. @ericof 
+
+
+### Bug fixes:
+
+- The host json.schemastore.org has been changed to www.schemastore.org. @ericof [#8](https://github.com/collective/pytest-jsonschema/issues/8)
+
+## 1.0.0b1 (2025-04-20)
+
+
+### Internal:
+
+- Modernize package, improve mypy support @ericof 
+
+## 1.0.0a2 (2024-03-27)
+
+
+### Bugfix
+
+- Add MANIFEST.in file [@ericof] [#5](https://github.com/collective/pytest-jsonschema/issue/5)
+
+
+### Documentation
+
+- Improve README.md with usage information [@ericof] [#4](https://github.com/collective/pytest-jsonschema/issue/4)
+
+## 1.0.0a1 (2024-03-27)
+
+
+### Feature
+
+- Implement fixture to validate a file against a json schema [@ericof] [#1](https://github.com/collective/pytest-jsonschema/issue/1)
+- Implement fixture to validate a string against a json schema [@ericof] [#2](https://github.com/collective/pytest-jsonschema/issue/2)
+- Implement fixture to validate a data structure against a json schema [@ericof] [#3](https://github.com/collective/pytest-jsonschema/issue/3)

pytest_jsonschema-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2024 Érico Andrei
+
+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.

pytest_jsonschema-1.0.0/Makefile

@@ -0,0 +1,125 @@
+### Defensive settings for make:
+#     https://tech.davis-hansson.com/p/make/
+SHELL:=bash
+.ONESHELL:
+.SHELLFLAGS:=-xeu -o pipefail -O inherit_errexit -c
+.SILENT:
+.DELETE_ON_ERROR:
+MAKEFLAGS+=--warn-undefined-variables
+MAKEFLAGS+=--no-builtin-rules
+
+# We like colors
+# From: https://coderwall.com/p/izxssa/colored-makefile-for-golang-projects
+RED=`tput setaf 1`
+GREEN=`tput setaf 2`
+RESET=`tput sgr0`
+YELLOW=`tput setaf 3`
+
+# Python checks
+UV?=uv
+
+# installed?
+ifeq (, $(shell which $(UV) ))
+  $(error "UV=$(UV) not found in $(PATH)")
+endif
+
+BACKEND_FOLDER=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
+
+VENV_FOLDER=$(BACKEND_FOLDER)/.venv
+BIN_FOLDER=$(VENV_FOLDER)/bin
+
+
+all: build
+
+# Add the following 'help' target to your Makefile
+# And add help text after each target name starting with '\#\#'
+.PHONY: help
+help: ## This help message
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+
+############################################
+# Install
+############################################
+
+$(VENV_FOLDER):  ## Install dependencies
+	@echo "$(GREEN)==> Install environment$(RESET)"
+	@uv sync
+
+.PHONY: sync
+sync: $(VENV_FOLDER) ## Sync project dependencies
+	@echo "$(GREEN)==> Sync project dependencies$(RESET)"
+	@uv sync
+
+.PHONY: install
+install: $(VENV_FOLDER) ## Install Plone and dependencies
+
+.PHONY: clean
+clean: ## Clean installation
+	@echo "$(RED)==> Cleaning environment and build$(RESET)"
+	@rm -rf $(VENV_FOLDER) pyvenv.cfg .installed.cfg .venv .pytest_cache .ruff_cache constraints* requirements*
+
+############################################
+# QA
+############################################
+.PHONY: mypy
+mypy: ## Type checking
+	@echo "$(GREEN)==> Run mypy$(RESET)"
+	@uv run mypy src
+
+.PHONY: lint
+lint: ## Check and fix code base according to Plone standards
+	@echo "$(GREEN)==> Lint codebase$(RESET)"
+	@uvx ruff@latest check --fix --config $(BACKEND_FOLDER)/pyproject.toml
+	@uvx pyroma@latest -d .
+	@uvx check-python-versions@latest .
+	@uvx zpretty@latest --check src
+	@uv run mypy src
+
+.PHONY: format
+format: ## Check and fix code base according to Plone standards
+	@echo "$(GREEN)==> Format codebase$(RESET)"
+	@uvx ruff@latest check --select I --fix --config $(BACKEND_FOLDER)/pyproject.toml
+	@uvx ruff@latest format --config $(BACKEND_FOLDER)/pyproject.toml
+	@uvx zpretty@latest -i src
+
+.PHONY: check
+check: format lint ## Check and fix code base according to Plone standards
+
+############################################
+# Update schemas
+############################################
+.PHONY: update-schemas
+update-schemas: ## Update existing schemas
+	@echo "$(GREEN)==> Update existing schemas$(RESET)"
+	@uv run python src/pytest_jsonschema/utils/update_schema.py
+
+############################################
+# Tests
+############################################
+.PHONY: test
+test: $(VENV_FOLDER) ## run tests
+	@uv run pytest
+
+.PHONY: test-coverage
+test-coverage: $(VENV_FOLDER) ## run tests with coverage
+	@uv run coverage run --source=pytest_jsonschema --module pytest --cov-report term-missing
+	@uv run coverage report --format markdown
+
+############################################
+# Release
+############################################
+.PHONY: changelog
+changelog: ## Release the package to pypi.org
+	@echo "🚀 Display the draft for the changelog"
+	@uv run towncrier --draft
+
+.PHONY: release
+release: ## Release the package to pypi.org
+	@echo "🚀 Release package"
+	@uv run prerelease
+	@uv run release
+	@rm -Rf dist
+	@uv build
+	@uv publish
+	@uv run postrelease

pytest_jsonschema-1.0.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: pytest-jsonschema
+Version: 1.0.0
+Summary: A pytest plugin to perform JSONSchema validations
+Project-URL: Homepage, https://github.com/collective/pytest-jsonschema
+Project-URL: PyPI, https://pypi.org/project/pytest-jsonschema
+Project-URL: Source, https://github.com/collective/pytest-jsonschema
+Project-URL: Tracker, https://github.com/collective/pytest-jsonschema/issues
+Author-email: Érico Andrei <ericof@plone.org>
+Maintainer-email: Érico Andrei <ericof@plone.org>
+License: 
+        The MIT License (MIT)
+        
+        Copyright (c) 2024 Érico Andrei
+        
+        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.
+License-File: LICENSE
+Keywords: pytest,testing
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Requires-Dist: jsonschema
+Requires-Dist: pytest>=6.2.0
+Requires-Dist: ruamel-yaml
+Requires-Dist: tomli==2.0.1; python_version <= '3.11'
+Description-Content-Type: text/markdown
+
+<h1 align="center">pytest-jsonschema</h1>
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![Python Version](https://img.shields.io/pypi/pyversions/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![Wheel](https://img.shields.io/pypi/wheel/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![License](https://img.shields.io/pypi/l/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![Status](https://img.shields.io/pypi/status/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![Tests / QA](https://github.com/collective/pytest-jsonschema/actions/workflows/ci.yml/badge.svg)](https://github.com/collective/pytest-jsonschema/actions/workflows/ci.yml)
+[![Contributors](https://img.shields.io/github/contributors/collective/pytest-jsonschema)](https://github.com/collective/pytest-jsonschema/graphs/contributors)
+[![Stars](https://img.shields.io/github/stars/collective/pytest-jsonschema?style=social)](https://github.com/collective/pytest-jsonschema/stargazers)
+
+</div>
+
+**pytest-jsonschema** is a plugin for [pytest](https://docs.pytest.org) designed to facilitate JSON Schema validations within your test suites. This tool enables you to validate JSON files, strings, and Python objects against predefined JSON Schemas, ensuring your data adheres to expected formats.
+
+## Installation
+
+Install **pytest-jsonschema** using pip / uv from PyPI:
+
+```bash
+pip install pytest-jsonschema
+```
+
+## Features & Usage
+
+The package introduces three pytest fixtures for validating JSON data:
+
+### `schema_validate_file`
+
+Validates a JSON file located in your test suite directory:
+
+```python
+from pathlib import Path
+
+def test_package_json_is_valid(schema_validate_file):
+    path = Path("package.json")
+    assert schema_validate_file(path=path, schema_name="package")
+```
+
+### `schema_validate_string`
+
+Validates a JSON string:
+
+```python
+from pathlib import Path
+
+def test_package_json_is_valid(schema_validate_string):
+    data = Path("package.json").read_text()
+    assert schema_validate_string(data=data, schema_name="package", file_type="json")
+```
+
+### `schema_validate`
+
+Validates a Python dictionary representing JSON data:
+
+```python
+import json
+from pathlib import Path
+
+def test_package_json_is_valid(schema_validate):
+    data = json.loads(Path("package.json").read_text())
+    assert schema_validate(data=data, schema_name="package")
+```
+
+## Requirements
+
+- pytest >= 6.2.0
+
+## Contributing
+
+To contribute to **pytest-jsonschema**, please follow these steps:
+
+1. Clone the repository:
+
+```bash
+git clone git@github.com:collective/pytest-jsonschema.git
+```
+
+2. Install the package for development:
+
+```bash
+make install
+```
+
+3. Format the codebase:
+
+```bash
+make format
+```
+
+4. Run tests:
+- To run all tests:
+  ```bash
+  uv run pytest
+  ```
+- To stop on the first error and open a pdb session:
+  ```
+  uv run pytest -x --pdb
+  ```
+
+Testing is conducted using [`pytest`](https://docs.pytest.org/en/stable/).
+
+## License 📜
+
+**pytest-jsonschema** is licensed under the [MIT License](./LICENSE).

pytest_jsonschema-1.0.0/README.md

@@ -0,0 +1,107 @@
+<h1 align="center">pytest-jsonschema</h1>
+
+<div align="center">
+
+[![PyPI](https://img.shields.io/pypi/v/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![Python Version](https://img.shields.io/pypi/pyversions/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![Wheel](https://img.shields.io/pypi/wheel/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![License](https://img.shields.io/pypi/l/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![Status](https://img.shields.io/pypi/status/pytest-jsonschema)](https://pypi.org/project/pytest-jsonschema/)
+[![Tests / QA](https://github.com/collective/pytest-jsonschema/actions/workflows/ci.yml/badge.svg)](https://github.com/collective/pytest-jsonschema/actions/workflows/ci.yml)
+[![Contributors](https://img.shields.io/github/contributors/collective/pytest-jsonschema)](https://github.com/collective/pytest-jsonschema/graphs/contributors)
+[![Stars](https://img.shields.io/github/stars/collective/pytest-jsonschema?style=social)](https://github.com/collective/pytest-jsonschema/stargazers)
+
+</div>
+
+**pytest-jsonschema** is a plugin for [pytest](https://docs.pytest.org) designed to facilitate JSON Schema validations within your test suites. This tool enables you to validate JSON files, strings, and Python objects against predefined JSON Schemas, ensuring your data adheres to expected formats.
+
+## Installation
+
+Install **pytest-jsonschema** using pip / uv from PyPI:
+
+```bash
+pip install pytest-jsonschema
+```
+
+## Features & Usage
+
+The package introduces three pytest fixtures for validating JSON data:
+
+### `schema_validate_file`
+
+Validates a JSON file located in your test suite directory:
+
+```python
+from pathlib import Path
+
+def test_package_json_is_valid(schema_validate_file):
+    path = Path("package.json")
+    assert schema_validate_file(path=path, schema_name="package")
+```
+
+### `schema_validate_string`
+
+Validates a JSON string:
+
+```python
+from pathlib import Path
+
+def test_package_json_is_valid(schema_validate_string):
+    data = Path("package.json").read_text()
+    assert schema_validate_string(data=data, schema_name="package", file_type="json")
+```
+
+### `schema_validate`
+
+Validates a Python dictionary representing JSON data:
+
+```python
+import json
+from pathlib import Path
+
+def test_package_json_is_valid(schema_validate):
+    data = json.loads(Path("package.json").read_text())
+    assert schema_validate(data=data, schema_name="package")
+```
+
+## Requirements
+
+- pytest >= 6.2.0
+
+## Contributing
+
+To contribute to **pytest-jsonschema**, please follow these steps:
+
+1. Clone the repository:
+
+```bash
+git clone git@github.com:collective/pytest-jsonschema.git
+```
+
+2. Install the package for development:
+
+```bash
+make install
+```
+
+3. Format the codebase:
+
+```bash
+make format
+```
+
+4. Run tests:
+- To run all tests:
+  ```bash
+  uv run pytest
+  ```
+- To stop on the first error and open a pdb session:
+  ```
+  uv run pytest -x --pdb
+  ```
+
+Testing is conducted using [`pytest`](https://docs.pytest.org/en/stable/).
+
+## License 📜
+
+**pytest-jsonschema** is licensed under the [MIT License](./LICENSE).

pytest_jsonschema-1.0.0/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"

pytest_jsonschema-1.0.0/news/.changelog_template.jinja

@@ -0,0 +1,15 @@
+{% if sections[""] %}
+{% for category, val in definitions.items() if category in sections[""] %}
+
+### {{ definitions[category]['name'] }}
+
+{% for text, values in sections[""][category].items() %}
+- {{ text }} {{ values|join(', ') }}
+{% endfor %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+
+
+{% endif %}