{"id":15142158,"url":"https://github.com/tannewt/circuitpython","last_synced_at":"2026-01-15T01:08:12.233Z","repository":{"id":38151023,"uuid":"66028227","full_name":"tannewt/circuitpython","owner":"tannewt","description":"CircuitPython, an education focused port of MicroPython.","archived":false,"fork":true,"pushed_at":"2026-01-12T19:09:43.000Z","size":230198,"stargazers_count":37,"open_issues_count":0,"forks_count":2,"subscribers_count":9,"default_branch":"master","last_synced_at":"2026-01-13T00:41:18.913Z","etag":null,"topics":["circuitpython","micropython"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"micropython/micropython","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tannewt.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-08-18T20:23:48.000Z","updated_at":"2025-09-17T06:04:32.000Z","dependencies_parsed_at":"2023-10-12T06:42:57.977Z","dependency_job_id":"72358bbf-0c90-4318-b332-ef7c599233a4","html_url":"https://github.com/tannewt/circuitpython","commit_stats":null,"previous_names":[],"tags_count":100,"template":false,"template_full_name":null,"purl":"pkg:github/tannewt/circuitpython","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tannewt%2Fcircuitpython","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tannewt%2Fcircuitpython/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tannewt%2Fcircuitpython/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tannewt%2Fcircuitpython/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tannewt","download_url":"https://codeload.github.com/tannewt/circuitpython/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tannewt%2Fcircuitpython/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28441016,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-15T00:55:22.719Z","status":"ssl_error","status_checked_at":"2026-01-15T00:55:20.945Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circuitpython","micropython"],"created_at":"2024-09-26T09:24:08.335Z","updated_at":"2026-01-15T01:08:12.205Z","avatar_url":"https://github.com/tannewt.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"CircuitPython\n=============\n\n.. image:: https://s3.amazonaws.com/adafruit-circuit-python/CircuitPython_Repo_header_logo.png\n\n|Build Status| |Doc Status| |License| |Discord|\n\n`circuitpython.org \u003chttps://circuitpython.org\u003e`__ \\| `Get CircuitPython \u003c#get-circuitpython\u003e`__ \\|\n`Documentation \u003c#documentation\u003e`__ \\| `Contributing \u003c#contributing\u003e`__ \\|\n`Branding \u003c#branding\u003e`__ \\| `Differences from Micropython \u003c#differences-from-micropython\u003e`__ \\|\n`Project Structure \u003c#project-structure\u003e`__\n\n**CircuitPython** is a *beginner friendly*, open source version of Python for tiny, inexpensive\ncomputers called microcontrollers. Microcontrollers are the brains of many electronics including a\nwide variety of development boards used to build hobby projects and prototypes. CircuitPython in\nelectronics is one of the best ways to learn to code because it connects code to reality. Simply\ninstall CircuitPython on a supported board via drag and drop and then edit a ``code.py`` file on\nthe CIRCUITPY drive. The code will automatically reload. No software installs are needed besides a\ntext editor (we recommend `Mu \u003chttps://codewith.mu/\u003e`_ for beginners.)\n\nCircuitPython features unified Python core APIs and a growing list of 150+ device libraries and\ndrivers that work with it. These libraries also work on single board computers with regular\nPython via the `Adafruit Blinka Library \u003chttps://github.com/adafruit/Adafruit_Blinka\u003e`_.\n\nCircuitPython is based on `MicroPython \u003chttps://micropython.org\u003e`_. See\n`below \u003c#differences-from-micropython\u003e`_ for differences. CircuitPython development is sponsored by\n`Adafruit \u003chttps://adafruit.com\u003e`_ and is available on their educational development boards. Please\nsupport both MicroPython and Adafruit.\n\nGet CircuitPython\n------------------\n\nOfficial binaries for all supported boards are available through\n`circuitpython.org/downloads \u003chttps://circuitpython.org/downloads\u003e`_. The site includes stable, unstable and\ncontinuous builds. Full release notes and assets are available through\n`GitHub releases \u003chttps://github.com/adafruit/circuitpython/releases\u003e`_ as well.\n\nDocumentation\n-------------\n\nGuides and videos are available through the `Adafruit Learning\nSystem \u003chttps://learn.adafruit.com/\u003e`__ under the `CircuitPython\ncategory \u003chttps://learn.adafruit.com/category/circuitpython\u003e`__. An API\nreference is also available on `Read the Docs\n\u003chttp://circuitpython.readthedocs.io/en/latest/?\u003e`__. A collection of awesome\nresources can be found at `Awesome CircuitPython \u003chttps://github.com/adafruit/awesome-circuitpython\u003e`__.\n\nSpecifically useful documentation when starting out:\n\n- `Welcome to CircuitPython \u003chttps://learn.adafruit.com/welcome-to-circuitpython\u003e`__\n- `CircuitPython Essentials \u003chttps://learn.adafruit.com/circuitpython-essentials\u003e`__\n- `Example Code \u003chttps://github.com/adafruit/Adafruit_Learning_System_Guides/tree/master/CircuitPython_Essentials\u003e`__\n\nContributing\n------------\n\nSee\n`CONTRIBUTING.md \u003chttps://github.com/adafruit/circuitpython/blob/master/CONTRIBUTING.md\u003e`__\nfor full guidelines but please be aware that by contributing to this\nproject you are agreeing to the `Code of\nConduct \u003chttps://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md\u003e`__.\nContributors who follow the `Code of\nConduct \u003chttps://github.com/adafruit/circuitpython/blob/master/CODE_OF_CONDUCT.md\u003e`__\nare welcome to submit pull requests and they will be promptly reviewed\nby project admins. Please join the\n`Discord \u003chttps://adafru.it/discord\u003e`__ too.\n\nBranding\n------------\n\nWhile we are happy to see CircuitPython forked and modified, we'd appreciate it if forked releases\nnot use the name \"CircuitPython\" or the Blinka logo. \"CircuitPython\" means something special to\nus and those who learn about it. As a result, we'd like to make sure products referring to it meet a\ncommon set of requirements.\n\nIf you'd like to use the term \"CircuitPython\" and Blinka for your product here is what we ask:\n\n* Your product is supported by the primary\n  `\"adafruit/circuitpython\" \u003chttps://github.com/adafruit/circuitpython\u003e`_ repo. This way we can\n  update any custom code as we update the CircuitPython internals.\n* Your product is listed on `circuitpython.org \u003chttps:/circuitpython.org\u003e`__ (source\n  `here \u003chttps://github.com/adafruit/circuitpython-org/\u003e`_). This is to ensure that a user of your\n  product can always download the latest version of CircuitPython from the standard place.\n* Your product has a user accessible USB plug which appears as a CIRCUITPY drive when plugged in.\n\nIf you choose not to meet these requirements, then we ask you call your version of CircuitPython\nsomething else (for example, SuperDuperPython) and not use the Blinka logo. You can say it is\n\"CircuitPython-compatible\" if most CircuitPython drivers will work with it.\n\n--------------\n\nDifferences from `MicroPython \u003chttps://github.com/micropython/micropython\u003e`__\n-----------------------------------------------------------------------------\n\nCircuitPython:\n\n-  includes ports for MicroChip SAMD21 (Commonly known as M0 in Adafruit\n   product names) and SAMD51 (M4).\n-  supports only SAMD21, SAMD51, and nRF52840 ports.\n-  tracks MicroPython's releases (not master).\n-  floats (aka decimals) are enabled for all builds.\n-  error messages are translated into 10+ languages.\n-  does not support concurrency within Python (including interrupts and threading). Some concurrency\n   is achieved with native modules for tasks that require it such as audio file playback.\n\nBehavior\n~~~~~~~~\n\n-  The order that files are run and the state that is shared between\n   them. CircuitPython's goal is to clarify the role of each file and\n   make each file independent from each other.\n-  ``boot.py`` (or ``settings.py``) runs only once on start up before\n   USB is initialized. This lays the ground work for configuring USB at\n   startup rather than it being fixed. Since serial is not available,\n   output is written to ``boot_out.txt``.\n-  ``code.py`` (or ``main.py``) is run after every reload until it\n   finishes or is interrupted. After it is done running, the vm and\n   hardware is reinitialized. **This means you cannot read state from**\n   ``code.py`` **in the REPL anymore.** CircuitPython's goal for this\n   change includes reduce confusion about pins and memory being used.\n-  After ``code.py`` the REPL can be entered by pressing any key. It no\n   longer shares state with ``code.py`` so it is a fresh vm.\n-  Autoreload state will be maintained across reload.\n-  Adds a safe mode that does not run user code after a hard crash or\n   brown out. The hope is that this will make it easier to fix code that\n   causes nasty crashes by making it available through mass storage\n   after the crash. A reset (the button) is needed after its fixed to\n   get back into normal mode.\n-  RGB status LED indicating CircuitPython state, and errors through a sequence of colored flashes.\n-  Re-runs ``code.py`` or other main file after file system writes over USB mass storage. (Disable with\n   ``samd.disable_autoreload()``)\n-  Entering the REPL after the main code is finished requires a key press which enters the REPL and\n   disables autoreload.\n-  Main is one of these: ``code.txt``, ``code.py``, ``main.py``,\n   ``main.txt``\n-  Boot is one of these: ``settings.txt``, ``settings.py``, ``boot.py``,\n   ``boot.txt``\n\nAPI\n~~~\n\n-  Unified hardware APIs. Documented\n   `on ReadTheDocs \u003chttps://circuitpython.readthedocs.io/en/latest/shared-bindings/index.html\u003e`_.\n-  API docs are rST within the C files in ``shared-bindings``.\n-  No ``machine`` API.\n\nModules\n~~~~~~~\n\n-  No module aliasing. (``uos`` and ``utime`` are not available as\n   ``os`` and ``time`` respectively.) Instead ``os``, ``time``, and\n   ``random`` are CPython compatible.\n-  New ``storage`` module which manages file system mounts.\n   (Functionality from ``uos`` in MicroPython.)\n-  Modules with a CPython counterpart, such as ``time``, ``os`` and\n   ``random``, are strict\n   `subsets \u003chttps://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html\u003e`__\n   of their `CPython\n   version \u003chttps://docs.python.org/3.4/library/time.html?highlight=time#module-time\u003e`__.\n   Therefore, code from CircuitPython is runnable on CPython but not\n   necessarily the reverse.\n-  tick count is available as\n   `time.monotonic() \u003chttps://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html#time.monotonic\u003e`__\n\n--------------\n\nProject Structure\n-----------------\n\nHere is an overview of the top-level source code directories.\n\nCore\n~~~~\n\nThe core code of\n`MicroPython \u003chttps://github.com/micropython/micropython\u003e`__ is shared\namongst ports including CircuitPython:\n\n-  ``docs`` High level user documentation in Sphinx reStructuredText\n   format.\n-  ``drivers`` External device drivers written in Python.\n-  ``examples`` A few example Python scripts.\n-  ``extmod`` Shared C code used in multiple ports' modules.\n-  ``lib`` Shared core C code including externally developed libraries\n   such as FATFS.\n-  ``logo`` The CircuitPython logo.\n-  ``mpy-cross`` A cross compiler that converts Python files to byte\n   code prior to being run in MicroPython. Useful for reducing library\n   size.\n-  ``py`` Core Python implementation, including compiler, runtime, and\n   core library.\n-  ``shared-bindings`` Shared definition of Python modules, their docs\n   and backing C APIs. Ports must implement the C API to support the\n   corresponding module.\n-  ``shared-module`` Shared implementation of Python modules that may be\n   based on ``common-hal``.\n-  ``tests`` Test framework and test scripts.\n-  ``tools`` Various tools, including the pyboard.py module.\n\nPorts\n~~~~~\n\nPorts include the code unique to a microcontroller line and also\nvariations based on the board.\n\n-  ``atmel-samd`` Support for SAMD21 and SAMD51 based boards.\n-  ``nrf`` Support for the nRF52840 based boards.\n-  ``unix`` Support for UNIX. Only used for automated testing.\n\nThe remaining port directories not listed above are in the repo to maintain compatibility with the\n`MicroPython \u003chttps://github.com/micropython/micropython\u003e`__ parent project.\n\n`back to top \u003c#circuitpython\u003e`__\n\n.. |Build Status| image:: https://travis-ci.com/adafruit/circuitpython.svg?branch=master\n   :target: https://travis-ci.org/adafruit/circuitpython\n.. |Doc Status| image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest\n   :target: http://circuitpython.readthedocs.io/\n.. |Discord| image:: https://img.shields.io/discord/327254708534116352.svg\n   :target: https://adafru.it/discord\n.. |License| image:: https://img.shields.io/badge/License-MIT-brightgreen.svg\n   :target: https://choosealicense.com/licenses/mit/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftannewt%2Fcircuitpython","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftannewt%2Fcircuitpython","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftannewt%2Fcircuitpython/lists"}