Metadata-Version: 2.4
Name: adafruit-circuitpython-slideshow
Version: 1.8.8
Summary: CircuitPython helper library for displaying a slideshow of images on a display.
Author-email: Adafruit Industries <circuitpython@adafruit.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/adafruit/Adafruit_CircuitPython_Slideshow
Keywords: adafruit,software,slideshow,image,display,micropython,circuitpython
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: System :: Hardware
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: Adafruit-Blinka
Provides-Extra: optional
Requires-Dist: adafruit-circuitpython-display-text; extra == "optional"
Dynamic: license-file

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-slideshow/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/slideshow/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_Slideshow/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_Slideshow/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

CircuitPython helper library for displaying a slideshow of images on a display.

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-slideshow/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-slideshow

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-slideshow

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-slideshow

Usage Example
=============

.. code-block:: python

    from adafruit_slideshow import PlayBackOrder, SlideShow
    import board
    import pwmio

    # Create the slideshow object that plays through once alphabetically.
    slideshow = SlideShow(board.DISPLAY, pwmio.PWMOut(board.TFT_BACKLIGHT), folder="/",
                          loop=False, order=PlayBackOrder.ALPHABETICAL)

    while slideshow.update():
        pass

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/slideshow/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_Slideshow/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
