Skip to main content
Help us improve Python packaging – donate today!

JSON validation utility

Project Description

Part of the Using JSON Schema project.

jsonvalidate is a command line and library utility allowing JSON content to be validated using JSON Schema content from local or remote sources, and use of custom schema storage and URI access.

The utility uses the jsonschema library for the schema validation processing (GitHub repo).

For command line/script use, a console message is displayed and the process exits with 0 for success, 1 for failure.

https://travis-ci.org/usingjsonschema/ujs-jsonvalidate-python.svg?branch=master

Command Line / Script Use

To run the validation (command line or script), use the validate command with a file name (path optional). For example, to check the file example.json against the schema example_schema.json, use,

validate example.json example_schema.json

Library Function Use

validate (dataFile, schemaFile, refFiles, jsdbFile, callback)

Arguments:
dataFile String File name of JSON data file (path optional)
schemaFile String File name of JSON Schema file (path optional)
refFiles String[] Array of file names for $ref files (path optional)
jsdbFile String File name for JSDB file (path optional)

Returns:
code, data, message

- code is the validation result
- data is the validated JSON content from dataFile
- message is text message associated with the code

For example,

from jsonvalidate import validate, VALID

dataFile = "example.json"
schemaFile = "example_schema.json"
refFiles = ["ref1_schema.json", "ref2_schema.json"]
jsdbFile = None

code, data, message = validate (dataFile, schemaFile, refFiles, jsdbFile)
if code == VALID:
    print ("Valid JSON content");
else:
    print ("Error: " + str (message))

Installation

The program can be installed using pip, with the command,

pip install ujs-jsonvalidate

License

MIT

Release history Release notifications

This version
History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ujs-jsonvalidate-0.1.0.zip (10.7 kB) Copy SHA256 hash SHA256 Source None Jul 12, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page