Introduction
============
.. image:: https://readthedocs.org/projects/fona/badge/?version=latest
:target: https://docs.circuitpython.org/projects/fona/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_FONA/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_FONA/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 library for the `Adafruit FONA <https://www.adafruit.com/index.php?main_page=category&cPath=281>`_ cellular module.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `SimpleIO <https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO>`_
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
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-fona/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-fona
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-fona
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-fona
Usage Example
=============
Please see the examples directory for code usage.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fona/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_FONA/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-fona",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,fona,fona,,cellular",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/c4/dc/a79d8d97a026156c1c5cd668c505ae72e214e14251327410a3a7064e35e7/adafruit-circuitpython-fona-3.0.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/fona/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/fona/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_FONA/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_FONA/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 library for the `Adafruit FONA <https://www.adafruit.com/index.php?main_page=category&cPath=281>`_ cellular module.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `SimpleIO <https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO>`_\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\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-fona/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-fona\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-fona\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-fona\n\nUsage Example\n=============\n\nPlease see the examples directory for code usage.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fona/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_FONA/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for the Adafruit FONAA",
"version": "3.0.4",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_FONA"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"fona",
"fona",
"",
"cellular"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a907eb82f275fe2e9a879e832ff5d8856d990181b4064db17ee588120abe6416",
"md5": "2168c1e4fadb14bf0496ba8b5311656b",
"sha256": "d8511ad87c7a482211bc1f9a542fb3d3b814742ed02c956d5cc0cda2753fedd5"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fona-3.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2168c1e4fadb14bf0496ba8b5311656b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18216,
"upload_time": "2024-03-04T18:25:40",
"upload_time_iso_8601": "2024-03-04T18:25:40.372264Z",
"url": "https://files.pythonhosted.org/packages/a9/07/eb82f275fe2e9a879e832ff5d8856d990181b4064db17ee588120abe6416/adafruit_circuitpython_fona-3.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4dca79d8d97a026156c1c5cd668c505ae72e214e14251327410a3a7064e35e7",
"md5": "0ead09fde3f03da3c3d2af930c1ebfd9",
"sha256": "2ba1a9b36f66681b1e3686d8e796b506a82fafde30e5e414b8e0460d9fe785a2"
},
"downloads": -1,
"filename": "adafruit-circuitpython-fona-3.0.4.tar.gz",
"has_sig": false,
"md5_digest": "0ead09fde3f03da3c3d2af930c1ebfd9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38922,
"upload_time": "2024-03-04T18:25:41",
"upload_time_iso_8601": "2024-03-04T18:25:41.762142Z",
"url": "https://files.pythonhosted.org/packages/c4/dc/a79d8d97a026156c1c5cd668c505ae72e214e14251327410a3a7064e35e7/adafruit-circuitpython-fona-3.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 18:25:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_FONA",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-fona"
}
JSON
