adafruit-circuitpython-neotrellis


Nameadafruit-circuitpython-neotrellis JSON
Version 1.3.4 PyPI version JSON
download
home_page
SummaryCircuitPython library for using Adafruit NeoTrellis.
upload_time2023-05-26 16:12:16
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit neotrellis neopixel trellis led rgbsensor hardware micropython circuitpython
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-seesaw
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

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

This is a library for using the Adafruit_NeoTrellis boards with circuitpython.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
* `Adafruit Seesaw <https://github.com/adafruit/Adafruit_CircuitPython_seesaw>`_

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-neotrellis

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-neotrellis

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

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

see examples/neotrellis_simpletest.py for usage example

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

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-neotrellis",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,neotrellis,neopixel,trellis,led,rgbsensor,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/15/cf/77f4fd4368db02f85062829635a7b44a5d2154137229872143392e32b8ff/adafruit-circuitpython-neotrellis-1.3.4.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-neotrellis/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/neotrellis/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_NeoTrellis/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_NeoTrellis/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\nThis is a library for using the Adafruit_NeoTrellis boards with circuitpython.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n* `Adafruit Seesaw <https://github.com/adafruit/Adafruit_CircuitPython_seesaw>`_\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-neotrellis/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-neotrellis\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-neotrellis\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-neotrellis\n\nUsage Example\n=============\n\nsee examples/neotrellis_simpletest.py for usage example\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neotrellis/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_NeoTrellis/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for using Adafruit NeoTrellis.",
    "version": "1.3.4",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_NeoTrellis"
    },
    "split_keywords": [
        "adafruit",
        "neotrellis",
        "neopixel",
        "trellis",
        "led",
        "rgbsensor",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e03dc48f69f815f60432350b49af03e78162d37ef6b9e65d9cb88e6e8eafdd16",
                "md5": "1c881413e608aa9680c1586527aea7a9",
                "sha256": "abfec11ba4ead406bf22013cf6be36e9af69e41795f4634bed3b3c0a8da812bb"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_neotrellis-1.3.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1c881413e608aa9680c1586527aea7a9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6812,
            "upload_time": "2023-05-26T16:12:13",
            "upload_time_iso_8601": "2023-05-26T16:12:13.690783Z",
            "url": "https://files.pythonhosted.org/packages/e0/3d/c48f69f815f60432350b49af03e78162d37ef6b9e65d9cb88e6e8eafdd16/adafruit_circuitpython_neotrellis-1.3.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "15cf77f4fd4368db02f85062829635a7b44a5d2154137229872143392e32b8ff",
                "md5": "a5b48247138200e0d345d25399933ff5",
                "sha256": "6ebee7605561d93628f01ace066e019e3331a66d5fbf0413a84d32a96ecdf667"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-neotrellis-1.3.4.tar.gz",
            "has_sig": false,
            "md5_digest": "a5b48247138200e0d345d25399933ff5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27541,
            "upload_time": "2023-05-26T16:12:16",
            "upload_time_iso_8601": "2023-05-26T16:12:16.109300Z",
            "url": "https://files.pythonhosted.org/packages/15/cf/77f4fd4368db02f85062829635a7b44a5d2154137229872143392e32b8ff/adafruit-circuitpython-neotrellis-1.3.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-26 16:12:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_NeoTrellis",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-seesaw",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-neotrellis"
}
        
Elapsed time: 0.09217s