https://github.com/jimbobbennett/circuitpython_base64
Base64 encoding and decoding library for CircuitPython
https://github.com/jimbobbennett/circuitpython_base64
circuitpython
Last synced: 5 months ago
JSON representation
Base64 encoding and decoding library for CircuitPython
- Host: GitHub
- URL: https://github.com/jimbobbennett/circuitpython_base64
- Owner: jimbobbennett
- License: mit
- Created: 2020-03-07T17:58:17.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-07T17:17:17.000Z (about 5 years ago)
- Last Synced: 2025-08-16T06:35:47.287Z (5 months ago)
- Topics: circuitpython
- Language: Python
- Size: 68.4 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-base64/badge/?version=latest
:target: https://circuitpython.readthedocs.io/projects/base64/en/latest/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/jimbobbennett/CircuitPython_base64/workflows/Build%20CI/badge.svg
:target: https://github.com/jimbobbennett/CircuitPython_base64/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
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:
.. code-block:: shell
pip3 install circuitpython-base64
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-base64
To install in a virtual environment in your current project:
.. code-block:: shell
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.
.. code-block:: python
encoded = base64.encodebytes(bytes_to_encode)
Decode a base64 encoded string to bytes.
.. code-block:: python
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 `_.