Skip to content

Commit

Permalink
More quickstart examples
Browse files Browse the repository at this point in the history
  • Loading branch information
titusz committed Jul 23, 2015
1 parent 9e09494 commit b1f33cf
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,34 @@ Installation
Quickstart
==========

Command line usage::
Command line usage examples
---------------------------

Validate all .xml, .onx, .onix files in current directory::

onixcheck


Validate a single onix file::

onixcheck myonixfile.xml

Libary usage::

import onixcheck
Validate all .xml files in /onixdata and its subdirectories::

onixcheck --path /onixdata --ext xml --recursive


Using onixcheck as a python lib
-------------------------------

Simple usage with `onixcheck.validate`::

>>> import onixcheck
>>> errors = onixcheck.validate('/somedir/onixfile.xml')

errors = onixcheck.validate('/somedir/onixfile.xml')
`errors` is either a list of `Message` objects
(INVALID file) or an empty list (VALID file)

Documentation
=============
Expand Down

0 comments on commit b1f33cf

Please sign in to comment.