DoSchema¶
JSON Schema utility functions and commands.
This is an experimental developer preview release.
- Free software: GPLv2 license
- Documentation: https://doschema.readthedocs.io/
User’s Guide¶
This part of the documentation will show you how to get started in using Invenio-Base.
Usage¶
JSON Schema utility functions and commands.
Compatibility Validation¶
It validates compatibility between different JSON schemas versions.
A schema is backward compatible if the fields’ type remain the same in all JSON schemas declaring it and JSON schemas are type consistent within themselves too.
>>> import json
>>> from io import open
>>>
>>> import doschema.validation
>>> from doschema.utils import detect_encoding
>>>
>>> schemas = [
... './examples/jsonschema_for_repetition.json',
... './examples/jsonschema_repetition.json'
... ]
>>>
>>> schema_validator = doschema.validation.JSONSchemaValidator()
>>> for schema in schemas:
... with open(schema, 'rb') as infile:
... byte_file = infile.read()
... encoding = detect_encoding(byte_file)
... string_file = byte_file.decode(encoding)
... json_schema = json.loads(string_file)
... schema_validator.validate(json_schema, schema)
By default the index of “array” “items” are ignored. Thus all the values of an array should have the same type in order to be compatible. This behavior can be disabled by setting “ignore_index = False” in the validator’s constructor.
>>> import json
>>> from io import open
>>>
>>> import doschema.validation
>>> from doschema.utils import detect_encoding
>>>
>>> schemas = [
... './examples/jsonschema_with_index_option.json'
... ]
>>>
>>> schema_validator = doschema.validation.JSONSchemaValidator(
... ignore_index = False
... )
>>> for schema in schemas:
... with open(schema, 'rb') as infile:
... byte_file = infile.read()
... encoding = detect_encoding(byte_file)
... string_file = byte_file.decode(encoding)
... json_schema = json.loads(string_file)
... schema_validator.validate(json_schema, schema)
CLI usage¶
$ doschema validate jsonschema_for_repetition.json \
jsonschema_repetition.json
$ doschema validate jsonschema_with_index_option.json --with_index
API Reference¶
If you are looking for information on a specific function, class or method, this part of the documentation is for you.
Additional Notes¶
Notes on how to contribute, legal information and changes are here for the interested.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/inveniosoftware/doschema/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
DoSchema could always use more documentation, whether as part of the official DoSchema docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/inveniosoftware/doschema/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up invenio for local development.
Fork the invenio repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/doschema.gitInstall your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv doschema $ cd doschema/ $ pip install -e .[all]
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-featureNow you can make your changes locally.
When you’re done making changes, check that your changes pass tests:
$ ./run-tests.shThe tests will provide you with test coverage and also check PEP8 (code style), PEP257 (documentation), flake8 as well as build the Sphinx documentation and run doctests.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -s -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests and must not decrease test coverage.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.
- The pull request should work for Python 2.7, 3.3, 3.4 and 3.5. Check https://travis-ci.com/inveniosoftware/doschema/pull_requests and make sure that the tests pass for all supported Python versions.
License¶
Invenio is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Invenio is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Invenio; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
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.
