adafruit / adafruit_circuitpython_binascii

Helpers for conversions between binary and ASCII

Introduction

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

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-binascii

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

sudo pip3 install adafruit-circuitpython-binascii

To install in a virtual environment in your current project:

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

Usage Example

Hex <-> Binary Conversions

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

adafruit_circuitpython_binascii's Issues

Missing Type Annotations

There are missing type annotations for some functions in this library.

The typing module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:

try:
    from typing import List, Tuple
except ImportError:
    pass

Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:

def wrap_text_to_pixels(
    string: str, max_width: int, font=None, indent0: str = "", indent1: str = ""
) -> List[str]:

If you are new to Git or Github we have a guide about contributing to our projects here: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github

There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages: Sharing docs on ReadTheDocs and Check your code with pre-commit contain the tools to install and commands to run locally to run the checks.

If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the #circuitpython-dev channel.

The following locations are reported by mypy to be missing type annotations:

• adafruit_binascii.py:66
• adafruit_binascii.py:79
• adafruit_binascii.py:99
• adafruit_binascii.py:109
• adafruit_binascii.py:151

The __version__ string in current release of libraries is incorrect semver.

Just a quick note: while I notice the __version__ object in the module, as it is in current master, is correct semver, this isn't the case in the copy of this module that's currently distributed (the associated value is "v1.0").

I'm just highlighting this as a courtesy since this mucks up the ability of circup to work with the module. I'm pretty certain the next release will have the fixed version, but flagging just in case there's something which automagically updates this value to the wrong thing.

Thanks!

cc/@ladyada

AttributeError: 'str' object has no attribute 'encode'

Same issue that:
adafruit/Adafruit_CircuitPython_Thermal_Printer#9

The problem is for SAMD21 non-express boards only.

As binascii is a really useful lib and the fix is really light, I really hope to have a fix here rather than in a fork.

RTD Documentation: Build status not successful

The RTD documentation was determined not to have built successfully. This could be the result of one of two reasons:

1. The documentation truly had an error occur and failed to build
2. The badge icon and/or link is not correctly formatted or pointing to the correct RTD link

Post-patch pylint issue