Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-anchored-tilegrid/badge/?version=latest
:target: https://docs.circuitpython.org/projects/anchored_tilegrid/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_Anchored_TileGrid/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Anchored_TileGrid/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
TileGrid subclass that can be placed relative to an arbitrary anchor point.
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-anchored-tilegrid/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-anchored-tilegrid
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-anchored-tilegrid
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-anchored-tilegrid
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_anchored_tilegrid
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
speech_blurb_bmp = OnDiskBitmap("example_image.bmp")
speech_blurb = AnchoredTileGrid(bitmap=speech_blurb_bmp, pixel_shader=speech_blurb_bmp.pixel_shader)
speech_blurb.anchor_point = (0.18, 1.0)
speech_blurb.anchored_position = (60, 150)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/anchored_tilegrid/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_Anchored_TileGrid/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-anchored-tilegrid",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, anchored_tilegrid, displayio, tilegrid, position, anchor, anchor_point, anchored_position",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ec/5d/700a8db4ead866426bef1d35a36ad89e3a5e15b879231f3216a751e725f1/adafruit_circuitpython_anchored_tilegrid-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-anchored-tilegrid/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/anchored_tilegrid/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_Anchored_TileGrid/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Anchored_TileGrid/actions\n :alt: Build Status\n\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\nTileGrid subclass that can be placed relative to an arbitrary anchor point.\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-anchored-tilegrid/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-anchored-tilegrid\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-anchored-tilegrid\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 .env/bin/activate\n pip3 install adafruit-circuitpython-anchored-tilegrid\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_anchored_tilegrid\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n speech_blurb_bmp = OnDiskBitmap(\"example_image.bmp\")\n speech_blurb = AnchoredTileGrid(bitmap=speech_blurb_bmp, pixel_shader=speech_blurb_bmp.pixel_shader)\n speech_blurb.anchor_point = (0.18, 1.0)\n speech_blurb.anchored_position = (60, 150)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/anchored_tilegrid/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_Anchored_TileGrid/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "TileGrid subclass that can be placed relative to an arbitrary anchor point.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Anchored_TileGrid"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" anchored_tilegrid",
" displayio",
" tilegrid",
" position",
" anchor",
" anchor_point",
" anchored_position"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20140a453f22ccd5bf1660a48184aa9e46a6fc072eef4787240e59bb43099074",
"md5": "91cfffc53155af9b2c6a736f793c7b22",
"sha256": "61b04abeaf749cff63aa56d1e591f3c4adeeabb0aba3cbea1fab223852a5e027"
},
"downloads": -1,
"filename": "adafruit_circuitpython_anchored_tilegrid-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "91cfffc53155af9b2c6a736f793c7b22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4776,
"upload_time": "2024-10-15T19:35:59",
"upload_time_iso_8601": "2024-10-15T19:35:59.902830Z",
"url": "https://files.pythonhosted.org/packages/20/14/0a453f22ccd5bf1660a48184aa9e46a6fc072eef4787240e59bb43099074/adafruit_circuitpython_anchored_tilegrid-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec5d700a8db4ead866426bef1d35a36ad89e3a5e15b879231f3216a751e725f1",
"md5": "e34fec51411287e90f4b5d62dd83d71c",
"sha256": "07309a698a78ceb0826d63dd98c4fbc07aa2a5389e192bc4e1bc45ea98f96a2f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_anchored_tilegrid-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e34fec51411287e90f4b5d62dd83d71c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23699,
"upload_time": "2024-10-15T19:36:01",
"upload_time_iso_8601": "2024-10-15T19:36:01.224557Z",
"url": "https://files.pythonhosted.org/packages/ec/5d/700a8db4ead866426bef1d35a36ad89e3a5e15b879231f3216a751e725f1/adafruit_circuitpython_anchored_tilegrid-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 19:36:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Anchored_TileGrid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-anchored-tilegrid"
}
JSON
