Metadata-Version: 2.1
Name: pyngham
Version: 0.1.0
Summary: PyNGHam library
Home-page: https://github.com/mgm8/pyngham
Author: Gabriel Mariano Marcelino - PU5GMA
Author-email: gabriel.mm8@gmail.com
Maintainer: Gabriel Mariano Marcelino - PU5GMA
Maintainer-email: gabriel.mm8@gmail.com
License: LGPLv3
Download-URL: https://github.com/mgm8/pyngham/releases
Description: # PyNGHam
        
        <a href="https://github.com/mgm8/pyngham/actions">
            <img src="https://img.shields.io/github/workflow/status/mgm8/pyngham/Test?style=for-the-badge">
        </a>
        
        ## Overview
        
        The PyNGHAm library is a Python version of the original NGHam protocol library written in C by Jon Petter Skagmo (LA3JPA).
        
        The original implementation and a further description of the protocol can be found [here](https://github.com/skagmo/ngham).
        
        > NOTE: For now, this implementation uses a different Reed Solomon configuration from the original library.
        
        ## Dependencies
        
        * crc
        * reedsolo
        
        ## Installing
        
        * ```pip3 install pyngham```
        
        Or, from the source files:
        
        * ```python setup.py install```
        
        ## Documentation
        
        ### Dependencies
        
        * sphinx-rtd-theme
        
        ### Building the Documentation
        
        * ```python setup.py build_sphinx```
        
        ## Usage Example
        
        The usage of the library is pretty straightforward, after the initialization, there are two methods: one to encode a list of bytes, and other to decode a packet. Below there is a basic usage example:
        
        ```
        from pyngham import PyNGHam
        
        data = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
        
        pkt = PyNGHam().encode(data)
        
        pl, errors = PyNGHam().decode(pkt)
        
        print(pl)
        ```
        
        ## License
        
        This project is licensed under LGPLv3 license.
        
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Communications :: Ham Radio
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
