Merge pull request #6 from bstabler/master

add validator

Author: bstabler

api/CHANGES.txt CHANGES.txtapi/CHANGES.txt renamed to CHANGES.txt

@@ -4,5 +4,6 @@ v0.2.2, 2015-01-15 -- Fix test to reference openmatrix instead of omx
 v0.2.3, 2015-02-20 -- Bug fixes and lots more tests
 v0.3.3, 2017-03-07 -- Python 3 compatible
 v0.3.4, 2018-04-05 -- Fix incorrect version being saved
-
+v0.3.4.1, 2018-10-19 -- python3 compatible next for generator
+v0.3.5, 2019-12-21 -- add validator and clean-up repo structure
 

api/MANIFEST.in MANIFEST.inapi/MANIFEST.in renamed to MANIFEST.in

@@ -5,6 +5,8 @@ The Python OMX API borrows heavily from PyTables. An OMX file extends the equiva
 * [Pre-requisites](#pre-requisites)
 * [Installation](#installation)
 * [Quick Start Code](#quick-start-sample-code)
+* [Testing](#testing)
+* [OMX File Validator](#omx-file-validator)
 * [Usage Notes](#usage-notes)
 * [API Reference](#api-reference)
 
@@ -112,6 +114,20 @@ print('cell value:', m3[tazs[100]][tazs[100]]) # 3.0  (taz (100,100) is cell [99
 myfile.close()
 ```
 
+# Testing
+Testing is done with [nose](https://nose.readthedocs.io/en/latest/).  Run the tests via:
+
+```
+openmatrix\test> nosetests -v
+```
+
+# OMX File Validator
+Included in this package is a command line OMX file validation tool used to validate OMX files against the specification.  The tool is added to the system PATH when the package is installed and can be run as follows:
+
+```
+omx-validate my_file.omx
+```
+
 # Usage Notes
 
 ### File Objects
@@ -181,7 +197,7 @@ A mapping allows rows and columns to be accessed using an integer value other th
 ## Global Properties
 
 ### `__version__`
-OMX module version string.  Currently '0.3.3' as of this writing. This is the Python API version.
+OMX module version string.  Currently '0.3.5' as of this writing. This is the Python API version.
 
 ### `__omx_version__`
 OMX file format version. Currently '0.2'. This is the OMX file format specification that omx-python adheres to.
@@ -212,7 +228,7 @@ OMX file format version. Currently '0.2'. This is the OMX file format specificat
             See HDF5 docs for more detail.
         shape: numpy.array
             Shape of matrices in this file. Default is None. Specify a valid shape 
-            (e.g. (1000,1200)) to enforce shape-checking for all added objects. 
+            (e.g. (1200,1200)) to enforce shape-checking for all added objects. 
             If shape is not specified, the first added matrix will not be shape-checked 
             and all subsequently added matrices must match the shape of the first matrix.
             All tables in an OMX file must have the same shape.

README.md

@@ -8,7 +8,7 @@
 
 # GLOBAL VARIABLES -----------
 __version__ = '0.3.3'
-__omx_version__ = '0.2'
+__omx_version__ = b'0.2'
 
 # GLOBAL FUNCTIONS -----------
 def open_file(filename, mode='r', title='', root_uep='/',