adafruit-circuitpython-binascii


Nameadafruit-circuitpython-binascii JSON
Version 2.0.2 PyPI version JSON
download
home_page
SummaryHelpers for conversions between binary and ASCII
upload_time2023-09-25 15:57:04
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython binascii binary ascii conversion
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/binascii/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/binascii/en/latest/
    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_binascii/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_binascii/actions/
    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

The binascii module contains a number of methods to convert between binary and various ASCII-encoded binary representations.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-binascii/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-binascii

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-binascii

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .venv/bin/activate
    pip3 install adafruit-circuitpython-binascii

Usage Example
=============

Hex <-> Binary Conversions

.. code-block:: python

        from adafruit_binascii import hexlify, unhexlify
        # Binary data.
        data = b"CircuitPython is Awesome!"

        # Get the hexadecimal representation of the binary data
        hex_data = hexlify(data)
        print("Hex Data: ", hex_data)

        # Get the binary data represented by hex_data
        bin_data = unhexlify(hex_data)
        print("Binary Data: ", bin_data)

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

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/binascii/en/latest/>`_.

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_binascii/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-binascii",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,binascii,binary,,ascii,,conversion",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/2e/d2/5b338470fba8fe71050d7ddded6bbf3be2ca3eea1cb74220f0196aa880f9/adafruit-circuitpython-binascii-2.0.2.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/binascii/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/binascii/en/latest/\n    :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_binascii/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_binascii/actions/\n    :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n\nThe binascii module contains a number of methods to convert between binary and various ASCII-encoded binary representations.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-binascii/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-binascii\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-binascii\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .venv\n    source .venv/bin/activate\n    pip3 install adafruit-circuitpython-binascii\n\nUsage Example\n=============\n\nHex <-> Binary Conversions\n\n.. code-block:: python\n\n        from adafruit_binascii import hexlify, unhexlify\n        # Binary data.\n        data = b\"CircuitPython is Awesome!\"\n\n        # Get the hexadecimal representation of the binary data\n        hex_data = hexlify(data)\n        print(\"Hex Data: \", hex_data)\n\n        # Get the binary data represented by hex_data\n        bin_data = unhexlify(hex_data)\n        print(\"Binary Data: \", bin_data)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/binascii/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_binascii/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Helpers for conversions between binary and ASCII",
    "version": "2.0.2",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_binascii"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "binascii",
        "binary",
        "",
        "ascii",
        "",
        "conversion"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "50fde2c5183c1afe5b795ac356b698adbd75c25206ec38ee3cb7f55a2cd8decb",
                "md5": "3ad569a272bba9b32616728b6c8ca019",
                "sha256": "76e6c0eb7905773c59f6be5af8776b6a6a3f88449d461a71ffc580beb12cffea"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_binascii-2.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3ad569a272bba9b32616728b6c8ca019",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5563,
            "upload_time": "2023-09-25T15:57:03",
            "upload_time_iso_8601": "2023-09-25T15:57:03.346073Z",
            "url": "https://files.pythonhosted.org/packages/50/fd/e2c5183c1afe5b795ac356b698adbd75c25206ec38ee3cb7f55a2cd8decb/adafruit_circuitpython_binascii-2.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2ed25b338470fba8fe71050d7ddded6bbf3be2ca3eea1cb74220f0196aa880f9",
                "md5": "c3300beac5d64818af4ea26c2a9c530f",
                "sha256": "784075be8652f07a7a319d1cba651f61fae09b05cae405a11c3c750c1cc5d219"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-binascii-2.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "c3300beac5d64818af4ea26c2a9c530f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 26674,
            "upload_time": "2023-09-25T15:57:04",
            "upload_time_iso_8601": "2023-09-25T15:57:04.472084Z",
            "url": "https://files.pythonhosted.org/packages/2e/d2/5b338470fba8fe71050d7ddded6bbf3be2ca3eea1cb74220f0196aa880f9/adafruit-circuitpython-binascii-2.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-25 15:57:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_binascii",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-binascii"
}
        
Elapsed time: 0.14524s