Go to file
Scott Shawcroft b79661d631
Alphabetize, fix typo and remove incorrect comment
2023-02-23 14:34:54 -08:00
.devcontainer fixed typo (path) in postCreateCommand 2022-12-16 09:13:34 +01:00
.github Merge branch 'main' into banglejs2 2023-02-21 12:04:28 -08:00
LICENSES Add an explicit SPDX license file for ter-u12n. 2020-07-06 19:15:41 +01:00
data Add Bangle.js 2, JDI memory displays and ACeP epd 2023-02-15 15:03:40 -08:00
devices/ble_hci Withdraw the _environ module 2022-12-08 15:33:10 -06:00
docs adding information regarding the version for libraries 2023-01-31 18:58:27 -05:00
examples Fix all natmod tests to run on x64 2022-02-13 11:18:38 -06:00
extmod update ulab to 6.0.7 2023-02-01 09:08:18 -06:00
frozen update frozen libraries 2023-01-26 20:18:22 -05:00
lib Limit FatFs' ability to upper case paths 2023-02-23 14:28:58 -08:00
locale Merge branch 'main' into banglejs2 2023-02-21 12:04:28 -08:00
logo Add license to some obvious files. 2020-07-06 19:16:25 +01:00
mpy-cross Implement scan, connect, ping 2022-09-28 10:06:33 -05:00
ports Alphabetize, fix typo and remove incorrect comment 2023-02-23 14:34:54 -08:00
py Alphabetize, fix typo and remove incorrect comment 2023-02-23 14:34:54 -08:00
shared Revert "debug_dhcp to follow general debug" 2022-11-30 22:44:18 +02:00
shared-bindings Merge branch 'main' into banglejs2 2023-02-21 12:04:28 -08:00
shared-module Alphabetize, fix typo and remove incorrect comment 2023-02-23 14:34:54 -08:00
supervisor Merge branch 'main' into banglejs2 2023-02-21 12:04:28 -08:00
tests Merge branch 'main' into gif_displayio_support 2023-02-13 18:30:51 -06:00
tools Add Bangle.js 2, JDI memory displays and ACeP epd 2023-02-15 15:03:40 -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 Rename test function, make 'bad' files binary & add another test 2022-12-09 15:23:56 -06:00
.gitmodules fix up esp32-camera submodule 2023-01-02 10:13:20 -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 rework the getenv test again 2022-12-10 12:58:08 -06:00
.readthedocs.yml update .readthedocs.yml 2023-01-29 22:56:24 -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 Add note about rust to BUILDING.md 2022-10-31 20:46:18 -04:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Fix error 2020-10-26 23:36:54 +01:00
LICENSE update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
LICENSE_MicroPython update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
MANIFEST.in-stubs refine stubs-building procedure 2021-06-22 08:59:05 -05:00
Makefile Hide it. 2023-02-17 20:46:30 +02:00
README.rst don't enter safemode.py on USER safe mode 2023-02-14 11:20:29 -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 Rename esp32s2 port to espressif 2021-09-13 16:44:55 -07:00
conf.py be more specific with exclude_patterns 2022-11-28 21:09:57 +01:00
main.c Merge pull request #7577 from dhalbert/safemode-py 2023-02-16 14:15:20 -05:00
requirements-ci.txt only install `awscli` when required 2023-01-16 17:03:39 +05:30
requirements-dev.txt use already built mpy-cross 2023-02-10 16:38:25 +05:30
requirements-doc.txt avoid problematic sphinx version number for rtd theme 2022-09-25 16:10:11 +02:00
runtime.py Conditionalize LTO 2022-05-27 12:59:54 -07:00
setup.py-stubs use --long for describe in setup.py-stubs 2022-02-18 21:22:02 -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