Metadata-Version: 2.4
Name: dojson
Version: 1.6.0
Summary: DoJSON is a simple Pythonic JSON to JSON converter.
Home-page: http://github.com/inveniosoftware/dojson/
Author: Invenio collaboration
Author-email: info@inveniosoftware.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 :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Development Status :: 4 - Beta
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: click>=8.1
Requires-Dist: lxml>=4.1.1
Requires-Dist: simplejson>=3.8.1
Provides-Extra: docs
Requires-Dist: Sphinx>=3; extra == "docs"
Provides-Extra: jsonschema
Requires-Dist: jsonschema>=2.5.1; extra == "jsonschema"
Provides-Extra: tests
Requires-Dist: importlib_metadata>=8.0.0; extra == "tests"
Requires-Dist: jsonschema>=3.0; extra == "tests"
Requires-Dist: mock>=1.3.0; extra == "tests"
Requires-Dist: pytest-invenio>=1.4.0; extra == "tests"
Provides-Extra: all
Requires-Dist: Sphinx>=3; extra == "all"
Requires-Dist: jsonschema>=2.5.1; extra == "all"
Requires-Dist: importlib_metadata>=8.0.0; extra == "all"
Requires-Dist: jsonschema>=3.0; extra == "all"
Requires-Dist: mock>=1.3.0; extra == "all"
Requires-Dist: pytest-invenio>=1.4.0; extra == "all"
Requires-Dist: Sphinx>=3; extra == "all"
Requires-Dist: jsonschema>=2.5.1; extra == "all"
Requires-Dist: importlib_metadata>=8.0.0; extra == "all"
Requires-Dist: jsonschema>=3.0; extra == "all"
Requires-Dist: mock>=1.3.0; extra == "all"
Requires-Dist: pytest-invenio>=1.4.0; extra == "all"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

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

.. image:: https://github.com/inveniosoftware/dojson/workflows/CI/badge.svg
        :target: https://github.com/inveniosoftware/dojson/actions

.. 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://dojson.readthedocs.io/ 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'))]
