DoJSON¶
DoJSON is a simple Pythonic JSON to JSON converter.
Example¶
A simple example on how to convert MARCXML to JSON:
from dojson.contrib.marc21.utils import create_record, split_blob
from dojson.contrib.marc21 import marc21
[marc21.do(create_record(data)) for data in split_blob(open('/tmp/data.xml', 'r').read())]
API¶
DoJSON API.
-
class
dojson.
Overdo
(bases=None, entry_point_group=None)¶ Translation index.
-
build
()¶ Build.
-
do
(blob)¶ Translate blob values and instantiate new model instance.
-
missing
(blob)¶ Return keys with missing rules.
-
over
(name, *source_tags)¶ Register creator rule.
-
Command line interface¶
DoJSON command line interface.
This script is installed using the magic console_script
section in
entry_points
parameters thanks to setuptools
. In order to get help from
console one can run:
$ dojson --help
Extensions
New extensions with loaders, dumpers, or rules can be provided via entry points.
dojson.cli.load
functions expecting a stream and returning Python dict or iterator;dojson.cli.dump
functions expecting a Python object and returningstr
;dojson.cli.rule
instances ofdojson.Overdo
with loaded rules.
-
dojson.cli.
open_entry_point
(group_name)¶ Open entry point.
Contrib¶
Changes¶
Version 0.3.0 (released 2015-11-09):¶
New features¶
- Adds experimental rules for converting human readable JSON into a JSON representation of the MARC21 Format.
- Adds do and missing commands for dojson command line interface (see dojson –help for more information).
Improved features¶
- Adds missing mapping for the first indicator of field 856.
Version 0.2.0 (released 2015-10-07):¶
New features¶
- Adds the posibility to use base DoJSON model so the rules are “inherited” from them.
- Adds new decorator ignore_value that remove the key in the resulting json for None value.
Improved features¶
- Uses entry points instead of plain imports to load the creator rules.
Bug fixes¶
- Removes calls to PluginManager consider_setuptools_entrypoints() removed in PyTest 2.8.0.
Version 0.1.1 (released 2015-07-27):¶
- Sorts and removes duplicated enum values.
- Swaps wrongly defined repeatable and non-repeatable subfields. (#23)
- Addresses issue when allowed indicators where defined as a range. (#22)
Version 0.1.0 (released 2015-07-03):¶
- Initial public release.
Contributing¶
Bug reports, feature requests, and other contributions are welcome. If you find a demonstrable problem that is caused by the code of this library, please:
- Search for already reported problems.
- Check if the issue has been fixed or is still reproducible on the latest master branch.
- Create an issue with a test case.
If you create a feature branch, you can run the tests to ensure everything is operating correctly:
$ python setup.py test
...
====== 31 passed, 23 skipped in 1.37 seconds ======
You can also test your feature branch using Docker:
$ docker-compose build
$ docker-compose run web python setup.py test
$ docker-compose run web python setup.py build_sphinx
$ docker-compose run web pep257 --match-dir='dojson'
Authors¶
DoJSON is developed for the Invenio digital library software.
Contact us at info@invenio-software.org.
Active contributors:
- Jiri Kuncar <jiri.kuncar@cern.ch>
- Esteban J. G. Gabancho <esteban.jose.garcia.gabancho@cern.ch>
- Sami Hiltunen <sami.mikael.hiltunen@cern.ch>
- Tibor Simko <tibor.simko@cern.ch>
License¶
DoJSON is free software; you can redistribute it and/or modify it under the terms of the Revised BSD License quoted below.
Copyright (C) 2015 CERN.
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
- Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction.