Introduction
============
.. image:: https://readthedocs.org/projects/cursorcontrol/badge/?version=latest
:target: https://docs.circuitpython.org/projects/cursorcontrol/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_CursorControl/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_CursorControl/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
Mouse cursor for interaction with CircuitPython UI elements such as
`buttons <https://github.com/adafruit/Adafruit_CircuitPython_Display_Button>`_.
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-cursorcontrol/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-cursorcontrol
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-cursorcontrol
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-cursorcontrol
Usage Example
=============
See examples in examples/ folder.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/cursorcontrol/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_CursorControl/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-cursorcontrol",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, cursorcontrol, mouse, , cursor, , ui",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/9a/10/f8272468df42e7de77f7ab8326733820471d92d63fb3031111451c542fac/adafruit_circuitpython_cursorcontrol-2.9.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/cursorcontrol/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/cursorcontrol/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_CursorControl/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_CursorControl/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\nMouse cursor for interaction with CircuitPython UI elements such as\n`buttons <https://github.com/adafruit/Adafruit_CircuitPython_Display_Button>`_.\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=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-cursorcontrol/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-cursorcontrol\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-cursorcontrol\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-cursorcontrol\n\nUsage Example\n=============\n\nSee examples in examples/ folder.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/cursorcontrol/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_CursorControl/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mouse cursor for interaction with CircuitPython UI elements.",
"version": "2.9.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_CursorControl"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" cursorcontrol",
" mouse",
" ",
" cursor",
" ",
" ui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "937de038450289382dbc870fc3e5e838cfb2e1d9d3bf4906fcfbd56df0fe4550",
"md5": "d7b35752caa6554009ca8fd846fd7bc5",
"sha256": "39cbc18d177aff13ecb16b0b1a8658d119c846be45a2969503c4f49d5ecfcc96"
},
"downloads": -1,
"filename": "adafruit_circuitpython_cursorcontrol-2.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7b35752caa6554009ca8fd846fd7bc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8685,
"upload_time": "2024-11-13T20:26:16",
"upload_time_iso_8601": "2024-11-13T20:26:16.657342Z",
"url": "https://files.pythonhosted.org/packages/93/7d/e038450289382dbc870fc3e5e838cfb2e1d9d3bf4906fcfbd56df0fe4550/adafruit_circuitpython_cursorcontrol-2.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9a10f8272468df42e7de77f7ab8326733820471d92d63fb3031111451c542fac",
"md5": "15d5bd1893d96c2f3b96cd97671dee92",
"sha256": "aa74895e5b82b560b19afc36c604e7ec78d449cdae12486a4004166025bf0d79"
},
"downloads": -1,
"filename": "adafruit_circuitpython_cursorcontrol-2.9.0.tar.gz",
"has_sig": false,
"md5_digest": "15d5bd1893d96c2f3b96cd97671dee92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30301,
"upload_time": "2024-11-13T20:26:18",
"upload_time_iso_8601": "2024-11-13T20:26:18.778816Z",
"url": "https://files.pythonhosted.org/packages/9a/10/f8272468df42e7de77f7ab8326733820471d92d63fb3031111451c542fac/adafruit_circuitpython_cursorcontrol-2.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 20:26:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_CursorControl",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-cursorcontrol"
}
JSON
