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/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
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/a1/8d/ea6466f8553a41699767a58086525ffdd1dc617aa2d0269d48ef82ea8700/adafruit_circuitpython_pybadger-4.0.7.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/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\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.7",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger"
},
"split_keywords": [
"adafruit",
" pybadge",
" pygamer",
" clue",
" display",
" hardware",
" micropythoncircuitpython"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ada67483a5353afb8d8cecf3abca48b6a418b3e963b08a72cf3ac4fbc756e6c0",
"md5": "5d72c943278b43eef2e27fd44d3cd2da",
"sha256": "b323dee625389ef2b1bd2034e8dece4c0f47e07453f2cb4501a42cc099099494"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pybadger-4.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5d72c943278b43eef2e27fd44d3cd2da",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20953,
"upload_time": "2025-10-20T20:46:47",
"upload_time_iso_8601": "2025-10-20T20:46:47.707352Z",
"url": "https://files.pythonhosted.org/packages/ad/a6/7483a5353afb8d8cecf3abca48b6a418b3e963b08a72cf3ac4fbc756e6c0/adafruit_circuitpython_pybadger-4.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a18dea6466f8553a41699767a58086525ffdd1dc617aa2d0269d48ef82ea8700",
"md5": "44a320fac5893f4e8f4b9143ec772bd5",
"sha256": "e05e6f2ce291b06514876fbfc25a10351de71a626a365de5dca8e618b79e1916"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pybadger-4.0.7.tar.gz",
"has_sig": false,
"md5_digest": "44a320fac5893f4e8f4b9143ec772bd5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 82698,
"upload_time": "2025-10-20T20:46:48",
"upload_time_iso_8601": "2025-10-20T20:46:48.883441Z",
"url": "https://files.pythonhosted.org/packages/a1/8d/ea6466f8553a41699767a58086525ffdd1dc617aa2d0269d48ef82ea8700/adafruit_circuitpython_pybadger-4.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 20:46:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_PyBadger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-bitmap-font",
"specs": []
},
{
"name": "adafruit-circuitpython-lsm6ds",
"specs": []
},
{
"name": "adafruit-circuitpython-display-text",
"specs": []
},
{
"name": "adafruit-circuitpython-miniqr",
"specs": []
},
{
"name": "adafruit-circuitpython-neopixel",
"specs": []
},
{
"name": "adafruit-circuitpython-gizmo",
"specs": []
},
{
"name": "adafruit-circuitpython-lis3dh",
"specs": []
},
{
"name": "adafruit-circuitpython-display-shapes",
"specs": []
}
],
"lcname": "adafruit-circuitpython-pybadger"
}
JSON
