Metadata-Version: 2.1
Name: oatmeal
Version: 1.0
Summary: A protocol to control and communicate with Arduino devices from Python.
Home-page: https://github.com/shielddx/oatmeal-protocol
Author: Shield Dx and Oatmeal Protocol Authors
Author-email: turner.isaac@gmail.com
License: UNKNOWN
Description: # Oatmeal Protocol: Python library
        
        Requires python 3.5 or higher.
        
        ## Installation
        
        Install dependencies:
        
            pip3 install -Ur requirements.txt
        
        Then copy into your python path or create a relative soft symlink with:
        
            ln -rs <YOUR_PYTHON_LIBS_DIR>/oatmeal oatmeal
        
        (Note: requires `gln` on mac).
        
        ## Tests
        
        Run tests with:
        
            make test
        
        ## API docs
        
        We use sphinx to auto-generate docs from our python docstrings. Our docstrings
        are formatted according to the [Google Style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
        
        Generate API docs with:
        
            pip3 install -Ur requirements.txt
            cd docs && make clean && make html
        
        Generated docs are then in `docs/_build/html/index.html`.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Software Development :: Object Brokering
Classifier: Topic :: Terminals :: Serial
Description-Content-Type: text/markdown
