Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rockblock/badge/?version=latest
:target: https://docs.circuitpython.org/projects/rockblock/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_RockBlock/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_RockBlock/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
CircuitPython driver for Rock Seven RockBLOCK Iridium satellite modem
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>`_.
Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
as a standard element. Stay tuned for PyPI availability!
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-rockblock/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-rockblock
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-rockblock
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-rockblock
Usage Example
=============
.. code-block:: python
import board
import busio
# more later
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/rockblock/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_RockBlock/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-rockblock",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,rockblock,iridium,,satellite",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/66/86/8dbce717c293a769ad677e7a83db7074c904288ed992c3ca0698d9750b7c/adafruit-circuitpython-rockblock-1.3.15.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rockblock/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/rockblock/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_RockBlock/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_RockBlock/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\nCircuitPython driver for Rock Seven RockBLOCK Iridium satellite modem\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>`_.\n\nInstalling from PyPI\n=====================\n.. note:: This library is not available on PyPI yet. Install documentation is included\n as a standard element. Stay tuned for PyPI availability!\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-rockblock/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-rockblock\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-rockblock\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-rockblock\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import busio\n # more later\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/rockblock/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_RockBlock/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for Rock Seven RockBLOCK Iridium satellite modem",
"version": "1.3.15",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_RockBlock"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"rockblock",
"iridium",
"",
"satellite"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c62a40f4346648b06b5b28a49f8761e91a24161eab3b87f73d23c1301cbf15a1",
"md5": "c82c51330850cd35bd24058cc668a6bf",
"sha256": "89676df3fecdfb690823559c4c079559760492d1725660d029367e44a43c2f1f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_rockblock-1.3.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c82c51330850cd35bd24058cc668a6bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8526,
"upload_time": "2023-12-09T17:33:11",
"upload_time_iso_8601": "2023-12-09T17:33:11.757337Z",
"url": "https://files.pythonhosted.org/packages/c6/2a/40f4346648b06b5b28a49f8761e91a24161eab3b87f73d23c1301cbf15a1/adafruit_circuitpython_rockblock-1.3.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66868dbce717c293a769ad677e7a83db7074c904288ed992c3ca0698d9750b7c",
"md5": "cbbad7fa95e37373c8c7d58e9b374fef",
"sha256": "50026c90caccf74d2b72036fd1bf39f7eedff626f31689c58250628c3cbbf9ba"
},
"downloads": -1,
"filename": "adafruit-circuitpython-rockblock-1.3.15.tar.gz",
"has_sig": false,
"md5_digest": "cbbad7fa95e37373c8c7d58e9b374fef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30544,
"upload_time": "2023-12-09T17:33:13",
"upload_time_iso_8601": "2023-12-09T17:33:13.878294Z",
"url": "https://files.pythonhosted.org/packages/66/86/8dbce717c293a769ad677e7a83db7074c904288ed992c3ca0698d9750b7c/adafruit-circuitpython-rockblock-1.3.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:33:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_RockBlock",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-rockblock"
}
JSON
