Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-rotaryselect/badge/?version=latest
:target: https://circuitpython-rotaryselect.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/foamyguy/CircuitPython_RotarySelect/workflows/Build%20CI/badge.svg
:target: https://github.com/foamyguy/CircuitPython_RotarySelect/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
A circular rotary selection widget
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/circuitpython-rotaryselect/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-rotaryselect
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-rotaryselect
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 circuitpython-rotaryselect
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 rotaryselect
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See examples/rotaryselect_simpletest.py
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-rotaryselect.readthedocs.io/>`_.
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/foamyguy/CircuitPython_RotarySelect/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "circuitpython-rotaryselect",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, rotaryselect, GUI, widget, displayio, select, rotary, dial, circle, menu, selector",
"author": null,
"author_email": "foamyguy <foamyguy@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/37/b0/fe5eebc130197e4626ab985b85e89e60091a980577f10bed53716c0e78d6/circuitpython_rotaryselect-1.0.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-rotaryselect/badge/?version=latest\n :target: https://circuitpython-rotaryselect.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/foamyguy/CircuitPython_RotarySelect/workflows/Build%20CI/badge.svg\n :target: https://github.com/foamyguy/CircuitPython_RotarySelect/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\nA circular rotary selection widget\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\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/circuitpython-rotaryselect/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-rotaryselect\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-rotaryselect\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 circuitpython-rotaryselect\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 rotaryselect\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee examples/rotaryselect_simpletest.py\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-rotaryselect.readthedocs.io/>`_.\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/foamyguy/CircuitPython_RotarySelect/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A circular rotary selection widget",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/foamyguy/CircuitPython_RotarySelect"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" rotaryselect",
" gui",
" widget",
" displayio",
" select",
" rotary",
" dial",
" circle",
" menu",
" selector"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0023f7cd56b9cfd1765c571f35819b9fd09f4193ed6cc215891845d1c234ff0",
"md5": "0f0bd0f6e3a95c6ab11bb2434fc03f62",
"sha256": "c8411b690da5c2afc6af8f0b529c75ba6a1314b30ee671f5e6d63d800d73627f"
},
"downloads": -1,
"filename": "circuitpython_rotaryselect-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f0bd0f6e3a95c6ab11bb2434fc03f62",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5732,
"upload_time": "2024-08-25T19:00:54",
"upload_time_iso_8601": "2024-08-25T19:00:54.100754Z",
"url": "https://files.pythonhosted.org/packages/a0/02/3f7cd56b9cfd1765c571f35819b9fd09f4193ed6cc215891845d1c234ff0/circuitpython_rotaryselect-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37b0fe5eebc130197e4626ab985b85e89e60091a980577f10bed53716c0e78d6",
"md5": "9c018362a731e4b859b07e161cdb883d",
"sha256": "b447fc156a618f2952a5d433a49cd8b836441f85260f89a9f5f5d2f31f64cf53"
},
"downloads": -1,
"filename": "circuitpython_rotaryselect-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9c018362a731e4b859b07e161cdb883d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34497,
"upload_time": "2024-08-25T19:00:55",
"upload_time_iso_8601": "2024-08-25T19:00:55.317454Z",
"url": "https://files.pythonhosted.org/packages/37/b0/fe5eebc130197e4626ab985b85e89e60091a980577f10bed53716c0e78d6/circuitpython_rotaryselect-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 19:00:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "foamyguy",
"github_project": "CircuitPython_RotarySelect",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-rotaryselect"
}
JSON
