Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-qualia/badge/?version=latest
:target: https://docs.circuitpython.org/projects/qualia/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_Qualia/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Qualia/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
Portal Style Library for the Adafruit Qualia ESP32-S3
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>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
* Adafruit Qualia ESP32-S3 for TTL RGB-666 Displays
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5800>`_
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-qualia/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-qualia
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-qualia
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-qualia
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_qualia
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
from adafruit_qualia import Qualia
from adafruit_qualia.graphics import Displays
# Set a data source URL
TEXT_URL = "http://wifitest.adafruit.com/testwifi/index.html"
# Create the PyPortal object
qualia = Qualia(Displays.SQUARE34, url=TEXT_URL)
# Go get that data
print("Fetching text from", TEXT_URL)
data = qualia.fetch()
# Print out what we got
print("-" * 40)
print(data)
print("-" * 40)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/qualia/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_Qualia/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-qualia",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,qualia,qualia,dot,clock,displays,displayio,666,RGB,TTL",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/37/21/9c67f13ccfcb078c559f070730ce42fa2597607323b9ec1e274992769944/adafruit-circuitpython-qualia-1.2.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-qualia/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/qualia/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Qualia/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Qualia/actions\n :alt: Build Status\n\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\nPortal Style Library for the Adafruit Qualia ESP32-S3\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>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n* Adafruit Qualia ESP32-S3 for TTL RGB-666 Displays\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5800>`_\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-qualia/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-qualia\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-qualia\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 .env/bin/activate\n pip3 install adafruit-circuitpython-qualia\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_qualia\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n from adafruit_qualia import Qualia\n from adafruit_qualia.graphics import Displays\n\n # Set a data source URL\n TEXT_URL = \"http://wifitest.adafruit.com/testwifi/index.html\"\n\n # Create the PyPortal object\n qualia = Qualia(Displays.SQUARE34, url=TEXT_URL)\n\n # Go get that data\n print(\"Fetching text from\", TEXT_URL)\n data = qualia.fetch()\n\n # Print out what we got\n print(\"-\" * 40)\n print(data)\n print(\"-\" * 40)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/qualia/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_Qualia/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Portal Style Library for the Adafruit Qualia ESP32-S3",
"version": "1.2.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Qualia"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"qualia",
"qualia",
"dot",
"clock",
"displays",
"displayio",
"666",
"rgb",
"ttl"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc5cff374f70fe45902ec7454e7f572c5ac78ca86b0ba97c5889dc5f8c4d6b80",
"md5": "c87acb537ca8fe65027a662721647eff",
"sha256": "ef7e4983ba70b0f4c24de10e851ab3f742d9b25ffbeee814f241a95fa72fc3f6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_qualia-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c87acb537ca8fe65027a662721647eff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21970,
"upload_time": "2023-12-18T17:21:02",
"upload_time_iso_8601": "2023-12-18T17:21:02.865966Z",
"url": "https://files.pythonhosted.org/packages/bc/5c/ff374f70fe45902ec7454e7f572c5ac78ca86b0ba97c5889dc5f8c4d6b80/adafruit_circuitpython_qualia-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37219c67f13ccfcb078c559f070730ce42fa2597607323b9ec1e274992769944",
"md5": "20685405d021fd47af34e7472465de4c",
"sha256": "3565906781d11d367c5b6c4f444f2af37e165af6d277a61aaddfe69016640516"
},
"downloads": -1,
"filename": "adafruit-circuitpython-qualia-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "20685405d021fd47af34e7472465de4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37088,
"upload_time": "2023-12-18T17:21:04",
"upload_time_iso_8601": "2023-12-18T17:21:04.183143Z",
"url": "https://files.pythonhosted.org/packages/37/21/9c67f13ccfcb078c559f070730ce42fa2597607323b9ec1e274992769944/adafruit-circuitpython-qualia-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-18 17:21:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Qualia",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-qualia"
}
JSON
