https://github.com/adafruit/adafruit_circuitpython_display_notification

Helper for displaying app notifications on a screen using `displayio`.
https://github.com/adafruit/adafruit_circuitpython_display_notification

circuitpython displayio hacktoberfest

Last synced: 3 months ago
JSON representation

Helper for displaying app notifications on a screen using `displayio`.

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_display_notification
• Owner: adafruit
• License: mit
• Created: 2019-12-03T23:00:15.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-12-09T17:43:55.000Z (about 1 year ago)
• Last Synced: 2024-10-07T11:12:03.539Z (3 months ago)
• Topics: circuitpython, displayio, hacktoberfest
• Language: Python
• Size: 81.1 KB
• Stars: 3
• Watchers: 19
• Forks: 7
• Open Issues: 0
• 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/adafruit-circuitpython-display_notification/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/display_notification/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_Display_Notification/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_Display_Notification/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

Displayio Widgets for displaying notifications

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

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

=====================

.. note:: This library is not available on PyPI yet. Install documentation is included

   as a standard element. Stay tuned for PyPI availability!

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 adafruit-circuitpython-display-notification

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-display-notification

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-display-notification

Usage Example

=============

See the `examples` folder.

Documentation

=============

API documentation for this library can be found on `Read the Docs `_.

For information on building library documentation, please check out `this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.