Go to file
Scott Shawcroft 4df083a961
Only make CIRCUITPY readonly with USB
CIRCUITPY will be writable from CP on all non-USB boards now. This
includes micro:bit v2 and C3 boards. It should allow it to work
with serial file loading programs.

Fixes #5901
2022-01-21 12:37:10 -08:00
.github Push stubs to pypi only on a release 2022-01-12 14:14:21 -05:00
LICENSES Add an explicit SPDX license file for ter-u12n. 2020-07-06 19:15:41 +01:00
data update nvm.toml module to latest 2021-11-04 08:56:14 -06:00
devices/ble_hci restore BLEIO HCI background task 2021-12-07 22:39:17 -05:00
docs Add newline at end of breadcrumbs.html 2022-01-14 13:29:13 -05:00
examples Merge tag 'v1.17' into merge-1.17 2021-10-15 08:20:54 -05:00
extmod fix typo 2022-01-20 18:17:38 -05:00
frozen update frozen libraries for 7.1.x 2021-12-24 08:21:24 -05:00
lib Update tinyusb for zero support 2022-01-06 08:52:33 -08:00
locale Validate open() mode 2022-01-20 17:21:51 -05:00
logo Add license to some obvious files. 2020-07-06 19:16:25 +01:00
mpy-cross fix name of windows mpy-cross executable 2021-10-15 08:53:58 -05:00
ports Merge pull request #5422 from Neradoc/nera-secondary-I2C 2022-01-21 11:08:14 -08:00
py Merge branch 'main' into board-bus 2022-01-21 10:08:39 +05:30
shared Initial broadcom port for Raspberry Pi 2021-11-22 14:54:44 -08:00
shared-bindings Merge branch 'main' into board-bus 2022-01-21 10:08:39 +05:30
shared-module Merge branch 'main' into board-bus 2022-01-21 10:08:39 +05:30
supervisor ESP NeoPixel fixes 2022-01-19 16:29:07 -08:00
tests Updated extra coverage test corresponding to change from 6b872aca 2022-01-08 11:05:09 +01:00
tools C3s are bin only 2022-01-19 10:16:04 -08: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 patch esp-idf for i2c crash 2022-01-14 08:53:24 -06:00
.mailmap Add a `.mailmap` file to collate together multiple author entries. 2020-07-06 19:15:41 +01:00
.pre-commit-config.yaml Add neopixel support on PWM capable pins 2021-12-14 16:59:53 -08:00
.readthedocs.yml update sphinx 2021-12-22 11:32:54 -06: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 Update submodule instructions. 2022-01-14 11:46:48 -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 LICENSE: Update for move of crypto-algorithms, re1.5, uzlib to lib. 2021-07-12 16:36:40 +10:00
MANIFEST.in-stubs refine stubs-building procedure 2021-06-22 08:59:05 -05:00
Makefile Ignore failure of first command. It's deliberate 2021-11-29 16:25:15 -08:00
README.rst add esp32s3 documentation in readme 2021-12-03 21:20:55 +05:30
README.rst-stubs Actually reduce the README text for the stubs package 2021-06-24 13:41:01 -05:00
WEBUSB_README.md Rename esp32s2 port to espressif 2021-09-13 16:44:55 -07:00
conf.py Initial broadcom port for Raspberry Pi 2021-11-22 14:54:44 -08:00
license.rst Improve docs and update to CircuitPython. 2017-01-05 16:20:46 -08:00
main.c Only make CIRCUITPY readonly with USB 2022-01-21 12:37:10 -08:00
requirements-ci.txt build docs dynamically 2021-09-16 00:05:42 +05:30
requirements-dev.txt Revert "pin specific versions of cascadetoml & tomlkit, temporarily" 2021-12-21 11:17:10 -08:00
requirements-doc.txt Merge pull request #5759 from jepler/font-protocol 2021-12-28 10:36:24 -05: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