94 lines
3.2 KiB
Text
94 lines
3.2 KiB
Text
Metadata-Version: 2.4
|
|
Name: adafruit-circuitpython-typing
|
|
Version: 1.12.1
|
|
Summary: Types needed for type annotation that are not in `typing`
|
|
Author-email: Adafruit Industries <circuitpython@adafruit.com>
|
|
License: MIT
|
|
Project-URL: Homepage, https://github.com/adafruit/Adafruit_CircuitPython_Typing
|
|
Keywords: adafruit,blinka,circuitpython,micropython,circuitpython_typing
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Topic :: Software Development :: Libraries
|
|
Classifier: Topic :: Software Development :: Embedded Systems
|
|
Classifier: Topic :: System :: Hardware
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Programming Language :: Python :: 3
|
|
Requires-Python: >=3.8
|
|
Description-Content-Type: text/x-rst
|
|
License-File: LICENSE
|
|
Requires-Dist: Adafruit-Blinka
|
|
Requires-Dist: adafruit-circuitpython-busdevice
|
|
Requires-Dist: adafruit-circuitpython-requests
|
|
Requires-Dist: typing_extensions~=4.0
|
|
Provides-Extra: optional
|
|
Dynamic: license-file
|
|
|
|
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/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
|
|
|
|
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.
|