Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-radial_controller/badge/?version=latest
:target: https://docs.circuitpython.org/projects/radial_controller/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_Radial_Controller/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Radial_Controller/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
HID Radial Controller device helper library
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-radial_controller/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-radial-controller
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-radial-controller
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-radial-controller
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_radial_controller
Or the following command to update an existing version:
.. code-block:: shell
circup update
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/radial_controller/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_Radial_Controller/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-radial-controller",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, radial_controller, HID, radial, controller",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/32/3b/6793b8b8116c82e8321d7756f1f94e1142aed87a2c0eb69d87af16006222/adafruit_circuitpython_radial_controller-1.0.13.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-radial_controller/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/radial_controller/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_Radial_Controller/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Radial_Controller/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\nHID Radial Controller device helper library\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=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-radial_controller/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-radial-controller\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-radial-controller\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-radial-controller\n\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_radial_controller\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/radial_controller/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_Radial_Controller/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "HID Radial Controller device helper library",
"version": "1.0.13",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Radial_Controller.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" radial_controller",
" hid",
" radial",
" controller"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1becfc6dab014b58f59c4d9ec195f712ccb609b8378964918ebce1fdb07ce397",
"md5": "9ed5f7cb127a0d7c5417979ab52ce4d3",
"sha256": "4e0bb882f6b86ce81614161bfe40171c6bcecc6f4deae7f446ea481b354a34bb"
},
"downloads": -1,
"filename": "adafruit_circuitpython_radial_controller-1.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9ed5f7cb127a0d7c5417979ab52ce4d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6304,
"upload_time": "2024-10-07T22:34:57",
"upload_time_iso_8601": "2024-10-07T22:34:57.852254Z",
"url": "https://files.pythonhosted.org/packages/1b/ec/fc6dab014b58f59c4d9ec195f712ccb609b8378964918ebce1fdb07ce397/adafruit_circuitpython_radial_controller-1.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "323b6793b8b8116c82e8321d7756f1f94e1142aed87a2c0eb69d87af16006222",
"md5": "0db63af1b3db4249d893dc5a289b6fef",
"sha256": "e303b2bb008d38ea4e40cecabfae655e164d1768e872ab5a87cd006dc7a2b5f1"
},
"downloads": -1,
"filename": "adafruit_circuitpython_radial_controller-1.0.13.tar.gz",
"has_sig": false,
"md5_digest": "0db63af1b3db4249d893dc5a289b6fef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27341,
"upload_time": "2024-10-07T22:35:00",
"upload_time_iso_8601": "2024-10-07T22:35:00.225725Z",
"url": "https://files.pythonhosted.org/packages/32/3b/6793b8b8116c82e8321d7756f1f94e1142aed87a2c0eb69d87af16006222/adafruit_circuitpython_radial_controller-1.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:35:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Radial_Controller",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-hid",
"specs": []
}
],
"lcname": "adafruit-circuitpython-radial-controller"
}
JSON
