Repository files navigation

micropython-lib is a project to develop a non-monolothic standard libraryfor MicroPython (https://github.com/micropython/micropython). Each moduleor package is available as a separate distribution package from PyPI. Eachmodule comes from one of the following sources (and thus each module hasits own licensing terms):

• written from scratch specifically for MicroPython
• ported from CPython
• ported from some other Python implementation, e.g. PyPy
• some modules actually aren't implemented yet and are dummy

Note that the main target of micropython-lib is a "Unix" port of MicroPython.Actual system requirements vary per module. For example, if a module is notrelated to I/O, it may work without problems 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. By convention, all micropython-lib packagenames are prefixed with "micropython-" (the reverse is not true - somepackage starting with "micropython-" aren't part of micropython-lib andwere released by 3rd parties).

Browse available packagesvia this URL.

To install packages from PyPI for usage on your local system, use theupip tool, which is MicroPython's native package manager, similar topip, which is used to install packages for CPython.upip is bundledwith MicroPython "Unix" port (i.e. if you build "Unix" port, youautomatically haveupip tool). Following examples assume thatmicropython binary is available on yourPATH:

$ micropython -m upip install micropython-pystone...$ micropython>>> import pystone>>> pystone.main()Pystone(1.2) time for 50000 passes = 0.534This machine benchmarks at 93633 pystones/second

Runmicropython -m upip --help for more information aboutupip.

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.

If you would like to trace evolution of MicroPython packaging support,you may find following links useful (note that they may contain outdatedinformation):

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

Guidelines for packaging MicroPython modules for PyPI:

• micropython/micropython#413