Introduction
============
.. 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!
Dependencies
=============
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>`_.
Installing from PyPI
====================
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
Usage Example
=============
.. code-block:: python
import adafruit_miniqr
qr = adafruit_miniqr.QRCode()
qr.add_data(b'https://www.adafruit.com')
qr.make()
print(qr.matrix)
Documentation
=============
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>`_.
Contributing
============
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-miniqr",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,software,miniqr,qr,generator,python,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/f2/b6/ad4a82231ca565a2109f052131ea0f1aa9cacc818fb80bb92175a913e457/adafruit-circuitpython-miniqr-2.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-miniqr/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/miniqr/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_miniQR/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_miniQR/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nA non-hardware dependant miniature QR generator library. All native Python!\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-miniqr/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-miniqr\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-miniqr\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-miniqr\n\nUsage Example\n=============\n\n.. code-block:: python\n\n\timport adafruit_miniqr\n\n\tqr = adafruit_miniqr.QRCode()\n\tqr.add_data(b'https://www.adafruit.com')\n\tqr.make()\n\tprint(qr.matrix)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/miniqr/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_miniQR/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A non-hardware dependant miniature QR generator library. All native Python!",
"version": "2.1.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_miniQR"
},
"split_keywords": [
"adafruit",
"software",
"miniqr",
"qr",
"generator",
"python",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "416e3673a0c3eae0d2d12dfb4b48b4c59df146e07fc164e52de179d7c6d869b4",
"md5": "7a261380be72bfc3b53d0f05e668583f",
"sha256": "430e37784d876265d32ed866af40ffcedf3a4d26762c5e61596c3962ecd56b40"
},
"downloads": -1,
"filename": "adafruit_circuitpython_miniqr-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a261380be72bfc3b53d0f05e668583f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9296,
"upload_time": "2024-01-23T00:08:56",
"upload_time_iso_8601": "2024-01-23T00:08:56.843172Z",
"url": "https://files.pythonhosted.org/packages/41/6e/3673a0c3eae0d2d12dfb4b48b4c59df146e07fc164e52de179d7c6d869b4/adafruit_circuitpython_miniqr-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f2b6ad4a82231ca565a2109f052131ea0f1aa9cacc818fb80bb92175a913e457",
"md5": "00ebcc1da54cc8f6367845d262873f86",
"sha256": "550a78cdee6fa9ceda2521ecd60d075e047561194b44032f14d16bc21c452175"
},
"downloads": -1,
"filename": "adafruit-circuitpython-miniqr-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "00ebcc1da54cc8f6367845d262873f86",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32476,
"upload_time": "2024-01-23T00:08:58",
"upload_time_iso_8601": "2024-01-23T00:08:58.548673Z",
"url": "https://files.pythonhosted.org/packages/f2/b6/ad4a82231ca565a2109f052131ea0f1aa9cacc818fb80bb92175a913e457/adafruit-circuitpython-miniqr-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-23 00:08:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_miniQR",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-miniqr"
}
JSON
