Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-portalbase/badge/?version=latest
:target: https://docs.circuitpython.org/projects/portalbase/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_PortalBase/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PortalBase/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
Base Library for the Portal-style libraries. This library only contains base classes and is not
intended to be run on its own.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit CircuitPython Bitmap Font <https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/>`_
* `Adafruit CircuitPython Connection Manager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_
* `Adafruit CircuitPython Display Text <https://github.com/adafruit/Adafruit_CircuitPython_Display_Text/>`_
* `Adafruit CircuitPython NeoPixel <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/>`_
* `Adafruit CircuitPython Adafruit IO <https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO/>`_
* `Adafruit CircuitPython MiniQR <https://github.com/adafruit/Adafruit_CircuitPython_MiniQR/>`_
* `Adafruit CircuitPython Requests <https://github.com/adafruit/Adafruit_CircuitPython_Requests/>`_
* `Adafruit CircuitPython Fake Requests <https://github.com/adafruit/Adafruit_CircuitPython_FakeRequests/>`_
* `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-portalbase/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-portalbase
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-portalbase
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-portalbase
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/portalbase/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_PortalBase/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-portalbase",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, portalbase, PyPortal, MatrixPortal, MagTag, Portal, base",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/a8/51/e24dd5ed3ace95a2e06163d2f8fb186b6232dc693fb00d8831ae847e02a4/adafruit_circuitpython_portalbase-2.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-portalbase/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/portalbase/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_PortalBase/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_PortalBase/actions\n :alt: Build Status\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\nBase Library for the Portal-style libraries. This library only contains base classes and is not\nintended to be run on its own.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit CircuitPython Bitmap Font <https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/>`_\n* `Adafruit CircuitPython Connection Manager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_\n* `Adafruit CircuitPython Display Text <https://github.com/adafruit/Adafruit_CircuitPython_Display_Text/>`_\n* `Adafruit CircuitPython NeoPixel <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/>`_\n* `Adafruit CircuitPython Adafruit IO <https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO/>`_\n* `Adafruit CircuitPython MiniQR <https://github.com/adafruit/Adafruit_CircuitPython_MiniQR/>`_\n* `Adafruit CircuitPython Requests <https://github.com/adafruit/Adafruit_CircuitPython_Requests/>`_\n* `Adafruit CircuitPython Fake Requests <https://github.com/adafruit/Adafruit_CircuitPython_FakeRequests/>`_\n* `Adafruit CircuitPython 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-portalbase/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-portalbase\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-portalbase\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-portalbase\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/portalbase/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_PortalBase/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Base Library for the Portal-style libraries.",
"version": "2.1.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PortalBase"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" portalbase",
" pyportal",
" matrixportal",
" magtag",
" portal",
" base"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "082ce62609c94ba6260af2ebed69ca804912506d21c97dbb873e1fba78bdd15d",
"md5": "c50379b1c3bc868a53e1342482cea9e0",
"sha256": "2a5472ae9f0d418dcfb9431e9b3503af558f220f2db5c10555e44f8617758341"
},
"downloads": -1,
"filename": "adafruit_circuitpython_portalbase-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c50379b1c3bc868a53e1342482cea9e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20877,
"upload_time": "2024-10-07T22:34:42",
"upload_time_iso_8601": "2024-10-07T22:34:42.539807Z",
"url": "https://files.pythonhosted.org/packages/08/2c/e62609c94ba6260af2ebed69ca804912506d21c97dbb873e1fba78bdd15d/adafruit_circuitpython_portalbase-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a851e24dd5ed3ace95a2e06163d2f8fb186b6232dc693fb00d8831ae847e02a4",
"md5": "70a12f833cf1fd6a49f28b7b2a7db637",
"sha256": "7a0f54054922136d55caa5ee79dbb4bab993b08a779f9b5c8adcbcffbbec4b62"
},
"downloads": -1,
"filename": "adafruit_circuitpython_portalbase-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "70a12f833cf1fd6a49f28b7b2a7db637",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34587,
"upload_time": "2024-10-07T22:34:44",
"upload_time_iso_8601": "2024-10-07T22:34:44.892793Z",
"url": "https://files.pythonhosted.org/packages/a8/51/e24dd5ed3ace95a2e06163d2f8fb186b6232dc693fb00d8831ae847e02a4/adafruit_circuitpython_portalbase-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:34:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_PortalBase",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka-displayio",
"specs": []
},
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-bitmap-font",
"specs": []
},
{
"name": "adafruit-circuitpython-connectionmanager",
"specs": []
},
{
"name": "adafruit-circuitpython-display-text",
"specs": []
},
{
"name": "adafruit-circuitpython-neopixel",
"specs": []
},
{
"name": "adafruit-circuitpython-adafruitio",
"specs": []
},
{
"name": "adafruit-circuitpython-miniqr",
"specs": []
},
{
"name": "adafruit-circuitpython-requests",
"specs": []
},
{
"name": "adafruit-circuitpython-fakerequests",
"specs": []
},
{
"name": "adafruit-circuitpython-simpleio",
"specs": []
}
],
"lcname": "adafruit-circuitpython-portalbase"
}
JSON
