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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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>`_
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": "",
"name": "adafruit-circuitpython-portalbase",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,portalbase,PyPortal,MatrixPortal,MagTag,Portal,base",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/71/84/0d20398f7b906b1cdd130e2ca8cd1435cb43f884127c3302c32904a17b24/adafruit-circuitpython-portalbase-2.0.0.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/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\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\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.0.0",
"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": "a9826c3e6bb811a6dc3af4ab60ad5fa512883b4f31ccd68bbfa91cd3686a2022",
"md5": "3f47a1959137408b62e79764b6f3bee3",
"sha256": "d4ddda9ca48fb2921d74d77d5580f80d8398bf425b55e81c152a6c97ef356a95"
},
"downloads": -1,
"filename": "adafruit_circuitpython_portalbase-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f47a1959137408b62e79764b6f3bee3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20861,
"upload_time": "2024-02-26T15:25:53",
"upload_time_iso_8601": "2024-02-26T15:25:53.049895Z",
"url": "https://files.pythonhosted.org/packages/a9/82/6c3e6bb811a6dc3af4ab60ad5fa512883b4f31ccd68bbfa91cd3686a2022/adafruit_circuitpython_portalbase-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71840d20398f7b906b1cdd130e2ca8cd1435cb43f884127c3302c32904a17b24",
"md5": "c81f4e2357efc8b3bba3c7a061212b7d",
"sha256": "ec4bc1caf9d1fe29a8eee19317a5857434d74f0f5ba9fc001ff98cb8bb7d699a"
},
"downloads": -1,
"filename": "adafruit-circuitpython-portalbase-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "c81f4e2357efc8b3bba3c7a061212b7d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38153,
"upload_time": "2024-02-26T15:25:55",
"upload_time_iso_8601": "2024-02-26T15:25:55.119527Z",
"url": "https://files.pythonhosted.org/packages/71/84/0d20398f7b906b1cdd130e2ca8cd1435cb43f884127c3302c32904a17b24/adafruit-circuitpython-portalbase-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 15:25:55",
"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": [],
"lcname": "adafruit-circuitpython-portalbase"
}