omdata 0.1.4

A JSON schema editor and validator for OpenMaker survey data.

It aims data standardization and interoperability between oinsight modules and its third party clients (oinsight is a set of data mining and machine learning functionalities developed under the OpenMaker Project: http://openmaker.eu/ ).

Current functionalities

Current version provides a set of command-line tools as well as a python module * to be able to validate a JSON file against its predesigned schema * to be able to inspect and query the design of a JSON schema

Install

Via Python’s standard distribution channel PyPI

pip install omdata

Via its GitHub source

git clone https://github.com/bulentozel/omdata.git

cd omdata

pip install .

Usage

Command line tools

• Validating a json file against its schema:

  om-json validate -q <jsonfile> -s <schemafile>

Inspecting top level major fields/dictionary entries of the data file:

om-schema inspect fields-top -s <schemafile>

Listing all -including the nested ones- fields of an expected data file:

om-schema inspect fields-all -s <schemafile>

Listing all required fields of a json file to be generated:

om-schema inspect fields-required -s <schemafile>

Querying description of each fields:

om-schema inspect questions -s <schemafile>

In the case of OpenMaker survey data implementation this corresponds to a query to see the mapping between a survey question and the corresponding json entry.

In other applications

>>> import omdata

For the details see the Jupyter Notebook Tutorial

ToDo

• Publishing the Docstring documentation on GitHub pages

• Editing functionalities on a given schema file

• Update test suits for command-line entry points.

Learn more about the OpenMaker project: http://openmake r.eu/.