https://github.com/titusz/onixcheck

ONIX validation library and commandline tool
https://github.com/titusz/onixcheck

onix validation xml

Last synced: 2 months ago
JSON representation

ONIX validation library and commandline tool

• Host: GitHub
• URL: https://github.com/titusz/onixcheck
• Owner: titusz
• License: bsd-2-clause
• Created: 2015-07-18T10:38:26.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-09-29T14:59:47.000Z (over 3 years ago)
• Last Synced: 2024-10-07T17:18:39.358Z (3 months ago)
• Topics: onix, validation, xml
• Language: Python
• Size: 1.32 MB
• Stars: 22
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
==========================================

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 `_ 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 `_

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.