adafruit-circuitpython-pixelbuf


Nameadafruit-circuitpython-pixelbuf JSON
Version 2.0.6 PyPI version JSON
download
home_pageNone
SummaryA pure Python implementation of adafruit_pixelbuf for smaller boards.
upload_time2024-10-07 22:32:14
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython pixelbuf neopixel dotstar leds
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


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

A pure Python implementation of adafruit_pixelbuf for smaller boards.


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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.


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

.. code-block:: shell

    pip3 install adafruit-circuitpython-pixelbuf

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-pixelbuf

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


Installing to a Connected CircuitPython Device with Circup
==========================================================

Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the
following command to install:

.. code-block:: shell

    circup install adafruit_pixelbuf

Or the following command to update an existing version:

.. code-block:: shell

    circup update

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

This example tests that pixelbuf works.

.. code-block:: python

    class TestBuf(adafruit_pixelbuf.PixelBuf):
        called = False

        def show(self):
            self.called = True


    buffer = TestBuf(20, bytearray(20 * 3), "RGB", 1.0, auto_write=True)
    buffer[0] = (1, 2, 3)

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

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-pixelbuf",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, pixelbuf, neopixel, dotstar, leds",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/0d/24/c1bd0bbd8f40041a7a505b2a09a4a8cacc32d749544bc4a6b45ec4bbf0d1/adafruit_circuitpython_pixelbuf-2.0.6.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pixelbuf/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/pixelbuf/en/latest/\n    :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf/actions\n    :alt: Build Status\n\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\nA pure Python implementation of adafruit_pixelbuf for smaller boards.\n\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\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-pixelbuf/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-pixelbuf\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-pixelbuf\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-pixelbuf\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n    pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n    circup install adafruit_pixelbuf\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n    circup update\n\nUsage Example\n=============\n\nThis example tests that pixelbuf works.\n\n.. code-block:: python\n\n    class TestBuf(adafruit_pixelbuf.PixelBuf):\n        called = False\n\n        def show(self):\n            self.called = True\n\n\n    buffer = TestBuf(20, bytearray(20 * 3), \"RGB\", 1.0, auto_write=True)\n    buffer[0] = (1, 2, 3)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pixelbuf/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_Pixelbuf/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A pure Python implementation of adafruit_pixelbuf for smaller boards.",
    "version": "2.0.6",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Pixelbuf.git"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " pixelbuf",
        " neopixel",
        " dotstar",
        " leds"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c5fe3106478bc0518449581288e2effd3cb2018f103150a33370e3c0681bcb42",
                "md5": "02232e9777214747a322319397c3736b",
                "sha256": "bfb9c796a02c996a86969ea57b0cbd3be0a49638531467468fe36568422c3979"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pixelbuf-2.0.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "02232e9777214747a322319397c3736b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7018,
            "upload_time": "2024-10-07T22:32:13",
            "upload_time_iso_8601": "2024-10-07T22:32:13.182023Z",
            "url": "https://files.pythonhosted.org/packages/c5/fe/3106478bc0518449581288e2effd3cb2018f103150a33370e3c0681bcb42/adafruit_circuitpython_pixelbuf-2.0.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0d24c1bd0bbd8f40041a7a505b2a09a4a8cacc32d749544bc4a6b45ec4bbf0d1",
                "md5": "f37d6759435a5a7a86c26ebef5d78e7a",
                "sha256": "a5550b26458c6763cade5ee3c0e251847fea0bccf07fe1ec464e4b835e702b9c"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_pixelbuf-2.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "f37d6759435a5a7a86c26ebef5d78e7a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 28045,
            "upload_time": "2024-10-07T22:32:14",
            "upload_time_iso_8601": "2024-10-07T22:32:14.981115Z",
            "url": "https://files.pythonhosted.org/packages/0d/24/c1bd0bbd8f40041a7a505b2a09a4a8cacc32d749544bc4a6b45ec4bbf0d1/adafruit_circuitpython_pixelbuf-2.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 22:32:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_Pixelbuf",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-pixelbuf"
}
        
Elapsed time: 0.36451s