No description
Find a file
Jeff Epler 5be097449d Collect doc files based primarily on an inclusion list
It frequently arises that files were inadvertently included in the doc
build, because it was based on a series of exclude patterns, but new
filenames that don't match the exclude patterns are frequently created
by new build systems, new submodules, un-tidy developer source trees, etc.

So, use include_patterns as a set of positive patterns, then weed out
a few specific items that otherwise match the include patterns.
2025-01-10 16:38:10 -06:00
.codespell add formatting/spelling exceptions 2024-07-29 18:59:59 -04:00
.devcontainer install most current version of CMAKE from kitware 2024-11-26 09:43:53 +01:00
.github more yaml syntax fixes 2024-11-04 12:18:22 -06:00
data merge from 8.2.9 2023-12-06 14:18:01 -05:00
devices/ble_hci fix ble_serial_connected() 2024-10-03 16:55:00 -04:00
docs Merge pull request #9919 from RetiredWizard/rotationdoc 2025-01-02 13:05:34 -08:00
examples non-conflict merge changes 2024-09-05 14:54:18 -04:00
extmod add static to 'extmod/vfs_fat.c: fat_vfs_label_obj' 2024-10-04 16:55:35 +08:00
frozen Merge pull request #9469 from dhalbert/merge-from-micropython-v1.22.2 2024-08-21 18:11:19 -04:00
lib Update TinyUSB 2024-12-03 10:17:31 -08:00
LICENSES updates before header conversion 2024-05-17 14:56:28 -04:00
locale Update translation files 2025-01-09 18:27:10 +00:00
logo non-conflict merge changes 2024-09-05 14:54:18 -04:00
mpy-cross change remaining STATIC to static 2024-09-03 17:40:07 -04:00
ports Use the CYW43 pins provided by the board 2025-01-10 20:11:52 +01:00
py py/objint.c: mark CIRCUITPY-CHANGEs 2025-01-06 13:56:18 -05:00
shared merge from main 2024-09-10 16:36:32 -04:00
shared-bindings Typo fix in RTC.c to fix rp2040 chip name 2025-01-09 18:24:35 -06:00
shared-module Merge pull request #9912 from patricksurry/demux-keymatrix-delay 2025-01-03 12:42:17 -05:00
supervisor ignore newly added "clear" characters in the Web Workflow serial 2025-01-04 04:56:48 +01:00
tests py/objint.c: int.from_bytes and .to_bytes can omit byteorder arg 2025-01-06 11:16:02 -05:00
tools Fix CI run issues with docs & tlsf submodule 2024-11-25 15:28:42 -08:00
.codespellrc fix typos (partial) detected by codepell 2023-03-18 22:17:02 +07:00
.git-blame-ignore-revs top: Update .git-blame-ignore-revs for latest format/spell commits. 2024-03-07 16:29:46 +11:00
.gitattributes merge from main 2024-07-29 17:41:46 -04:00
.gitignore MPy v1.22 merge: initial merge; not compiled yet 2024-07-25 15:16:24 -04:00
.gitmodules Merge pull request #9901 from jepler/rp3250b-pio 2025-01-09 10:26:57 -08:00
.mailmap More updates to mailmap based on git shortlog inspection 2024-07-26 12:40:04 -05:00
.pre-commit-config.yaml Reverted back to 4.0.1 2024-12-28 00:27:27 +01:00
.readthedocs.yml non-conflict merge changes 2024-09-05 14:54:18 -04: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 rename ports/nrf to ports/nordic 2024-03-19 17:36:57 -04:00
CODE_OF_CONDUCT.md restore CODE_OF_CONDUCT.md 2023-10-23 19:34:45 -04:00
conf.py Collect doc files based primarily on an inclusion list 2025-01-10 16:38:10 -06:00
CONTRIBUTING.md fix documentation typo 2024-08-23 03:42:31 +00:00
LICENSE non-conflict merge changes 2024-09-05 14:54:18 -04:00
LICENSE_MicroPython non-conflict merge changes 2024-09-05 14:54:18 -04:00
main.c Improve ESP BLE and turn on BLE workflow 2024-06-11 16:21:40 -07:00
Makefile make coverage improvement 2024-08-17 14:59:29 -04:00
MANIFEST.in-stubs refine stubs-building procedure 2021-06-22 08:59:05 -05:00
pyproject.toml non-conflict merge changes 2024-09-05 14:54:18 -04:00
README.rst Document safe mode wait in README. 2025-01-02 21:51:11 +00:00
README.rst-stubs Actually reduce the README text for the stubs package 2021-06-24 13:41:01 -05:00
requirements-ci.txt only install awscli when required 2023-01-16 17:03:39 +05:30
requirements-dev.txt lift version requirement on cryptography, espressif fixed it 2024-10-24 11:45:10 -05:00
requirements-doc.txt pin sphinx temporarily while debugging doc build 2024-10-10 18:48:22 -04:00
runtime.py Conditionalize LTO 2022-05-27 12:59:54 -07:00
setup.py-stubs device specific stubs 2024-02-04 14:08:33 -06:00
WEBUSB_README.md Rename esp32s2 port to espressif 2021-09-13 16:44:55 -07:00

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