README.rst

####
punx
####

Python Utilities for NeXus HDF5 files: validation, structure, hierarchy

* Validation of NeXus NXDL files
* Validation of NeXus HDF5 data files
* Display of NeXus HDF5 data file structure
* Display of NeXus base class hierarchy (stretch goal, graphical output)

NOTE: project is under initial construction

:author:    Pete R. Jemian
:email:     prjemian@gmail.com
:copyright: 2017-2018, Pete R. Jemian
:license:   Creative Commons Attribution 4.0 International Public License (see *LICENSE.txt*)
:URL:       http://punx.readthedocs.io
:git:       https://github.com/prjemian/punx
:PyPI:      https://pypi.python.org/pypi/punx/ 
:TODO list: https://github.com/prjemian/punx/issues

:build badges:

   ..  see http://shields.io/ for more badge ideas

   .. image:: https://travis-ci.org/prjemian/punx.svg?branch=master
      :target: https://travis-ci.org/prjemian/punx
      :alt: Unit Testing
   .. image:: https://coveralls.io/repos/github/prjemian/punx/badge.svg?branch=master
      :target: https://coveralls.io/github/prjemian/punx?branch=master
      :alt: Code Coverage
   .. image:: https://landscape.io/github/prjemian/punx/master/landscape.svg?style=plastic
      :target: https://landscape.io/github/prjemian/punx/master
      :alt: Code Health

:release badges:
      
   .. image:: https://img.shields.io/github/tag/prjemian/punx.svg
      :target: https://github.com/prjemian/punx/tags
   .. image:: https://img.shields.io/github/release/prjemian/punx.svg
      :target: https://github.com/prjemian/punx/releases
   .. image:: https://img.shields.io/pypi/v/punx.svg
      :target: https://pypi.python.org/pypi/punx/

:social badges:
      
   .. image:: http://depsy.org/api/package/pypi/punx/badge.svg
      :target: http://depsy.org/package/python/punx
      :alt: Depsy (impact)
   .. image:: https://badges.gitter.im/punx-nexus/Lobby.svg
      :target: https://gitter.im/punx-nexus/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
      :alt: gitter (chat)