Go to file
stijn 278d22ce8f lib/mp-readline: Allow overriding implementation of cursor functions
Default implementation uses VT100-style sequences which are not implemented
by all terminals out there
2015-05-30 13:38:34 +03:00
bare-arm py: Add attrtuple object, for space-efficient tuples with attr access. 2015-04-21 14:14:24 +00:00
cc3200 cc3200: Add period set method to the Timer class. 2015-05-29 15:54:46 +02:00
docs extmod: Add ubinascii.unhexlify 2015-05-20 09:29:22 +01:00
drivers stmhal: Remove std.h. It's not needed anymore. 2015-04-18 14:28:39 +01:00
esp8266 esp8266: Add a bunch of miscellaneous methods 2015-05-28 21:38:46 +03:00
examples changed file paths to new names 2014-10-25 23:59:33 +01:00
extmod extmod: Actually expose the ubinascii python methods. 2015-05-22 09:56:09 +02:00
lib lib/mp-readline: Allow overriding implementation of cursor functions 2015-05-30 13:38:34 +03:00
logo logo: Change line endings in FONT-LICENSE.txt from CRLF to LF. 2015-04-16 22:12:19 +01:00
minimal pyexec: Make raw REPL work with event-driven version of pyexec. 2015-05-06 00:02:58 +01:00
pic16bit pic16bit: Add readinto and readlines to qstrs. 2015-05-20 23:12:43 +01:00
py py: Remove unnecessary extra handling of padding of nan/inf. 2015-05-28 14:22:12 +00:00
qemu-arm qemu-arm: Get compiling again with recent changes to print framework. 2015-04-16 21:44:52 +01:00
stmhal stmhal: Fix off-by-one error when checking for valid I2C and SPI bus. 2015-05-28 11:05:44 +01:00
teensy teensy: Add readinto and readlines qstrs. 2015-05-13 20:46:54 +01:00
tests tests: Add special tests to test mp_printf function to improve coverage. 2015-05-28 14:25:07 +00:00
tools tools/make-frozen.py: Open files in binary mode. 2015-05-30 00:39:00 +03:00
unix unix: Print an extra newline to the output on ctrl-D 2015-05-30 13:38:17 +03:00
unix-cpy py: Overhaul and simplify printf/pfenv mechanism. 2015-04-16 14:30:16 +00:00
windows unix: Factor out stdio and ctrl-C code to unix_mphal.c file. 2015-05-27 15:52:35 +01:00
.gitattributes Add .gitattributes file to force text line endings to LF. 2015-04-16 22:23:56 +01:00
.gitignore msvc: Allow overriding of build options with custom file 2015-04-30 10:14:59 +02:00
.travis.yml unix: Make extra-coverage function callable from Python scripts. 2015-05-08 09:18:38 +01:00
ACKNOWLEDGEMENTS ACKNOWLEDGEMENTS: Add 1 backer name to the file. 2015-05-28 08:20:36 +01:00
CODECONVENTIONS.md Updated CODECONVENTIONS to clarify use of integer types. 2014-09-25 15:49:26 +01:00
CONTRIBUTING.md CONTRIBUTING.md: Link to contrib guidelines and code conventions. 2015-05-03 22:04:52 +01:00
LICENSE Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
README.md README.md: Add the CC3200 port to the list of additional components. 2015-04-18 19:49:00 +02:00


[![Build Status][travis-img]][travis-repo] [![Coverage Status][coveralls-img]][coveralls-repo] [![Issue Stats][istats-pr-img]][istats-pr-repo] [![Issue Stats][istats-issue-img]][istats-issue-repo] [travis-img]: https://travis-ci.org/micropython/micropython.png?branch=master [travis-repo]: https://travis-ci.org/micropython/micropython [coveralls-img]: https://coveralls.io/repos/micropython/micropython/badge.png?branch=master [coveralls-repo]: https://coveralls.io/r/micropython/micropython?branch=master [istats-pr-img]: http://issuestats.com/github/micropython/micropython/badge/pr [istats-pr-repo]: http://issuestats.com/github/micropython/micropython [istats-issue-img]: http://issuestats.com/github/micropython/micropython/badge/issue [istats-issue-repo]: http://issuestats.com/github/micropython/micropython

