f3cfc52ab0
With the dependencies captured in manifest.py, several packages in python-stdlib were still unix-only due to direct or transitive dependencies on unix-only or ffi modules. Or they just make no sense to run on microcontroller targets. In a few cases (e.g. base64) where possible, the unix dependency could be removed. Updates manifest.py to use the `unix_ffi=True` arg to `require()` for these libraries. Rename re-pcre to re now that unix-ffi is effectively its own namespace. Update unix-ffi/README.md, and strengthen the wording that the unix libraries are unmaintained. Signed-off-by: Jim Mussared <jim.mussared@gmail.com> |
||
|---|---|---|
| .github/workflows | ||
| micropython | ||
| python-ecosys | ||
| python-stdlib | ||
| tools | ||
| unix-ffi | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
README.md
micropython-lib
This is a repository of libraries designed to be useful for writing MicroPython applications.
The libraries here fall into four categories corresponding to the four top-level directories:
-
python-stdlib: Compatible versions of modules from the Python Standard Library. These should be drop-in replacements for the Python libraries, although many have reduced functionality or missing methods or classes (which may not be an issue for many most cases).
-
python-ecosys: Compatible, but reduced-functionality versions of modules from the larger Python ecosystem, for example that might be found in the Python Package Index.
-
micropython: MicroPython-specific modules that do not have equivalents in other Python environments. These are typically hardware drivers or highly-optimised alternative implementations of functionality available in other Python modules.
-
unix-ffi: These modules are specifically for the MicroPython Unix port and provide access to operating-system and third-party libraries via FFI.
Usage
Many libraries are self contained modules, and you can quickly get started by
copying the relevant Python file to your device. For example, to add the
base64 library, you can directly copy python-stdlib/base64/base64.py to the lib
directory on your device.
Other libraries are packages, in which case you'll need to copy the directory instead. For example, to add collections.defaultdict, copy collections/collections/__init__.py and collections.defaultdict/collections/defaultdict.py to a directory named lib/collections on your device.
Future plans (and new contributor ideas)
- Provide compiled .mpy distributions.
- Develop a set of example programs using these libraries.
- Develop more MicroPython libraries for common tasks.
- Provide a replacement for the previous
upiptool.