==========================================
Onixcheck - Book Trade Metadata Validation
==========================================
.. image:: https://readthedocs.org/projects/onixcheck/badge/?style=flat-square
:target: https://readthedocs.org/projects/onixcheck
:alt: Documentation Status
.. image:: http://img.shields.io/travis/titusz/onixcheck/master.svg?style=flat-square&label=Travis
:target: https://travis-ci.org/titusz/onixcheck
:alt: Travis-CI Build Status
.. image:: https://img.shields.io/appveyor/ci/titusz/onixcheck/master.svg?style=flat-square&label=AppVeyor
:target: https://ci.appveyor.com/project/titusz/onixcheck
:alt: AppVeyor Build Status
.. image:: http://img.shields.io/pypi/v/onixcheck.svg?style=flat-square
:target: https://pypi.python.org/pypi/onixcheck
:alt: PyPI Package latest release
.. image:: http://img.shields.io/pypi/dm/onixcheck.svg?style=flat-square
:target: https://pypi.python.org/pypi/onixcheck
:alt: PyPI Package monthly downloads
============
Introduction
============
`ONIX for Books <http://www.editeur.org/11/Books/>`_ is an international XML
standard for the publishing and book trade industry.
``onixcheck`` is a Python library and command line tool for validating ONIX
metadata. It allows you to validate ONIX versions 2.1 and 3.0.8 against the
official XML Schema.
* Free software: BSD license
============
Installation
============
On Windows you can download the standalone binary command line tool:
`onixcheck-0.9.7_win.zip <https://github.com/titusz/onixcheck/releases/download/v0.9.7/onixcheck-0.9.7_win.zip>`_
If you have Python or PyPy installed on your system you can do the usual::
pip install onixcheck
==========
Quickstart
==========
Command line usage examples
---------------------------
Validate all .xml, .onx, .onix files in current directory::
onixcheck
Validate a single onix file::
onixcheck myonixfile.xml
Validate all .xml files in /onixdata and its subdirectories::
onixcheck --path /onixdata --ext xml --recursive
Show help::
onixcheck -h
Using onixcheck as a python lib
-------------------------------
Simple usage with `onixcheck.validate`:
.. code-block:: pycon
>>> import onixcheck
>>> errors = onixcheck.validate('src/onixcheck/data/invalid_onix3_ref.xml')
>>> print(errors[0].short)
ERROR - SCHEMASV - invalid_onix3_ref.xml:4:0 - Element 'SentDateTime': This element is not expected. Expected is ( Sender ).
`errors` is either a list of `Message` objects (INVALID file) or an empty list (VALID file)
=============
Documentation
=============
https://onixcheck.readthedocs.org/
===========
Development
===========
To run the all tests run::
tox
Contributions/suggestions are welcome.
=========
Changelog
=========
0.9.7 (2021-09-29)
------------------
* Update Onix 3 to Revision 8 and Code List issue 54
0.9.6 (2019-05-26)
------------------
* Python 3.6 and 3.7 compatibility
* Update Onix 3 to Revision 6 and Code List issue 45
0.9.5 (2016-08-19)
------------------
* Update Onix 3 to Code List issue 34
* Remove build artifacts from source distribution
0.9.4 (2016-07-15)
------------------
* Fix issue with windows console output encoding
* Update windows build to pyinstaller 3.1
0.9.3 (2016-05-10)
------------------
* Update ONIX 3.0 Schemas to Revision 3
* Add support for RELAX NG and custom schema validations
* Added validator name to short message output
0.9.2 (2016-04-11)
------------------
* Fix ExtentType in custom validation profile
* Fix false alarm with multiple Price elements in custom profile
0.9.1 (2016-04-11)
------------------
* Inital support for custom validation profiles
* Custom Google Play Books onix 3.0 validation profile
0.9.0 (2016-03-27)
------------------
* Added Python 3.5 testing / support
* Update to ONIX to Code List Issue 32 / 2016-01-24
0.8.1 (2015-07-23)
------------------
* More extensive documentation
0.8.0 (2015-07-23)
------------------
* Added CLI-support for fast directory traversal validation
* Secured XML-Parsing via defusedxml
* Catch basic XML syntax errors
* Windows standalone binary builds
0.4.0 (2015-07-18)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/titusz/onixcheck",
"name": "onixcheck",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ONIX",
"author": "Titusz Pan",
"author_email": "tp@py7.de",
"download_url": "https://files.pythonhosted.org/packages/f9/cd/e060a6309eb5a8dd30c65a6bb03a6df6e43e22003fbbb5d3124ffc43401a/onixcheck-0.9.7.tar.gz",
"platform": "",
"description": "==========================================\nOnixcheck - Book Trade Metadata Validation\n==========================================\n\n\n.. image:: https://readthedocs.org/projects/onixcheck/badge/?style=flat-square\n :target: https://readthedocs.org/projects/onixcheck\n :alt: Documentation Status\n\n.. image:: http://img.shields.io/travis/titusz/onixcheck/master.svg?style=flat-square&label=Travis\n :target: https://travis-ci.org/titusz/onixcheck\n :alt: Travis-CI Build Status\n\n\n.. image:: https://img.shields.io/appveyor/ci/titusz/onixcheck/master.svg?style=flat-square&label=AppVeyor\n :target: https://ci.appveyor.com/project/titusz/onixcheck\n :alt: AppVeyor Build Status\n\n\n.. image:: http://img.shields.io/pypi/v/onixcheck.svg?style=flat-square\n :target: https://pypi.python.org/pypi/onixcheck\n :alt: PyPI Package latest release\n\n\n.. image:: http://img.shields.io/pypi/dm/onixcheck.svg?style=flat-square\n :target: https://pypi.python.org/pypi/onixcheck\n :alt: PyPI Package monthly downloads\n\n\n============\nIntroduction\n============\n\n`ONIX for Books <http://www.editeur.org/11/Books/>`_ is an international XML\nstandard for the publishing and book trade industry.\n\n``onixcheck`` is a Python library and command line tool for validating ONIX\nmetadata. It allows you to validate ONIX versions 2.1 and 3.0.8 against the\nofficial XML Schema.\n\n\n* Free software: BSD license\n\n============\nInstallation\n============\n\nOn Windows you can download the standalone binary command line tool:\n`onixcheck-0.9.7_win.zip <https://github.com/titusz/onixcheck/releases/download/v0.9.7/onixcheck-0.9.7_win.zip>`_\n\nIf you have Python or PyPy installed on your system you can do the usual::\n\n pip install onixcheck\n\n\n==========\nQuickstart\n==========\n\nCommand line usage examples\n---------------------------\n\nValidate all .xml, .onx, .onix files in current directory::\n\n onixcheck\n\n\nValidate a single onix file::\n\n onixcheck myonixfile.xml\n\n\nValidate all .xml files in /onixdata and its subdirectories::\n\n onixcheck --path /onixdata --ext xml --recursive\n\n\nShow help::\n\n onixcheck -h\n\n\nUsing onixcheck as a python lib\n-------------------------------\n\nSimple usage with `onixcheck.validate`:\n\n.. code-block:: pycon\n\n >>> import onixcheck\n >>> errors = onixcheck.validate('src/onixcheck/data/invalid_onix3_ref.xml')\n >>> print(errors[0].short)\n ERROR - SCHEMASV - invalid_onix3_ref.xml:4:0 - Element 'SentDateTime': This element is not expected. Expected is ( Sender ).\n\n`errors` is either a list of `Message` objects (INVALID file) or an empty list (VALID file)\n\n=============\nDocumentation\n=============\n\nhttps://onixcheck.readthedocs.org/\n\n===========\nDevelopment\n===========\n\nTo run the all tests run::\n\n tox\n\nContributions/suggestions are welcome.\n\n=========\nChangelog\n=========\n\n0.9.7 (2021-09-29)\n------------------\n* Update Onix 3 to Revision 8 and Code List issue 54\n\n0.9.6 (2019-05-26)\n------------------\n* Python 3.6 and 3.7 compatibility\n* Update Onix 3 to Revision 6 and Code List issue 45\n\n0.9.5 (2016-08-19)\n------------------\n* Update Onix 3 to Code List issue 34\n* Remove build artifacts from source distribution\n\n0.9.4 (2016-07-15)\n------------------\n* Fix issue with windows console output encoding\n* Update windows build to pyinstaller 3.1\n\n0.9.3 (2016-05-10)\n------------------\n* Update ONIX 3.0 Schemas to Revision 3\n* Add support for RELAX NG and custom schema validations\n* Added validator name to short message output\n\n0.9.2 (2016-04-11)\n------------------\n* Fix ExtentType in custom validation profile\n* Fix false alarm with multiple Price elements in custom profile\n\n0.9.1 (2016-04-11)\n------------------\n* Inital support for custom validation profiles\n* Custom Google Play Books onix 3.0 validation profile\n\n0.9.0 (2016-03-27)\n------------------\n\n* Added Python 3.5 testing / support\n* Update to ONIX to Code List Issue 32 / 2016-01-24\n\n0.8.1 (2015-07-23)\n------------------\n\n* More extensive documentation\n\n0.8.0 (2015-07-23)\n------------------\n\n* Added CLI-support for fast directory traversal validation\n* Secured XML-Parsing via defusedxml\n* Catch basic XML syntax errors\n* Windows standalone binary builds\n\n0.4.0 (2015-07-18)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "ONIX validation library and commandline tool",
"version": "0.9.7",
"project_urls": {
"Homepage": "https://github.com/titusz/onixcheck"
},
"split_keywords": [
"onix"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5878ada216233e5cd33239856a1b5956c070155e8629fe91993dd2d5a2a68039",
"md5": "ba663e37cebe1bcd0ce4ebab83e7c2e7",
"sha256": "a0ee5a49972c0a7c89b79c06b4c38711f382a9bb14f25d866c9b39685721af5a"
},
"downloads": -1,
"filename": "onixcheck-0.9.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba663e37cebe1bcd0ce4ebab83e7c2e7",
"packagetype": "bdist_wheel",
"python_version": "3.7",
"requires_python": null,
"size": 597025,
"upload_time": "2021-09-29T14:48:22",
"upload_time_iso_8601": "2021-09-29T14:48:22.600737Z",
"url": "https://files.pythonhosted.org/packages/58/78/ada216233e5cd33239856a1b5956c070155e8629fe91993dd2d5a2a68039/onixcheck-0.9.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f9cde060a6309eb5a8dd30c65a6bb03a6df6e43e22003fbbb5d3124ffc43401a",
"md5": "77876ec069dc58266b2daa63f662632d",
"sha256": "9efdf6d153ea3f44111fce58ea21c9374df36ace15c0439242e30a289c070953"
},
"downloads": -1,
"filename": "onixcheck-0.9.7.tar.gz",
"has_sig": false,
"md5_digest": "77876ec069dc58266b2daa63f662632d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 578175,
"upload_time": "2021-09-29T14:48:19",
"upload_time_iso_8601": "2021-09-29T14:48:19.512196Z",
"url": "https://files.pythonhosted.org/packages/f9/cd/e060a6309eb5a8dd30c65a6bb03a6df6e43e22003fbbb5d3124ffc43401a/onixcheck-0.9.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-09-29 14:48:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "titusz",
"github_project": "onixcheck",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"appveyor": true,
"tox": true,
"lcname": "onixcheck"
}
JSON
