Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-framebuf/badge/?version=latest
:target: https://docs.circuitpython.org/projects/framebuf/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_framebuf/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_framebuf/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 framebuf module, based on the Python framebuf module.
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-framebuf/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-framebuf
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-framebuf
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-framebuf
Usage Example
=============
See example in /examples/framebuf_simpletest.py
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/framebuf/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_framebuf/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-framebuf",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, display, framebuf, framebuffer, software, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/7f/9e/7f9b3f7931009d0d603012ab6e742d28a28f091fa1817d3de58c11ebc2ce/adafruit_circuitpython_framebuf-1.6.6.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-framebuf/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/framebuf/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_framebuf/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_framebuf/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 framebuf module, based on the Python framebuf module.\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-framebuf/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-framebuf\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-framebuf\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-framebuf\n\nUsage Example\n=============\n\nSee example in /examples/framebuf_simpletest.py\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/framebuf/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_framebuf/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython frambuf module, based on the Python frambuf module.",
"version": "1.6.6",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_framebuf"
},
"split_keywords": [
"adafruit",
" display",
" framebuf",
" framebuffer",
" software",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e66319fe3552fc24593958970462e7e850fea47a67676ea0c7c946c1b510cbe",
"md5": "e7d025fd55d5a144065749b147d6748a",
"sha256": "f2d6766c731ab856f33b61c3d6a2339a3ff6f12721331537f573adf357450cbf"
},
"downloads": -1,
"filename": "adafruit_circuitpython_framebuf-1.6.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e7d025fd55d5a144065749b147d6748a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9204,
"upload_time": "2024-10-07T22:30:41",
"upload_time_iso_8601": "2024-10-07T22:30:41.286738Z",
"url": "https://files.pythonhosted.org/packages/1e/66/319fe3552fc24593958970462e7e850fea47a67676ea0c7c946c1b510cbe/adafruit_circuitpython_framebuf-1.6.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f9e7f9b3f7931009d0d603012ab6e742d28a28f091fa1817d3de58c11ebc2ce",
"md5": "53181321374794750269a4cc89001f71",
"sha256": "5600be1ddf253dbed5f40416d280edafb2256c53654798fb6c4d979b26cdde6e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_framebuf-1.6.6.tar.gz",
"has_sig": false,
"md5_digest": "53181321374794750269a4cc89001f71",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37433,
"upload_time": "2024-10-07T22:30:42",
"upload_time_iso_8601": "2024-10-07T22:30:42.638843Z",
"url": "https://files.pythonhosted.org/packages/7f/9e/7f9b3f7931009d0d603012ab6e742d28a28f091fa1817d3de58c11ebc2ce/adafruit_circuitpython_framebuf-1.6.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:30:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_framebuf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-framebuf"
}
JSON
