Go to file
Dan Halbert bb2dbf4aa3
Merge pull request #5379 from dhalbert/improve-usb_hid-Device-doc
Correct and improve usb_hid.Device doc
2021-09-22 11:53:13 -04:00
.github fix stubs upload to s3 2021-09-21 14:31:34 +05:30
LICENSES Add an explicit SPDX license file for ter-u12n. 2020-07-06 19:15:41 +01:00
data Updating MISO 2021-05-22 01:02:06 -04:00
devices/ble_hci Fix advertisement 2021-06-25 16:40:23 -07:00
docs merged commits from main 2021-09-19 15:51:43 +02:00
examples Merge MicroPython 1.14 into CircuitPython 2021-05-11 15:07:40 -07:00
extmod Upgrade ulab to 3.3.1 2021-07-22 13:29:21 -05:00
frozen merged commits from main 2021-09-19 15:51:43 +02:00
lib merged commits from main 2021-09-19 15:51:43 +02:00
locale Translated using Weblate (English (United Kingdom)) 2021-09-21 05:37:34 +02:00
logo Add license to some obvious files. 2020-07-06 19:16:25 +01:00
mpy-cross mpy-cross: Remove bug workaround, debug print 2021-06-01 12:46:31 -05:00
ports Merge pull request #5302 from maholli/pycubed_v05c 2021-09-20 15:00:25 -07:00
py merged commits from main 2021-09-19 15:51:43 +02:00
shared-bindings Merge pull request #5379 from dhalbert/improve-usb_hid-Device-doc 2021-09-22 11:53:13 -04:00
shared-module merged commits from main 2021-09-19 15:51:43 +02:00
supervisor merged commits from main 2021-09-19 15:51:43 +02:00
tests merged commits from main 2021-09-19 15:51:43 +02:00
tools Merge pull request #5302 from maholli/pycubed_v05c 2021-09-20 15:00:25 -07:00
.git-blame-ignore-revs top: Update .git-blame-ignore-revs for latest formatting commit. 2021-04-27 23:46:46 +10:00
.gitattributes Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
.gitignore refine stubs-building procedure 2021-06-22 08:59:05 -05:00
.gitmodules merged commits from main 2021-09-19 15:51:43 +02:00
.mailmap Add a `.mailmap` file to collate together multiple author entries. 2020-07-06 19:15:41 +01:00
.pre-commit-config.yaml merged commits from main 2021-09-19 15:51:43 +02:00
.readthedocs.yml .readthedocs.yml: add directive for RTD to build a pdf version of the docs 2020-08-15 14:30:12 -05:00
.rosie.yml Add license to some obvious files. 2020-07-06 19:16:25 +01:00
ACKNOWLEDGEMENTS Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
ACKNOWLEDGEMENTS.license Add license to some obvious files. 2020-07-06 19:16:25 +01:00
BUILDING.md merged commits from main 2021-09-19 15:51:43 +02:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md from source-of-truth repository. 2020-06-03 10:43:36 +01:00
CONTRIBUTING.md Fix error 2020-10-26 23:36:54 +01:00
LICENSE Merge MicroPython v1.11 into CircuitPython 2021-04-26 15:47:41 -07:00
MANIFEST.in-stubs refine stubs-building procedure 2021-06-22 08:59:05 -05:00
Makefile merged commits from main 2021-09-19 15:51:43 +02:00
README.rst Rename esp32s2 port to espressif 2021-09-13 16:44:55 -07:00
README.rst-stubs Actually reduce the README text for the stubs package 2021-06-24 13:41:01 -05:00
WEBUSB_README.md merged commits from main 2021-09-19 15:51:43 +02:00
conf.py merged commits from main 2021-09-19 15:51:43 +02:00
license.rst Improve docs and update to CircuitPython. 2017-01-05 16:20:46 -08:00
main.c merged commits from main 2021-09-19 15:51:43 +02:00
requirements-ci.txt build docs dynamically 2021-09-16 00:05:42 +05:30
requirements-dev.txt merged commits from main 2021-09-19 15:51:43 +02:00
requirements-doc.txt build docs dynamically 2021-09-16 00:05:42 +05:30
setup.py-stubs refine stubs-building procedure 2021-06-22 08:59:05 -05:00

README.rst-stubs

CircuitPython
=============

.. image:: https://s3.amazonaws.com/adafruit-circuit-python/CircuitPython_Repo_header_logo.png

|Build Status| |Doc Status| |License| |Discord| |Weblate|

`circuitpython.org <https://circuitpython.org>`__ \| `Get CircuitPython <#get-circuitpython>`__ \|
`Documentation <#documentation>`__ \| `Contributing <#contributing>`__ \|
`Branding <#branding>`__ \| `Differences from Micropython <#differences-from-micropython>`__ \|
`Project Structure <#project-structure>`__

**CircuitPython** is a *beginner friendly*, open source version of Python for tiny, inexpensive
computers called microcontrollers.

This package contains the "stubs", or type definitions for CircuitPython.  With some advanced
editors and other tools, this information can be identify TypeErrors, AttributeErrors, and other
problems before you deploy your code to a device and can even help autocomplete your code.

.. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg
   :target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain
.. |Doc Status| image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest
   :target: http://circuitpython.readthedocs.io/
.. |Discord| image:: https://img.shields.io/discord/327254708534116352.svg
   :target: https://adafru.it/discord
.. |License| image:: https://img.shields.io/badge/License-MIT-brightgreen.svg
   :target: https://choosealicense.com/licenses/mit/
.. |Weblate| image:: https://hosted.weblate.org/widgets/circuitpython/-/svg-badge.svg
   :target: https://hosted.weblate.org/engage/circuitpython/?utm_source=widget