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/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
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/27/91/5e205366fe120dff745986e124e34303e2e0bf637cc56d1ce5b017fb1c6d/adafruit_circuitpython_framebuf-1.6.10.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/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\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.10",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_framebuf"
},
"split_keywords": [
"adafruit",
" display",
" framebuf",
" framebuffer",
" software",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f6222c22b856b522afaff40ecb21f21b2689bd5cb0a281f9ffb7bda3fc452276",
"md5": "5e2af4f6bbe96d771caa50bc9fcfc7dc",
"sha256": "5938f34d10f05202e2369b84447d91742c84f51bc31aff0c5ef4e85728aa2b6a"
},
"downloads": -1,
"filename": "adafruit_circuitpython_framebuf-1.6.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e2af4f6bbe96d771caa50bc9fcfc7dc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9139,
"upload_time": "2025-10-20T20:45:07",
"upload_time_iso_8601": "2025-10-20T20:45:07.135073Z",
"url": "https://files.pythonhosted.org/packages/f6/22/2c22b856b522afaff40ecb21f21b2689bd5cb0a281f9ffb7bda3fc452276/adafruit_circuitpython_framebuf-1.6.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "27915e205366fe120dff745986e124e34303e2e0bf637cc56d1ce5b017fb1c6d",
"md5": "2d8d396ac67f78f9cc52c7e19f718add",
"sha256": "a8e83c3eab5fd3ef134a805f560e64a6703039e6ed2619d8b00f2b86683145db"
},
"downloads": -1,
"filename": "adafruit_circuitpython_framebuf-1.6.10.tar.gz",
"has_sig": false,
"md5_digest": "2d8d396ac67f78f9cc52c7e19f718add",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34162,
"upload_time": "2025-10-20T20:45:08",
"upload_time_iso_8601": "2025-10-20T20:45:08.897148Z",
"url": "https://files.pythonhosted.org/packages/27/91/5e205366fe120dff745986e124e34303e2e0bf637cc56d1ce5b017fb1c6d/adafruit_circuitpython_framebuf-1.6.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 20:45:08",
"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": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-framebuf"
}
JSON
