A minimal QR code generator for types 1-9
MIT License
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-miniqr/badge/?version=latest :target: https://docs.circuitpython.org/projects/miniqr/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_miniQR/workflows/Build%20CI/badge.svg :target: https://github.com/adafruit/Adafruit_CircuitPython_miniQR/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
A non-hardware dependant miniature QR generator library. All native Python!
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>
_.
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI <https://pypi.org/project/adafruit-circuitpython-miniqr/>
_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-miniqr
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-miniqr
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-miniqr
.. code-block:: python
import adafruit_miniqr
qr = adafruit_miniqr.QRCode()
qr.add_data(b'https://www.adafruit.com')
qr.make()
print(qr.matrix)
API documentation for this library can be found on Read the Docs <https://docs.circuitpython.org/projects/miniqr/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>
_.
Contributions are welcome! Please read our Code of Conduct <https://github.com/adafruit/Adafruit_CircuitPython_miniQR/blob/main/CODE_OF_CONDUCT.md>
_
before contributing to help this project stay welcoming.