Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-si5351/badge/?version=latest
:target: https://docs.circuitpython.org/projects/si5351/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_SI5351/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SI5351/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
SI5351 clock generator module.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
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-si5351/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-si5351
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-si5351
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-si5351
Usage Example
=============
See examples/simpletest.py for a demo of the usage.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/si5351/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_SI5351/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-si5351",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, si5351, clock, generator, module, breakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/f6/82/57ebeaf75ddf0ffb7f6a48de2c3f31adba965c5c4ce540df7cf58c5a5ba1/adafruit-circuitpython-si5351-1.4.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-si5351/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/si5351/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_SI5351/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SI5351/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\nSI5351 clock generator module.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\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====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-si5351/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-si5351\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-si5351\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-si5351\n\nUsage Example\n=============\n\nSee examples/simpletest.py for a demo of the usage.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/si5351/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_SI5351/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for SI5351 clock generator module.",
"version": "1.4.4",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SI5351"
},
"split_keywords": [
"adafruit",
" si5351",
" clock",
" generator",
" module",
" breakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a129078142ddf8cbefa6e38123c668a6d6fb38f958459e411233b566f47a36ed",
"md5": "f2e153f590241acc90917007d12d95d8",
"sha256": "66b879d883543e03cc58ebc48e271b30ff93a5d98bf77c138fe526c921a383d1"
},
"downloads": -1,
"filename": "adafruit_circuitpython_si5351-1.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f2e153f590241acc90917007d12d95d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8346,
"upload_time": "2024-03-19T22:10:25",
"upload_time_iso_8601": "2024-03-19T22:10:25.860577Z",
"url": "https://files.pythonhosted.org/packages/a1/29/078142ddf8cbefa6e38123c668a6d6fb38f958459e411233b566f47a36ed/adafruit_circuitpython_si5351-1.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f68257ebeaf75ddf0ffb7f6a48de2c3f31adba965c5c4ce540df7cf58c5a5ba1",
"md5": "af0d0dc938f5aa15a6e625459e9ce30a",
"sha256": "6a3fc604b2d9dd32791f0c0c42c9723e68f0fdfa1c136041300cf448db7a7a1b"
},
"downloads": -1,
"filename": "adafruit-circuitpython-si5351-1.4.4.tar.gz",
"has_sig": false,
"md5_digest": "af0d0dc938f5aa15a6e625459e9ce30a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30291,
"upload_time": "2024-03-19T22:10:27",
"upload_time_iso_8601": "2024-03-19T22:10:27.846573Z",
"url": "https://files.pythonhosted.org/packages/f6/82/57ebeaf75ddf0ffb7f6a48de2c3f31adba965c5c4ce540df7cf58c5a5ba1/adafruit-circuitpython-si5351-1.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 22:10:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SI5351",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-si5351"
}
JSON
