Metadata-Version: 1.2
Name: omdata
Version: 0.1.5
Summary: A JSON schema editor and validator for OpenMaker survey data.
Home-page: http://github.com/bulentozel/omdata
Author: Bulent Ozel
Author-email: bulent.ozel@gmail.com
License: Apache2
Description: 
        OpenMaker Community Data Standardization
        ========================================
        
        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
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: bash
        
            pip install omdata
        
        Via its GitHub source
        ~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: bash
        
            git clone https://github.com/bulentozel/omdata.git
        
        .. code:: bash
        
            cd omdata
        
        .. code:: bash
        
            pip install .
        
        Usage
        -----
        
        Command line tools
        ~~~~~~~~~~~~~~~~~~
        
        Validating a json file against its schema:
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        .. code:: bash
        
            om-json validate -q <jsonfile> -s <schemafile>
        
        Inspecting top level major fields/dictionary entries of the data file:
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        .. code:: bash
        
            om-schema inspect fields-top -s <schemafile> 
        
        Listing all -including the nested ones- fields of an expected data file:
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        .. code:: bash
        
            om-schema inspect fields-all -s <schemafile> 
        
        Listing all required fields of a json file to be generated:
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        .. code:: bash
        
            om-schema inspect fields-required -s <schemafile> 
        
        Querying description of each fields:
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        .. code:: bash
        
            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
        ~~~~~~~~~~~~~~~~~~~~~
        
        .. code:: python
        
            >>> import omdata
        
        For the details see the `Jupyter Notebook Tutorial <https://github.com/bulentozel/omdata/blob/master/tutorial.ipynb>`__
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        
        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://openmaker.eu/ |
        +--------------------------------------------------------------+
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=2.7.0
