Introduction

RFC 3548: Base16, Base32, Base64 Data Encodings

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Adafruit CircuitPython BinAscii

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 circuitpython-base64

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

sudo pip3 install circuitpython-base64

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 circuitpython-base64

Usage Example

Base64 encode a byte string.

encoded = base64.encodebytes(bytes_to_encode)

Decode a base64 encoded string to bytes.

decoded = base64.decodebytes(string_to_decode)

Contributing

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

Documentation

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