{"id":16288393,"url":"https://github.com/skyplabs/python4yahdlc","last_synced_at":"2025-10-06T14:25:19.981Z","repository":{"id":2947848,"uuid":"47656595","full_name":"SkypLabs/python4yahdlc","owner":"SkypLabs","description":"Python binding of the yahdlc library","archived":false,"fork":false,"pushed_at":"2025-04-02T09:30:30.000Z","size":218,"stargazers_count":21,"open_issues_count":7,"forks_count":16,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-10T02:58:10.175Z","etag":null,"topics":["hdlc","network","python","python-bindings","python3","yahdlc"],"latest_commit_sha":null,"homepage":"https://pypi.python.org/pypi/python4yahdlc","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SkypLabs.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"SkypLabs","custom":["https://blog.skyplabs.net/support/","https://paypal.me/skyplabs"]}},"created_at":"2015-12-08T23:46:09.000Z","updated_at":"2025-04-02T07:51:31.000Z","dependencies_parsed_at":"2024-03-13T20:50:52.712Z","dependency_job_id":"67fdd03f-8399-48cf-af02-816f1c7f65f6","html_url":"https://github.com/SkypLabs/python4yahdlc","commit_stats":{"total_commits":169,"total_committers":4,"mean_commits":42.25,"dds":"0.18343195266272194","last_synced_commit":"fc4a841d231856d71e334cc69b30bf6335fa4775"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkypLabs%2Fpython4yahdlc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkypLabs%2Fpython4yahdlc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkypLabs%2Fpython4yahdlc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SkypLabs%2Fpython4yahdlc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SkypLabs","download_url":"https://codeload.github.com/SkypLabs/python4yahdlc/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249185572,"owners_count":21226581,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hdlc","network","python","python-bindings","python3","yahdlc"],"created_at":"2024-10-10T19:48:09.399Z","updated_at":"2025-10-06T14:25:19.879Z","avatar_url":"https://github.com/SkypLabs.png","language":"C","funding_links":["https://github.com/sponsors/SkypLabs","https://blog.skyplabs.net/support/","https://paypal.me/skyplabs"],"categories":[],"sub_categories":[],"readme":"=============\npython4yahdlc\n=============\n\n|PyPI Package| |PyPI Downloads| |PyPI Python Versions| |Build Status|\n\npython4yahdlc is a Python binding of the `yahdlc\n\u003chttps://github.com/bang-olufsen/yahdlc\u003e`__ library, allowing to encode and\ndecode `HDLC \u003chttps://en.wikipedia.org/wiki/High-Level_Data_Link_Control\u003e`__\nframes.\n\nDependencies\n============\n\nThis software requires Python 3.\n\nInstallation\n============\n\nFrom PyPI (recommended)\n-----------------------\n\n.. code:: sh\n\n    pip install --upgrade python4yahdlc\n\nFrom sources\n------------\n\n.. code:: sh\n\n    git clone https://github.com/SkypLabs/python4yahdlc.git\n    cd python4yahdlc\n    git submodule update --init --recursive\n    pip install --upgrade .\n\nUsage\n=====\n\nTo generate a new HDLC data frame:\n\n.. code:: python\n\n    from yahdlc import *\n\n    frame = frame_data('hello world!')\n\nTo generate a new HDLC ``ACK`` frame with a specific sequence number:\n\n.. code:: python\n\n    frame = frame_data('', FRAME_ACK, 3)\n\nThe highest sequence number is 7 and the following frame types are available:\n\n- ``FRAME_DATA``\n- ``FRAME_ACK``\n- ``FRAME_NACK``\n\nNote that when you generate an ``ACK`` or ``NACK`` frame, the payload is\nuseless.\n\nTo decode a received HDLC frame:\n\n.. code:: python\n\n    data, ftype, seq_no = get_data(frame)\n\nFor a more advanced use, take a look at the examples available in the `examples\n\u003chttps://github.com/SkypLabs/python4yahdlc/tree/main/examples\u003e`__ folder.\n\nDevelopment\n===========\n\nTo set up a development environment on your local machine:\n\n.. code:: sh\n\n    # Clone the Git repository and initialise its sub-modules.\n    git clone https://github.com/SkypLabs/python4yahdlc.git\n    cd python4yahdlc\n    git submodule update --init --recursive\n\n    # Create a virtual environment and activate it.\n    python -m venv .venv\n    source .venv/bin/activate\n\n    # Make sure to have the latest versions of pip and setuptools.\n    pip install --upgrade pip setuptools\n\n    # Install python4yahdlc in editable mode with all its optional\n    # dependencies.\n    pip install -e .[examples,tests]\n\nLicense\n=======\n\nThis project is released under the `GPL version 3\n\u003chttps://www.gnu.org/licenses/gpl.txt\u003e`__ license. The `yahdlc\n\u003chttps://github.com/bang-olufsen/yahdlc\u003e`__ library is released under the `MIT\n\u003chttps://github.com/bang-olufsen/yahdlc/blob/master/LICENSE\u003e`__ license.\n\n.. |Build Status| image:: https://github.com/SkypLabs/python4yahdlc/actions/workflows/test_and_publish.yml/badge.svg?branch=develop\n   :target: https://github.com/SkypLabs/python4yahdlc/actions/workflows/test_and_publish.yml?query=branch%3Adevelop\n   :alt: Build Status\n\n.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/python4yahdlc.svg?style=flat\n   :target: https://pypi.org/project/python4yahdlc/\n   :alt: PyPI Package Downloads Per Month\n\n.. |PyPI Package| image:: https://img.shields.io/pypi/v/python4yahdlc.svg?style=flat\n   :target: https://pypi.org/project/python4yahdlc/\n   :alt: PyPI Package Latest Release\n\n.. |PyPI Python Versions| image:: https://img.shields.io/pypi/pyversions/python4yahdlc.svg?logo=python\u0026style=flat\n   :target: https://pypi.org/project/python4yahdlc/\n   :alt: PyPI Package Python Versions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyplabs%2Fpython4yahdlc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskyplabs%2Fpython4yahdlc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyplabs%2Fpython4yahdlc/lists"}