The Micro Python project

MicroPython Logo

This is the Micro Python project, which aims to put an implementation of Python 3.x on microcontrollers and small embedded systems.

WARNING: this project is in beta stage and is subject to changes of the code-base, including project-wide name changes and API changes.

Micro Python implements the entire Python 3.4 syntax (including exceptions, "with", "yield from", etc.). The following core datatypes are provided: str (including basic Unicode support), bytes, bytearray, tuple, list, dict, set, frozenset, array.array, collections.namedtuple, classes and instances. Builtin modules include sys, time, and struct. Note that only subset of Python 3.4 functionality implemented for the data types and modules.

See the repository www.github.com/micropython/pyboard for the Micro Python board, the officially supported reference electronic circuit board.

Major components in this repository:

  • py/ -- the core Python implementation, including compiler, runtime, and core library.
  • unix/ -- a version of Micro Python that runs on Unix.
  • stmhal/ -- a version of Micro Python that runs on the Micro Python board with an STM32F405RG (using ST's Cube HAL drivers).
  • minimal/ -- a minimal Micro Python port. Start with this if you want to port Micro Python to another microcontroller.

Additional components:

  • bare-arm/ -- a bare minimum version of Micro Python for ARM MCUs. Used mostly to control code size.
  • teensy/ -- a version of Micro Python that runs on the Teensy 3.1 (preliminary but functional).
  • pic16bit/ -- a version of Micro Python for 16-bit PIC microcontrollers.
  • cc3200/ -- a version of Micro Python that runs on the CC3200 from TI.
  • unix-cpy/ -- a version of Micro Python that outputs bytecode (for testing).
  • tests/ -- test framework and test scripts.
  • tools/ -- various tools, including the pyboard.py module.
  • examples/ -- a few example Python scripts.
  • docs/ -- official documentation in RST format.

"make" is used to build the components, or "gmake" on BSD-based systems. You will also need bash and Python (at least 2.7 or 3.3).

The Unix version

The "unix" port requires a standard Unix environment with gcc and GNU make. x86 and x64 architectures are supported (i.e. x86 32- and 64-bit), as well as ARM and MIPS. Making full-featured port to another architecture requires writing some assembly code for the exception handling and garbage collection. Alternatively, fallback implementation based on setjmp/longjmp can be used.

To build:

$ cd unix
$ make

Then to give it a try:

$ ./micropython
>>> list(5 * x + y for x in range(10) for y in [4, 2, 1])

Run complete testsuite:

$ make test

Debian/Ubuntu/Mint derivative Linux distros will require build-essentials and libreadline-dev packages installed. To build FFI (Foreign Function Interface) module, libffi-dev and pkg-config packages are required. If you have problems with some dependencies, they can be disabled in unix/mpconfigport.mk .

The STM version

The "stmhal" port requires an ARM compiler, arm-none-eabi-gcc, and associated bin-utils. For those using Arch Linux, you need arm-none-eabi-binutils and arm-none-eabi-gcc packages from the AUR. Otherwise, try here: https://launchpad.net/gcc-arm-embedded

To build:

$ cd stmhal
$ make

You then need to get your board into DFU mode. On the pyboard, connect the 3V3 pin to the P1/DFU pin with a wire (on PYBv1.0 they are next to each other on the bottom left of the board, second row from the bottom).

Then to flash the code via USB DFU to your device:

$ make deploy

You will need the dfu-util program, on Arch Linux it's dfu-util-git in the AUR. If the above does not work it may be because you don't have the correct permissions. Try then:

$ sudo dfu-util -a 0 -d 0483:df11 -D build-PYBV10/firmware.dfu

Building the documentation locally

Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme, preferably in a virtualenv:

 pip install sphinx
 pip install sphinx_rtd_theme

In micropython/docs, build the docs:

make html

You'll find the index page at micropython/docs/build/html/index.html.