Skip to content
Helpers for conversions between binary and ASCII
Python
Branch: master
Clone or download
Latest commit b33c0f4 Aug 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs add readme, index docs Aug 19, 2019
examples
.gitignore
.pylintrc
.readthedocs.yml cookiecut! Aug 19, 2019
.travis.yml cookiecut! Aug 19, 2019
CODE_OF_CONDUCT.md cookiecut! Aug 19, 2019
LICENSE lint pass Aug 19, 2019
README.rst add readme, index docs Aug 19, 2019
adafruit_binascii.py
requirements.txt cookiecut! Aug 19, 2019
setup.py cookiecut! Aug 19, 2019

README.rst

Introduction

Documentation Status Discord Build Status

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

Dependencies

This driver depends on:

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

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

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 .env
source .env/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)

Contributing

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

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.