Go to file
Jeff Epler 2e8eb43dcc Use new quirc define for small stacks
.. and revert stack enlargement of esp32-s2
2021-08-05 12:52:43 -05:00
.github Only push `main` builds to S3 2021-07-20 17:30:10 -07:00
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 It's "shared-module", not "shared-modules" 2021-08-03 10:37:47 -05: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 remove gamepad; deprecate gamepadshift 2021-07-26 22:15:09 -04:00
lib Use new quirc define for small stacks 2021-08-05 12:52:43 -05:00
locale Add qrio: Decode QR codes with quirc lib 2021-08-04 09:16:00 -05: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 Use new quirc define for small stacks 2021-08-05 12:52:43 -05:00
py Add qrio: Decode QR codes with quirc lib 2021-08-04 09:16:00 -05:00
shared-bindings Better Document PixelPolicy and the pixel_policy argument 2021-08-05 12:27:49 -05:00
shared-module Use new quirc define for small stacks 2021-08-05 12:52:43 -05:00
supervisor remove gamepad; deprecate gamepadshift 2021-07-26 22:15:09 -04:00
tests enable qrio in unix coverage build, and add a test 2021-08-05 12:24:07 -05:00
tools check vid/pid: find topdir relative to this script 2021-07-27 15:20:58 -05: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 Add qrio: Decode QR codes with quirc lib 2021-08-04 09:16:00 -05:00
.mailmap Add a `.mailmap` file to collate together multiple author entries. 2020-07-06 19:15:41 +01:00
.pre-commit-config.yaml pre-commit: Have pre-commit pass the list of files to codeformat.py 2021-03-15 15:32:26 -05: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 ok it would be nice to know how to run it 2021-03-15 19:32:40 -05: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 Merge pull request #4907 from jepler/refine-stubs 2021-07-15 12:11:58 -07:00
README.rst Remove settings.py/txt as alternatives for boot.py 2021-07-26 13:04:41 -05:00
README.rst-stubs Actually reduce the README text for the stubs package 2021-06-24 13:41:01 -05:00
WEBUSB_README.md wip: starting to try to compile 2021-04-25 23:17:41 -04:00
conf.py Make summary more helpful; use a html list 2021-07-27 12:01:18 -05:00
license.rst Improve docs and update to CircuitPython. 2017-01-05 16:20:46 -08:00
main.c Fix empty boot_out.txt 2021-08-02 23:46:33 +02:00
requirements-dev.txt Use sphinx-autoapi 1.8.1 until it's fixed 2021-07-27 08:45:30 -04:00
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