Metadata-Version: 2.0
Name: dojson
Version: 1.1.0
Summary: DoJSON is a simple Pythonic JSON to JSON converter.
Home-page: http://github.com/inveniosoftware/dojson/
Author: Invenio collaboration
Author-email: info@invenio-software.org
License: BSD
Platform: any
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Development Status :: 1 - Planning
Requires-Dist: click (>=5.0.0)
Requires-Dist: lxml (>=3.4)
Requires-Dist: simplejson (>=3.8.1)
Requires-Dist: six (>=1.7.2)
Provides-Extra: all
Requires-Dist: Sphinx (>=1.3); extra == 'all'
Requires-Dist: Sphinx (>=1.3); extra == 'all'
Requires-Dist: check-manifest (>=0.25); extra == 'all'
Requires-Dist: check-manifest (>=0.25); extra == 'all'
Requires-Dist: coverage (>=4.0); extra == 'all'
Requires-Dist: coverage (>=4.0); extra == 'all'
Requires-Dist: coverage (>=4.0.0); extra == 'all'
Requires-Dist: coverage (>=4.0.0); extra == 'all'
Requires-Dist: isort (>=4.2.2); extra == 'all'
Requires-Dist: isort (>=4.2.2); extra == 'all'
Requires-Dist: jsonschema (>=2.5.1); extra == 'all'
Requires-Dist: jsonschema (>=2.5.1); extra == 'all'
Requires-Dist: mock (>=1.0.0); extra == 'all'
Requires-Dist: mock (>=1.0.0); extra == 'all'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'all'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'all'
Requires-Dist: pytest (>=2.8.0); extra == 'all'
Requires-Dist: pytest (>=2.8.0); extra == 'all'
Requires-Dist: pytest-cache (>=1.0); extra == 'all'
Requires-Dist: pytest-cache (>=1.0); extra == 'all'
Requires-Dist: pytest-cov (>=2.1.0); extra == 'all'
Requires-Dist: pytest-cov (>=2.1.0); extra == 'all'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'all'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'all'
Provides-Extra: docs
Requires-Dist: Sphinx (>=1.3); extra == 'docs'
Provides-Extra: jsonschema
Requires-Dist: jsonschema (>=2.5.1); extra == 'jsonschema'
Provides-Extra: tests
Requires-Dist: check-manifest (>=0.25); extra == 'tests'
Requires-Dist: coverage (>=4.0); extra == 'tests'
Requires-Dist: coverage (>=4.0.0); extra == 'tests'
Requires-Dist: isort (>=4.2.2); extra == 'tests'
Requires-Dist: mock (>=1.0.0); extra == 'tests'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'tests'
Requires-Dist: pytest (>=2.8.0); extra == 'tests'
Requires-Dist: pytest-cache (>=1.0); extra == 'tests'
Requires-Dist: pytest-cov (>=2.1.0); extra == 'tests'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'tests'

========
 DoJSON
========

.. currentmodule:: dojson

.. image:: https://img.shields.io/travis/inveniosoftware/dojson.svg
        :target: https://travis-ci.org/inveniosoftware/dojson

.. image:: https://img.shields.io/coveralls/inveniosoftware/dojson.svg
        :target: https://coveralls.io/r/inveniosoftware/dojson

.. image:: https://img.shields.io/github/tag/inveniosoftware/dojson.svg
        :target: https://github.com/inveniosoftware/dojson/releases

.. image:: https://img.shields.io/pypi/dm/dojson.svg
        :target: https://pypi.python.org/pypi/dojson

.. image:: https://img.shields.io/github/license/inveniosoftware/dojson.svg
        :target: https://github.com/inveniosoftware/dojson/blob/master/LICENSE


About
=====

DoJSON is a simple Pythonic JSON to JSON converter.

Installation
============

DoJSON is on PyPI so all you need is:

.. code-block:: console

    $ pip install dojson

Documentation
=============

Documentation is readable at https://pythonhosted.org/dojson/ or
it can be built using Sphinx:

.. code-block:: console

    $ pip install dojson[docs]
    $ python setup.py build_sphinx

Testing
=======

Running the test suite is as simple as:

.. code-block:: console

    $ python setup.py test

Example
=======

A simple example on how to convert MARCXML to JSON:

.. code:: python

    from dojson.contrib.marc21.utils import create_record, split_stream
    from dojson.contrib.marc21 import marc21
    [marc21.do(create_record(data)) for data in split_stream(open('/tmp/data.xml', 'r'))]


