Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pybadger/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pybadger/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_PyBadger/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PyBadger/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
Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer, CLUE, and Mag Tag.
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-pybadger/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-pybadger
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-pybadger
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-pybadger
Usage Example
=============
.. code-block:: python
from adafruit_pybadger import pybadger
pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3)
while True:
pybadger.auto_dim_display(delay=10)
if pybadger.button.a:
pybadger.show_business_card(image_name="Blinka.bmp", name_string="Blinka", name_scale=2,
email_string_one="blinka@", email_string_two="adafruit.com")
elif pybadger.button.b:
pybadger.show_qr_code(data="https://circuitpython.org")
elif pybadger.button.start:
pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pybadger/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_PyBadger/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-pybadger",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, pybadge, pygamer, clue, display, hardware, micropythoncircuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/1e/c5/81c4499e712f2ef892d1524eb94a8bc048963d3050a94db0708766274f69/adafruit-circuitpython-pybadger-4.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pybadger/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/pybadger/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_PyBadger/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_PyBadger/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\nBadge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer, CLUE, and Mag Tag.\n\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=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-pybadger/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-pybadger\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-pybadger\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-pybadger\n\nUsage Example\n=============\n\n.. code-block:: python\n\n from adafruit_pybadger import pybadger\n\n pybadger.show_badge(name_string=\"Blinka\", hello_scale=2, my_name_is_scale=2, name_scale=3)\n\n while True:\n pybadger.auto_dim_display(delay=10)\n if pybadger.button.a:\n pybadger.show_business_card(image_name=\"Blinka.bmp\", name_string=\"Blinka\", name_scale=2,\n email_string_one=\"blinka@\", email_string_two=\"adafruit.com\")\n elif pybadger.button.b:\n pybadger.show_qr_code(data=\"https://circuitpython.org\")\n elif pybadger.button.start:\n pybadger.show_badge(name_string=\"Blinka\", hello_scale=2, my_name_is_scale=2, name_scale=3)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pybadger/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_PyBadger/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer and CLUE",
"version": "4.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_REPLACE"
},
"split_keywords": [
"adafruit",
" pybadge",
" pygamer",
" clue",
" display",
" hardware",
" micropythoncircuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f036152c83e732ff390e72db5131c0392bfa786aec3f3c05e3ef623cd1055cd5",
"md5": "17c6ffc062e7d39c63329b8df78f5f55",
"sha256": "9dd516276e96d9d4479506433ec2b90a76fb2d633cdafb5adae8f5bd8eee59a9"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pybadger-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17c6ffc062e7d39c63329b8df78f5f55",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21193,
"upload_time": "2024-04-01T14:52:28",
"upload_time_iso_8601": "2024-04-01T14:52:28.262810Z",
"url": "https://files.pythonhosted.org/packages/f0/36/152c83e732ff390e72db5131c0392bfa786aec3f3c05e3ef623cd1055cd5/adafruit_circuitpython_pybadger-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ec581c4499e712f2ef892d1524eb94a8bc048963d3050a94db0708766274f69",
"md5": "9a23b60b4fa94de3cb044582f879abbe",
"sha256": "5a7536697a3a1be06235af2699c1d037c170ac6636f9365d1e825bb59a60d85d"
},
"downloads": -1,
"filename": "adafruit-circuitpython-pybadger-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9a23b60b4fa94de3cb044582f879abbe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 86483,
"upload_time": "2024-04-01T14:52:30",
"upload_time_iso_8601": "2024-04-01T14:52:30.306311Z",
"url": "https://files.pythonhosted.org/packages/1e/c5/81c4499e712f2ef892d1524eb94a8bc048963d3050a94db0708766274f69/adafruit-circuitpython-pybadger-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 14:52:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_REPLACE",
"github_not_found": true,
"lcname": "adafruit-circuitpython-pybadger"
}
JSON
