Metadata-Version: 2.4
Name: pyopensign
Version: 1.0.0
Summary: A library to facilitate easy Python RGB Matrix Sign Animations.
Author-email: Melissa LeBlanc-Williams <melissa@makermelissa.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Maker-Melissa/PyOpenSign
Keywords: opensign,open,sign,rgb,matrix,led,animation,hzeller,makermelissa
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: LICENSE.license
Requires-Dist: pillow>=9.2.0
Dynamic: license-file

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

.. image:: https://readthedocs.org/projects/pyopensign/badge/?version=latest
    :target: https://pyopensign.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/Maker-Melissa/PyOpenSign/workflows/Build%20CI/badge.svg
    :target: https://github.com/Maker-Melissa/PyOpenSign/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

A library to facilitate easy RGB Matrix Sign Animations.


Dependencies
=============
This library depends on:

* `Henner Zeller RPi RGB LED Matrix <https://github.com/hzeller/rpi-rgb-led-matrix/>`_
* `Python Bindings for RGB Matrix Library <https://github.com/hzeller/rpi-rgb-led-matrix/tree/master/bindings/python>`_
* `Python Imaging Library (Pillow) <https://pypi.org/project/Pillow/>`_

Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/pyopensign/>`_. To install for current user:

.. code-block:: shell

    pip3 install pyopensign

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

.. code-block:: shell

    sudo pip3 install pyopensign

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install pyopensign
