Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-typing/badge/?version=latest
:target: https://docs.circuitpython.org/projects/adafruit-circuitpython-typing/en/latest/
:alt: Documentation Status
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Typing/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Typing/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
Definitions not in the standard `typing` module that are
needed for type annotation of CircuitPython code.
This library is not needed at runtime for CircuitPython code, and does not need to be in the bundle.
Dependencies
=============
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-typing/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-typing
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-typing
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-typing
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/adafruit-circuitpython-typing/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_Typing/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-typing",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, circuitpython_typing",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ed/60/9fb9c83a32b3508b287e686293fb92038760b314d106cf6bfd17efc6dee6/adafruit_circuitpython_typing-1.11.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-typing/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/adafruit-circuitpython-typing/en/latest/\n :alt: Documentation Status\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Typing/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Typing/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\nDefinitions not in the standard `typing` module that are\nneeded for type annotation of CircuitPython code.\n\nThis library is not needed at runtime for CircuitPython code, and does not need to be in the bundle.\n\n\nDependencies\n=============\n\n\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-typing/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-typing\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-typing\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-typing\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/adafruit-circuitpython-typing/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_Typing/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Types needed for type annotation that are not in `typing`",
"version": "1.11.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Typing"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" circuitpython_typing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5fa088d9210a0c2bcf4ae6819d791f9e912ca405ddab25763df6b1b27a9acdfb",
"md5": "9b5d61cfe639236960ebcc58b0f039bd",
"sha256": "c223b56538c9535e6ecc45fb39b23acab6840fecf068a85c6a340cb42368d413"
},
"downloads": -1,
"filename": "adafruit_circuitpython_typing-1.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b5d61cfe639236960ebcc58b0f039bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11098,
"upload_time": "2024-10-10T15:52:09",
"upload_time_iso_8601": "2024-10-10T15:52:09.672523Z",
"url": "https://files.pythonhosted.org/packages/5f/a0/88d9210a0c2bcf4ae6819d791f9e912ca405ddab25763df6b1b27a9acdfb/adafruit_circuitpython_typing-1.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed609fb9c83a32b3508b287e686293fb92038760b314d106cf6bfd17efc6dee6",
"md5": "71fa26c8a53dc53e30bb5c79ff5a8338",
"sha256": "efcadbf39b70a6ea1b7561a10551b665ad5306b31340c55ece4a42328da3c998"
},
"downloads": -1,
"filename": "adafruit_circuitpython_typing-1.11.1.tar.gz",
"has_sig": false,
"md5_digest": "71fa26c8a53dc53e30bb5c79ff5a8338",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 29282,
"upload_time": "2024-10-10T15:52:11",
"upload_time_iso_8601": "2024-10-10T15:52:11.341824Z",
"url": "https://files.pythonhosted.org/packages/ed/60/9fb9c83a32b3508b287e686293fb92038760b314d106cf6bfd17efc6dee6/adafruit_circuitpython_typing-1.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 15:52:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Typing",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-typing"
}