Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-analog-clock/badge/?version=latest
:target: https://docs.circuitpython.org/projects/display-analogclock/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_Display_AnalogClock/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Display_AnalogClock/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
Draw a traditional 12-hour analog clock face with hour and minute hands. Allows you to provide graphics to customize the clock.
Dependencies
=============
This library depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit Display Text <https://github.com/adafruit/Adafruit_CircuitPython_display_text>`_
* `Adafruit ImageLoad <https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/>`_
* `Adafruit Anchored TileGrid <https://github.com/adafruit/Adafruit_CircuitPython_Anchored_TileGrid>`_
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-display-analogclock/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-display-analogclock
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-display-analogclock
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-display-analogclock
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_display_analogclock
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import board
from adafruit_display_analogclock import AnalogClock
display = board.DISPLAY
plain_clockface = AnalogClock(
"green_hour_hand.bmp",
"green_minute_hand.bmp",
(120, 120),
106,
number_label_scale=2,
number_label_color=0x00FF00,
)
display.root_group = plain_clockface
plain_clockface.set_time(3, 30)
while True:
pass
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/display_analogclock/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_Display_AnalogClock/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-display-analogclock",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, display_analogclock, clock, clockface, analog, analogclock, analogclockface, time, hours, minutes",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/de/73/4d6591bafa17448143c3fa63746c8bad455636fe0742b392968a4a0d07c5/adafruit_circuitpython_display_analogclock-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-analog-clock/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/display-analogclock/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_Display_AnalogClock/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Display_AnalogClock/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\nDraw a traditional 12-hour analog clock face with hour and minute hands. Allows you to provide graphics to customize the clock.\n\n\nDependencies\n=============\nThis library depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit Display Text <https://github.com/adafruit/Adafruit_CircuitPython_display_text>`_\n* `Adafruit ImageLoad <https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad/>`_\n* `Adafruit Anchored TileGrid <https://github.com/adafruit/Adafruit_CircuitPython_Anchored_TileGrid>`_\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-display-analogclock/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-display-analogclock\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-display-analogclock\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-display-analogclock\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_display_analogclock\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 import board\n\n from adafruit_display_analogclock import AnalogClock\n\n display = board.DISPLAY\n\n plain_clockface = AnalogClock(\n \"green_hour_hand.bmp\",\n \"green_minute_hand.bmp\",\n (120, 120),\n 106,\n number_label_scale=2,\n number_label_color=0x00FF00,\n )\n\n display.root_group = plain_clockface\n\n plain_clockface.set_time(3, 30)\n\n while True:\n pass\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/display_analogclock/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_Display_AnalogClock/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Draw a traditional 12-hour analog clock face with hour and minute hands. Allows you to provide graphics to customize the clock.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Display_AnalogClock"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" display_analogclock",
" clock",
" clockface",
" analog",
" analogclock",
" analogclockface",
" time",
" hours",
" minutes"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "65e2e3c6f5f959e6532103ca88405a81a82f017fcd824142fa6993d532fe3da1",
"md5": "62a3d24669671c600d1333ebff2537fa",
"sha256": "b5806f3ce828f3ac7870cdb60ae695ecdfb50f2f6537ac0ede33e60fe4e2964b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_display_analogclock-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "62a3d24669671c600d1333ebff2537fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6061,
"upload_time": "2025-02-11T21:19:32",
"upload_time_iso_8601": "2025-02-11T21:19:32.969491Z",
"url": "https://files.pythonhosted.org/packages/65/e2/e3c6f5f959e6532103ca88405a81a82f017fcd824142fa6993d532fe3da1/adafruit_circuitpython_display_analogclock-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "de734d6591bafa17448143c3fa63746c8bad455636fe0742b392968a4a0d07c5",
"md5": "483a0fe366cee7fc948d7926b865c4e3",
"sha256": "0dedc1fd935635457e565525aec9ad7126f9cc889e88cc1c06cefa9c1be0e04c"
},
"downloads": -1,
"filename": "adafruit_circuitpython_display_analogclock-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "483a0fe366cee7fc948d7926b865c4e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24302,
"upload_time": "2025-02-11T21:19:36",
"upload_time_iso_8601": "2025-02-11T21:19:36.040256Z",
"url": "https://files.pythonhosted.org/packages/de/73/4d6591bafa17448143c3fa63746c8bad455636fe0742b392968a4a0d07c5/adafruit_circuitpython_display_analogclock-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-11 21:19:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Display_AnalogClock",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-display-text",
"specs": []
},
{
"name": "adafruit-circuitpython-anchored-tilegrid",
"specs": []
},
{
"name": "adafruit-circuitpython-imageload",
"specs": []
}
],
"lcname": "adafruit-circuitpython-display-analogclock"
}
JSON
