{"author":"Xavier Barbosa","author_email":"clint.northwood@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Environment :: Console","Environment :: OpenStack","Intended Audience :: Developers","Intended Audience :: Information Technology","License :: OSI Approved :: Apache Software License","License :: OSI Approved :: BSD License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12"],"description":"Json Spec\n=========\n\n.. image:: https://badge.fury.io/py/json-spec.png\n :target: http://badge.fury.io/py/json-spec\n\n.. image:: https://travis-ci.org/johnnoone/json-spec.png?branch=master\n :target: https://travis-ci.org/johnnoone/json-spec\n\nThis library implements several JSON specs, like `JSON Schema`_,\n`JSON Reference`_ and `JSON Pointer`_:\n\n* It works on python 3.6 and above\n* It is release under the `BSD license`_\n\n\nInstallation\n------------\n\nThis library has only weak dependencies. You can simply use pip::\n\n $ pip install json-spec\n\nRegading you needs, you can install more features. For example, this command\nwill enable colorated messages::\n\n $ pip install json-spec[cli]\n\nThis one will enable ip format for json schema::\n\n $ pip install json-spec[ip]\n\n...\n\n\nCLI Usage\n---------\n\nThis module expose a cli command with multiple operations.\n\n**json add** will transform the json document::\n\n $ json add '#/foo/1' --fragment-file=fragment.json --document-json='{\"foo\": [\"bar\", \"baz\"]}'\n $ echo '{\"foo\": [\"bar\", \"baz\"]}' | json add '#/foo/1' --fragment-json='first'\n $ json add '#/foo/1' --fragment-file=fragment.json --document-file=doc.json\n $ json add '#/foo/1' --fragment-file=fragment.json < doc.json\n\n**json check** will test that a value at the target location is equal to a specified value::\n\n $ json check '#/foo/1' --fragment-file=fragment.json --document-json='{\"foo\": [\"bar\", \"baz\"]}'\n $ echo '{\"foo\": [\"bar\", \"baz\"]}' | json check '#/foo/1' --fragment-file=fragment.json\n $ json check '#/foo/1' --fragment-file=fragment.json --document-file=doc.json\n $ json check '#/foo/1' --fragment-file=fragment.json < doc.json\n\n**json copy** will copy the value at a specified location to the target location::\n\n $ json copy '#/foo/1' --target='#/foo/2' --document-json='{\"foo\": [\"bar\", \"baz\"]}'\n $ echo '{\"foo\": [\"bar\", \"baz\"]}' | json copy '#/foo/1' --target='#/foo/2'\n $ json copy '#/foo/1' --target='#/foo/2' --document-file=doc.json\n $ json copy '#/foo/1' --target='#/foo/2' < doc.json\n\n**json extract** will extract parts of your json document::\n\n $ json extract '#/foo/1' --document-json='{\"foo\": [\"bar\", \"baz\"]}'\n $ echo '{\"foo\": [\"bar\", \"baz\"]}' | json extract '#/foo/1'\n $ json extract '#/foo/1' --document-file=doc.json\n $ json extract '#/foo/1' < doc.json\n\n**json move** will remove the value at a specified location and it will add the value to the target location::\n\n $ json move '#/foo/2' --target='#/foo/1' --document-json='{\"foo\": [\"bar\", \"baz\"]}'\n $ echo '{\"foo\": [\"bar\", \"baz\"]}' | json move '#/foo/2' --target='#/foo/1'\n $ json move '#/foo/2' --target='#/foo/1' --document-file=doc.json\n $ json move '#/foo/2' --target='#/foo/1' < doc.json\n\n**json remove** will remove the value at a specified location::\n\n $ json remove '#/foo/1' --document-json='{\"foo\": [\"bar\", \"baz\"]}'\n $ echo '{\"foo\": [\"bar\", \"baz\"]}' | json remove '#/foo/1'\n $ json remove '#/foo/1' --document-file=doc.json\n $ json remove '#/foo/1' < doc.json\n\n**json replace** will replace the value at a specified location with given fragment::\n\n $ json replace '#/foo/1' --fragment-file=fragment.json --document-json='{\"foo\": [\"bar\", \"baz\"]}'\n $ echo '{\"foo\": [\"bar\", \"baz\"]}' | json replace '#/foo/1' --fragment-file=fragment.json\n $ json replace '#/foo/1' --fragment-file=fragment.json --document-file=doc.json\n $ json replace '#/foo/1' --fragment-file=fragment.json < doc.json\n\n**json validate** will validate your document against a schema::\n\n $ json validate --schema-file=schema.json --document-json='{\"foo\": [\"bar\", \"baz\"]}'\n $ echo '{\"foo\": [\"bar\", \"baz\"]}' | json validate --schema-file=schema.json\n $ json validate --schema-file=schema.json --document-file=doc.json\n $ json validate --schema-file=schema.json < doc.json\n\n\nLibrary usage\n-------------\n\nLet say you want to fetch / validate JSON like objects in you python scripts.\n\nYou can extract member of an object with `JSON Pointer`_::\n\n from jsonspec.pointer import extract\n\n obj = {\n 'foo': ['bar', 'baz', 'quux']\n }\n assert 'baz' == extract(obj, '/foo/1')\n\n\nYou can resolve member of any object with `JSON Reference`_::\n\n from jsonspec.reference import resolve\n\n obj = {\n 'foo': ['bar', 'baz', {\n '$ref': '#/sub'\n }],\n 'sub': 'quux'\n }\n\n assert 'quux' == resolve(obj, '#/foo/2')\n\n\nYou can describe you data with `JSON Schema`_::\n\n from jsonspec.validators import load\n\n # data will validate against this schema\n validator = load({\n 'title': 'Example Schema',\n 'type': 'object',\n 'properties': {\n 'age': {\n 'description': 'Age in years',\n 'minimum': 0,\n 'type': 'integer'\n },\n 'firstName': {\n 'type': 'string'\n },\n 'lastName': {\n 'type': 'string'\n }\n },\n 'required': [\n 'firstName',\n 'lastName'\n ]\n })\n\n # validate this data\n validator.validate({\n 'firstName': 'John',\n 'lastName': 'Noone',\n 'age': 33,\n })\n\nOther examples can be found in the documentation_ or in the tests_.\n\n.. _`JSON Schema`: http://json-schema.org\n.. _`JSON Reference`: http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03\n.. _`JSON Pointer`: http://tools.ietf.org/html/rfc6901\n.. _`BSD license`: https://github.com/johnnoone/json-spec/blob/master/LICENSE\n.. _documentation: http://py.errorist.io/json-spec/\n.. _tests: https://github.com/johnnoone/json-spec/tree/master/tests\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://json-spec.readthedocs.org","keywords":"json, utilitaries, validation, json-pointer, json-reference, json-schema","license":"BSD-3-Clause","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"json-spec","package_url":"https://pypi.org/project/json-spec/","platform":null,"project_url":"https://pypi.org/project/json-spec/","project_urls":{"Documentation":"https://json-spec.readthedocs.org","Homepage":"https://json-spec.readthedocs.org","Repository":"https://github.com/johnnoone/json-spec"},"provides_extra":null,"release_url":"https://pypi.org/project/json-spec/0.12.0/","requires_dist":["termcolor; extra == \"cli\"","importlib-metadata>=5.0.0; python_version < \"3.10\""],"requires_python":"<4.0,>=3.10","summary":"Implements JSON Schema, JSON Pointer and JSON Reference.","version":"0.12.0","yanked":false,"yanked_reason":null}

Dependencies of json-spec (2).
Dependency	Optional
importlib-metadata	false
termcolor	true

Package search

json-spec

project_urls

Dependencies

All package metadata

Releases