Metadata-Version: 2.1
Name: pychapter10
Version: 0.3.6
Summary: A parser library for the IRIG 106 Chapter 10 data format.
Home-page: https://github.com/atac/pychapter10
Author: Micah Ferrill
Author-email: ferrillm@avtest.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=py3.6
Requires-Dist: bitstruct (==8.11.0)


PyChapter10
===========

|StatusImage|_
|CoverageImage|
|DocsImage|_
|LicenseImage|
|PyPiVersion|_
|PythonVersion|

PyChapter10 is an open source pure Python library for reading and writing IRIG 106 
Chapter 10 (now 11) files. Tested on all 3 major platforms with Python 3.6+.

Installation
------------

Install the latest version with pip::

    pip install pychapter10

To install offline from "full" zip, install the included dependencies and the library with::

    pip install dependencies/* .

**Note:** you may also install cbitstruct (included in requirements.txt, see
below) for a performance improvement.

Running Tests
-------------

To run the included test suite install dependencies with pip::

    pip install -r requirements.txt

Then run::

    pytest

Building the Documentation
--------------------------

After installing dependencies (or just "pip install sphinx") Build the docs with::

    python setup.py build_docs

The generated HTML will be in docs/html

**Note:** "Full" zip includes built documentation already.

Contributing
------------

See CONTRIBUTING_

.. _Python: http://python.org
.. |StatusImage| image:: https://img.shields.io/azure-devops/build/atac-bham/7e6b2ae2-5609-49c9-9ded-f108e80d8949/7
.. _StatusImage: https://dev.azure.com/atac-bham/pychapter10/_build/latest?definitionId=7&branchName=master
.. |DocsImage| image:: https://readthedocs.org/projects/pychapter10/badge/?version=latest
.. _DocsImage: https://pychapter10.readthedocs.io/en/latest/?badge=latest
.. |CoverageImage| image:: https://img.shields.io/azure-devops/coverage/atac-bham/pychapter10/7
.. |LicenseImage| image:: https://img.shields.io/pypi/l/pychapter10
.. _PyPiVersion: https://pypi.org/project/pychapter10/
.. |PyPiVersion| image:: https://img.shields.io/pypi/v/pychapter10
.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/pychapter10
.. _CONTRIBUTING: CONTRIBUTING.rst


