Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ntp/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ntp/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_NTP/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_NTP/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
Network Time Protocol (NTP) helper for CircuitPython.
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-ntp/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ntp
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ntp
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-ntp
Usage Example
=============
.. code-block:: python
import adafruit_connection_manager
import adafruit_ntp
import os
import time
import wifi
wifi_ssid = os.getenv("CIRCUITPY_WIFI_SSID")
wifi_password = os.getenv("CIRCUITPY_WIFI_PASSWORD")
wifi.radio.connect(wifi_ssid, wifi_password)
pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)
ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)
while True:
print(ntp.datetime)
time.sleep(1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ntp/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_NTP/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ntp",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, ntp, ntp, , network, , time",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d1/15/ed2a8a6b4704e9ebb558a63d03be72f3e9a77b4b61a22e79c33013587ba3/adafruit_circuitpython_ntp-3.3.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ntp/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ntp/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_NTP/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_NTP/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\nNetwork Time Protocol (NTP) helper for CircuitPython.\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://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-ntp/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ntp\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ntp\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-ntp\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import adafruit_connection_manager\n import adafruit_ntp\n import os\n import time\n import wifi\n\n wifi_ssid = os.getenv(\"CIRCUITPY_WIFI_SSID\")\n wifi_password = os.getenv(\"CIRCUITPY_WIFI_PASSWORD\")\n wifi.radio.connect(wifi_ssid, wifi_password)\n\n pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio)\n ntp = adafruit_ntp.NTP(pool, tz_offset=0, cache_seconds=3600)\n\n while True:\n print(ntp.datetime)\n time.sleep(1)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ntp/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_NTP/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Network Time Protocol (NTP) helper for Python",
"version": "3.3.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_NTP"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" ntp",
" ntp",
" ",
" network",
" ",
" time"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fdaa0c06aeae8c45d9d54db8250fd5634f0ec6e8ee89ee084a610c639e62b34c",
"md5": "5a495a0ba8cdf1883617336d21caa1cd",
"sha256": "f33471e91c97fce5ce75876a9965ec1011791fe2e276eaa5b3a7eba7716b8cf5"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ntp-3.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a495a0ba8cdf1883617336d21caa1cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5545,
"upload_time": "2024-10-07T22:31:55",
"upload_time_iso_8601": "2024-10-07T22:31:55.491348Z",
"url": "https://files.pythonhosted.org/packages/fd/aa/0c06aeae8c45d9d54db8250fd5634f0ec6e8ee89ee084a610c639e62b34c/adafruit_circuitpython_ntp-3.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d115ed2a8a6b4704e9ebb558a63d03be72f3e9a77b4b61a22e79c33013587ba3",
"md5": "70b53d89066e1e622347f8d81bd15121",
"sha256": "b528e7fd187defc22e14747c030ec7cb791907732d6020b14eb3e1b09e819ec6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ntp-3.3.1.tar.gz",
"has_sig": false,
"md5_digest": "70b53d89066e1e622347f8d81bd15121",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27495,
"upload_time": "2024-10-07T22:31:56",
"upload_time_iso_8601": "2024-10-07T22:31:56.356613Z",
"url": "https://files.pythonhosted.org/packages/d1/15/ed2a8a6b4704e9ebb558a63d03be72f3e9a77b4b61a22e79c33013587ba3/adafruit_circuitpython_ntp-3.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:31:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_NTP",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ntp"
}
JSON
