jsonstat-validator 0.1.0__py3-none-any.whl

jsonstat_validator-0.1.0.dist-info/METADATA

@@ -0,0 +1,196 @@
+Metadata-Version: 2.2
+Name: jsonstat-validator
+Version: 0.1.0
+Summary: A Python validator for the JSON-stat 2.0 standard format, based on Pydantic.
+Home-page: https://github.com/ahmed-hassan19/jsonstat-validator
+Author: Ahmed Hassan
+Author-email: Ahmed Hassan <ahmedhassan.ahmed@fao.org>
+License: # MIT License
+        
+        Copyright (c) 2025 JSON-stat Validator Contributors
+        
+        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/ahmed-hassan19/jsonstat-validator
+Project-URL: Bug Tracker, https://github.com/ahmed-hassan19/jsonstat-validator/issues
+Project-URL: Documentation, https://github.com/ahmed-hassan19/jsonstat-validator#readme
+Keywords: json-stat,validator,json,data-engineering,pydantic,python,fao
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.1.1; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: requires-python
+
+# JSON-stat Validator
+
+[![PyPI version](https://badge.fury.io/py/jsonstat-validator.svg)](https://badge.fury.io/py/jsonstat-validator)
+[![Python Version](https://img.shields.io/pypi/pyversions/jsonstat-validator.svg)](https://pypi.org/project/jsonstat-validator/)
+[![License](https://img.shields.io/github/license/ahmed-hassan19/jsonstat-validator.svg)](https://github.com/ahmed-hassan19/jsonstat-validator/blob/main/LICENSE)
+
+A Python validator for the JSON-stat 2.0 standard format, based on Pydantic.
+
+JSON-stat is a simple lightweight format for data interchange. It is a JSON format for data dissemination that allows the representation of statistical data in a way that is both simple and convenient for data processing. With this validator, you can ensure your data conforms to the official [JSON-stat 2.0 specification](https://json-stat.org/full/).
+
+## Installation
+
+```bash
+pip install jsonstat-validator
+```
+
+## Usage
+
+### Basic Validation
+
+```python
+import json
+from jsonstat_validator import validate_jsonstat
+
+# Load your JSON-stat data
+with open("data.json", "r") as f:
+    data = json.load(f)
+
+# Validate the data
+try:
+    result = validate_jsonstat(data)
+    print("Validation successful!")
+except ValueError as e:
+    print(f"Validation failed: {e}")
+```
+
+### Example JSON-stat Dataset
+
+Here's a simplified example of a JSON-stat dataset representing unemployment data:
+
+```json
+{
+  "version": "2.0",
+  "class": "dataset",
+  "label": "Unemployment rate sample",
+  "source": "Sample data",
+  "updated": "2023-01-15",
+  "id": ["indicator", "area", "year"],
+  "size": [1, 3, 2],
+  "value": [5.8, 6.2, 7.1, 7.5, 4.2, 4.9],
+  "role": {
+    "time": ["year"],
+    "geo": ["area"],
+    "metric": ["indicator"]
+  },
+  "dimension": {
+    "indicator": {
+      "label": "Economic indicator",
+      "category": {
+        "label": {
+          "UNR": "unemployment rate"
+        },
+        "unit": {
+          "UNR": {
+            "symbol": "%",
+            "decimals": 1
+          }
+        }
+      }
+    },
+    "year": {
+      "label": "Year",
+      "category": {
+        "index": ["2020", "2021"]
+      }
+    },
+    "area": {
+      "label": "Country",
+      "category": {
+        "index": ["US", "JP", "EU"],
+        "label": {
+          "US": "United States",
+          "JP": "Japan",
+          "EU": "European Union"
+        }
+      }
+    }
+  }
+}
+```
+
+## Features
+
+- Validates JSON-stat data against the [full 2.0 specification](https://json-stat.org/full).
+- Provides models for all major JSON-stat responses: **Dataset**, **Dimension**, **Collection**.
+- Built on Pydantic for robust type validation and error messages.
+- Provides tests against the [official JSON-stat samples](https://json-stat.org/samples/collection.json) as well as custom fine-grained tests.
+
+## Testing
+
+The validator has been thoroughly tested with all official JSON-stat samples from the [JSON-stat website](https://json-stat.org/samples/).
+
+To run tests:
+
+First, install the development dependencies:
+
+```bash
+pip install jsonstat-validator[dev]
+```
+
+Then run the tests:
+
+```bash
+pytest
+```
+
+To run a specific test file (e.g. test official samples only):
+
+```bash
+pytest tests/test_official_samples.py
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/new-feature`)
+3. Commit your changes (`git commit -m 'Add some new feature'`)
+4. Push to the branch (`git push origin feature/new-feature`)
+5. Open a Pull Request
+
+## Credits
+
+This package is maintained by Ahmed Hassan ([@ahmed-hassan19](https://github.com/ahmed-hassan19)) and was created for use at the Food and Agriculture Organization (FAO) of the United Nations.
+
+The JSON-stat format was created by [Xavier Badosa](https://www.linkedin.com/in/badosa).

jsonstat_validator-0.1.0.dist-info/RECORD

@@ -0,0 +1,51 @@
+jsonstat_validator/__init__.py,sha256=wAFP3mKN6XwAPNRygWr_pSHDdKJ6F4Y7sp8sl1C1zuw,691
+jsonstat_validator/validator.py,sha256=i5g57AkanmTMu-B4pUfeuVlXbj3OAdBwGpyFvo3S0Ek,22107
+jsonstat_validator/tests/__init__.py,sha256=5w3FOHjkruZRg3oUSCmYHNKHTmESy3wFPynq05XLb_s,44
+jsonstat_validator/tests/conftest.py,sha256=2UZL2pdcbM1iO2Uv837HPr6csDpIkhbnH_3v5aDDhW0,249
+jsonstat_validator/tests/custom_tests.py,sha256=lJbhOipLEwPJdVHLVg-dTl4Q2cQK9Lkfs2us33qUfo8,14477
+jsonstat_validator/tests/test_official_samples.py,sha256=yRXVqETmVUYNib-nf0odgShbo0Pq5YY4JJCj35KGzf0,1658
+jsonstat_validator/tests/samples/canada.json,sha256=a6eMhLAA6HykWO2t11l5tpz0i6v2zN6izmvpcQbHGrY,3105
+jsonstat_validator/tests/samples/galicia.json,sha256=W6ymWRax14yxAK_778A9kIWXdVV_6R5VLUJH4pv_AZI,22102
+jsonstat_validator/tests/samples/hierarchy.json,sha256=NxvVVWmM5TBBeEdHUkmorh-PoN5D82-m3IIFXJO5UH8,8881
+jsonstat_validator/tests/samples/index.json,sha256=0DjvjTpS8D0IDW8oyHsk3E5hRucnubekAMSflR_Lgyw,893
+jsonstat_validator/tests/samples/oecd.json,sha256=3aRoESyTT4xJQDMljgvF6RXKWCmnirl0_7nNFTT2TPM,10917
+jsonstat_validator/tests/samples/order.json,sha256=2mlvBudHeTiEUHqjPkoO4ZO7ztbwxZ7HiO_YJ1Br-8E,851
+jsonstat_validator/tests/samples/us-gsp.json,sha256=L427DYaM9wq633nQ-ul32NNyPzQ3tBMIKQ_8FJTpojM,4808
+jsonstat_validator/tests/samples/us-labor.json,sha256=lVhVpNQj9E90uLDukxe6cVI1IQRZKtewRAT1gPGK0rg,245081
+jsonstat_validator/tests/samples/us-unr.json,sha256=uz0uwa4a1WwxzJgQCAe3Uh29nYuyN2agLF76UX4Vyzk,77734
+jsonstat_validator/tests/samples/areas/canada.json,sha256=7wU11arz_dvX-_svc4B3haC-b1cc7sum69fovxu0aZw,363
+jsonstat_validator/tests/samples/areas/galicia.json,sha256=0Fi3gCcp9HKbQd-kqhbZXg8OZ8eUByZRs3swmQJ3rQ0,405
+jsonstat_validator/tests/samples/areas/index.json,sha256=OnXC6nJodtgIY23dNN4PEgL340t4YAnABcF_gZelGI0,745
+jsonstat_validator/tests/samples/areas/oecd.json,sha256=eUGD5KjgNvbIJdyg4S7LJSUZehUKIcmfE7DM0fLZO1k,366
+jsonstat_validator/tests/samples/areas/us.json,sha256=5voj9CXI91w0CM2zIzfJNEXBmhaxupRZcQrLUzptdWU,682
+jsonstat_validator/tests/samples/datasets/index.json,sha256=upGVvsV0VvBV0UM0DyUvxUUwOG4DBBnvR2kb6KYqaS4,1525
+jsonstat_validator/tests/samples/metrics/index.json,sha256=33CQfmS-f6pzvNqgBpRI4daCGu8L6GCJ-A4jcQSuYq0,684
+jsonstat_validator/tests/samples/metrics/gdp/gsp.json,sha256=SbrOZurhvS-CxraYnVZqN293yQh2I9pAputsM4o25Yo,367
+jsonstat_validator/tests/samples/metrics/gdp/gsppc.json,sha256=HHqqIS4JVOYD7206a9dUUucZbHcRqmgUt_xP0WXlRvk,380
+jsonstat_validator/tests/samples/metrics/gdp/gspw.json,sha256=_P5hzfWmMUg9msznHcYBl-0_0Hg3A3AaRC79Qk7CqJ0,398
+jsonstat_validator/tests/samples/metrics/gdp/index.json,sha256=JXd2_VRpAm8X_Z6twnqFTUplXxtfHQLEFAdys549guM,738
+jsonstat_validator/tests/samples/metrics/lfs/employed.json,sha256=VmngzssIpzuyNAKboH7wf2197i7XxtwaotOcNMAQi-0,380
+jsonstat_validator/tests/samples/metrics/lfs/index.json,sha256=sZ28CZOTEl0Py0Gfe6wiMmBkVxZdeGQq4OchpxprSmE,825
+jsonstat_validator/tests/samples/metrics/lfs/lf.json,sha256=ScaE824vHG6Q7T23IMtCt9NnpJNmcsSt2LGN_b7XBvg,377
+jsonstat_validator/tests/samples/metrics/lfs/unemployed.json,sha256=bVmWBE5-XcuRIzON1M0XMb_GPxBSkR3CbGQ79sMCqI4,384
+jsonstat_validator/tests/samples/metrics/lfs/unr.json,sha256=lUKMphIFxbZlnduyHCt04q8DJKBZen2l2L2fK0qXE58,549
+jsonstat_validator/tests/samples/metrics/pop/index.json,sha256=llnmomRkIZJWiBstp4yUbbmeMRPZjbte4xxfwRIQ_s8,525
+jsonstat_validator/tests/samples/metrics/pop/pop.json,sha256=FIeNapSq3bD4BBLM48IXTEZXvwk03Fsfm4OozQLzpCM,718
+jsonstat_validator/tests/samples/metrics/pop/popw.json,sha256=GB6PlpnkDrfZfJRyF9pyHtst42Oa19NKyqf2hYBXcJs,387
+jsonstat_validator/tests/samples/sources/bls.json,sha256=Am3nXApblwvZ-WNcjOYN3jSvmYxlhFZfvTwcsCtFtTw,557
+jsonstat_validator/tests/samples/sources/ige.json,sha256=x_ARvi4WomJu3848bZkjxEWNH5FrXZaRu_byiELQM_4,430
+jsonstat_validator/tests/samples/sources/index.json,sha256=uk6UmFT9Pzi6tlMt6rEn3OxQWhYkPJnQ3PInzH_gh4c,1101
+jsonstat_validator/tests/samples/sources/jsonstat.json,sha256=vC8j0Hyt445QKqu-tjhdXhrdSj3jqediKh9egaXIOiY,525
+jsonstat_validator/tests/samples/sources/oecd.json,sha256=vryyWeBjwQsBbvCsYmojbRZ5y0zoL9fj2wPLBseUd20,365
+jsonstat_validator/tests/samples/sources/statcan.json,sha256=ocZuRPZCRCxI-Wv0pi3wgXSDOeppoGPW-14rfVbOAlo,379
+jsonstat_validator/tests/samples/sources/wikipedia.json,sha256=Xs3X4Pw_mXvxi8BfzdwKA4qhu_w47wTMU3NMxXLoBY8,359
+jsonstat_validator/tests/samples/topics/accounts.json,sha256=ReLpG62nfWCHWeev-x-tuxb1anFnIW2utXM-bsEsNZ0,364
+jsonstat_validator/tests/samples/topics/demos.json,sha256=SaKOqgnHvy8zOh7FMqtX7emXhapb0iy-pGGbbLQzHVA,522
+jsonstat_validator/tests/samples/topics/index.json,sha256=1fbgaSXbeIypSASDOn6wJcMg77YenDXUY-QTHg4911k,766
+jsonstat_validator/tests/samples/topics/labor.json,sha256=k270tRO9R_FE9VWJtlClDd9vmbaQuk_DK9VJXnxb1E0,695
+jsonstat_validator/tests/samples/topics/population.json,sha256=OfRTyeMvTgM9HrugypUc0jWHrggSt43QpxCTAW--YUE,719
+jsonstat_validator-0.1.0.dist-info/LICENSE,sha256=cyCvx3tHW8u9ZWGkTMrCKaB2ft4RonlMBVOEHDa2tEk,1091
+jsonstat_validator-0.1.0.dist-info/METADATA,sha256=wzIjL1JHCdUtS5YyvQ4pkBsbC_Q8OXW2kCIHb3efvzM,6675
+jsonstat_validator-0.1.0.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+jsonstat_validator-0.1.0.dist-info/top_level.txt,sha256=l6xoMFlWGRRbXMxl4MG-q0FA3In7rYZLBzVF8W7IhdU,19
+jsonstat_validator-0.1.0.dist-info/RECORD,,

jsonstat_validator-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (76.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

jsonstat_validator-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+jsonstat_validator