Metadata-Version: 2.1
Name: hdlcontroller
Version: 0.5.2
Summary: HDLC controller
Author-email: Paul-Emmanuel Raoul <skyper@skyplabs.net>
License: The MIT License (MIT)
        
        Copyright (c) 2015-2023 Paul-Emmanuel Raoul <skyper@skyplabs.net>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: documentation, https://python-hdlc-controller.readthedocs.io/en/latest
Project-URL: repository, https://github.com/SkypLabs/python-hdlc-controller
Keywords: hdlc,controller
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Requires-Python: <4,>=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: python4yahdlc >=1.3.5
Requires-Dist: pyserial >=3.0
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx >=1.4.0 ; extra == 'docs'
Requires-Dist: sphinxcontrib-seqdiag >=0.8.5 ; extra == 'docs'
Requires-Dist: sphinx-argparse >=0.2.2 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: tox ; extra == 'tests'

======================
Python HDLC Controller
======================

|PyPI Package| |PyPI Downloads| |PyPI Python Versions| |Build Status|
|Documentation Status|

HDLC_ controller written in Python and based on the `python4yahdlc
<https://github.com/SkypLabs/python4yahdlc>`__ Python module to encode and
decode the HDLC frames.

Installation
============

From PyPI (recommended)
-----------------------

::

    pip3 install --upgrade hdlcontroller

From sources
------------

::

    git clone https://github.com/SkypLabs/python-hdlc-controller.git
    cd python-hdlc-controller
    pip3 install --upgrade .

Documentation
=============

The full documentation is available `here
<https://python-hdlc-controller.readthedocs.io/en/latest/>`__.

License
=======

`MIT <https://opensource.org/license/mit/>`__

.. _HDLC: https://en.wikipedia.org/wiki/High-Level_Data_Link_Control

.. |Build Status| image:: https://github.com/SkypLabs/python-hdlc-controller/actions/workflows/test_and_publish.yml/badge.svg?branch=develop
   :target: https://github.com/SkypLabs/python-hdlc-controller/actions/workflows/test_and_publish.yml?branch=develop
   :alt: Build Status Develop Branch

.. |Documentation Status| image:: https://readthedocs.org/projects/python-hdlc-controller/badge/?version=latest
   :target: https://python-hdlc-controller.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/hdlcontroller.svg?style=flat
   :target: https://pypi.org/project/hdlcontroller/
   :alt: PyPI Package Downloads Per Month

.. |PyPI Package| image:: https://badge.fury.io/py/hdlcontroller.svg
   :target: https://pypi.org/project/hdlcontroller/
   :alt: PyPI Package Latest Release

.. |PyPI Python Versions| image:: https://img.shields.io/pypi/pyversions/hdlcontroller.svg?logo=python&style=flat
   :target: https://pypi.org/project/hdlcontroller/
   :alt: PyPI Package Python Versions
