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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-slideshow",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,software,slideshow,image,display,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/99/0e/27bc24b036261a9c78005e0c05c774d88d5b6f0ecf85f8a08c95f2ad8b8e/adafruit-circuitpython-slideshow-1.8.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-slideshow/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/slideshow/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_Slideshow/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Slideshow/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\nCircuitPython helper library for displaying a slideshow of images on a display.\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-slideshow/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-slideshow\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-slideshow\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-slideshow\n\nUsage Example\n=============\n\n.. code-block:: python\n\n from adafruit_slideshow import PlayBackOrder, SlideShow\n import board\n import pwmio\n\n # Create the slideshow object that plays through once alphabetically.\n slideshow = SlideShow(board.DISPLAY, pwmio.PWMOut(board.TFT_BACKLIGHT), folder=\"/\",\n loop=False, order=PlayBackOrder.ALPHABETICAL)\n\n while slideshow.update():\n pass\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/slideshow/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_Slideshow/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython helper library for displaying a slideshow of images on a display.",
"version": "1.8.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Slideshow"
},
"split_keywords": [
"adafruit",
"software",
"slideshow",
"image",
"display",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4eab4d936d10e0d7d84506f251ad19000969d46174a1f9b3fe943d4d19977a23",
"md5": "ff63866b62b8595189d9713aef09cf16",
"sha256": "ebb1774f2a1cef1d7a94678006ecb085e732520523fcd01407da8ce5ae141866"
},
"downloads": -1,
"filename": "adafruit_circuitpython_slideshow-1.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff63866b62b8595189d9713aef09cf16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8213,
"upload_time": "2023-12-09T17:53:58",
"upload_time_iso_8601": "2023-12-09T17:53:58.949855Z",
"url": "https://files.pythonhosted.org/packages/4e/ab/4d936d10e0d7d84506f251ad19000969d46174a1f9b3fe943d4d19977a23/adafruit_circuitpython_slideshow-1.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "990e27bc24b036261a9c78005e0c05c774d88d5b6f0ecf85f8a08c95f2ad8b8e",
"md5": "a023c1bfc6e23f8c562518eb2017f71e",
"sha256": "4788d63bd309168609f18494df5c123f4a15277516e2ef3a7937d7e5a7b4eecd"
},
"downloads": -1,
"filename": "adafruit-circuitpython-slideshow-1.8.1.tar.gz",
"has_sig": false,
"md5_digest": "a023c1bfc6e23f8c562518eb2017f71e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31894,
"upload_time": "2023-12-09T17:54:00",
"upload_time_iso_8601": "2023-12-09T17:54:00.884903Z",
"url": "https://files.pythonhosted.org/packages/99/0e/27bc24b036261a9c78005e0c05c774d88d5b6f0ecf85f8a08c95f2ad8b8e/adafruit-circuitpython-slideshow-1.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:54:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Slideshow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-slideshow"
}
JSON
