Repository files navigation

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!micropython-lib is a highly experimental community project.Please help to drive it to just "experimental" state by testingprovided packages with MicroPython.!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

micropython-lib is a project to develop a non-monolothic standard libraryfor MicroPython. Each module or package is available as a separatedistribution package from PyPI. Each module is either written from scratch orported from CPython.

Note that the main target of micropython-lib is a "Unix" port of MicroPython(additional ports to support are to be determined). Actual system requirementsvary per module. Though if a module is not related to I/O, the module shouldwork without problem on bare-metal ports too (e.g. pyboard).

micropython-lib packages are published on PyPI (Python Package Index),the standard Python community package repository:http://pypi.python.org/ .On PyPi, you can search for MicroPython related packages and readadditional package information.

To install packages from PyPI for usage on your local system, use thepip-micropython tool, which is a simple wrapper around the standardpip tool, which is used to install packages for CPython.Thepip-micropython tool can be found intools subdirectoryof the main MicroPython repository (https://github.com/micropython/micropython).Just install thepip-micropython script somewhere on yourPATH.

Afterwards, just usepip-micropython in a way similar topip:

$ pip-micropython install micropython-copy$ micropython>>> import copy>>> copy.copy([1, 2, 3])[1, 2, 3]

Review thepip-micropython source code for more info.

To install modules during development, usemake install. By default, allavailable packages will be installed. To install a specific module, add theMOD=<module> parameter to the end of themake install command.

More information is on GitHub and in the MicroPython forums:

• micropython/micropython#405
• http://forum.micropython.org/viewtopic.php?f=5&t=70

Guidelines for packaging MicroPython modules for PyPI:

• micropython/micropython#413