Repository files navigation

This is an open source derivative ofMicroPythonfor use on educational development boards designed and sold by Adafruitincluding theArduino Zero,Adafruit Feather M0 Basic,Adafruit Feather HUZZAH andAdafruit Feather M0 Bluefruit LE.

As a MicroPython derivative, this implements Python 3.x on microcontrollers suchas the SAMD21 and ESP8266.

This project is in beta and the APIs will change in the near future.

Guides and videos are available through theAdafruit Learning System under theMicroPython category. An API reference is also available onRead the Docs.

SeeCONTRIBUTING.mdfor full guidelines but please be aware that by contributing to this project youare agreeing to theCode of Conduct.Contributors who follow theCode of Conductare welcome to submit pull requests and they will be promptly reviewed byproject admins.

Here is an overview of the top-level directories.

The core of MicroPython is code shared amongst ports.

• docs High level user documentation in Sphinx reStructuredText format.
• drivers External device drivers written in Python.
• examples A few example Python scripts.
• extmod Shared C code used in multiple ports' modules.
• lib Shared core C code including externally developed libraries such as FATFS.
• logo The MicroPython logo.
• mpy-cross A cross compiler that converts Python files to byte code prior to being run in MicroPython. Useful for reducing library size.
• py Core Python implementation, including compiler, runtime, andcore library.
• shared-bindings Shared definition of Python modules, their docs and backing C APIs. Ports must implement the C API to support the corresponding module.
• tests Test framework and test scripts.
• tools Various tools, including the pyboard.py module.

Ports include the code unique to a microcontroller line and also variationsbased on the board.

• atmel-samd Support for SAMD21 based boards such asArduino Zero,Adafruit Feather M0 Basic, andAdafruit Feather M0 Bluefruit LE.
• bare-arm A bare minimum version of MicroPython for ARM MCUs.
• cc3200 Support for boards basedCC3200 from TI such as theWiPy 1.0.
• esp8266 Support for boards based on ESP8266 WiFi modules such as theAdafruit Feather HUZZAH.
• minimal A minimal MicroPython port. Start with this if you wantto port MicroPython to another microcontroller.
• pic16bit Support for 16-bit PIC microcontrollers.
• qemu-arm Support for ARM emulation throughQEMU.
• stmhal Support for boards based on STM32 microcontrollers including the MicroPython flagshipPyBoard.
• teensy Support for the Teensy line of boards such as theTeensy 3.1.
• unix Support for UNIX.
• windows Support forWindows.
• zephyr Support forZephyr, a real-time operating system by the Linux Foundation.

This derivative only maintains theatmel-samd andesp8266 ports. The rest are here to maintain compatibility with theMicroPython parent project.