1
1
~~~~
2
2
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
3
- micropython-lib is highly experimental community project.
3
+ micropython-lib is a " highly experimental" community project.
4
4
5
- Please help to drive it to just "expiremental " state by testing
5
+ Please help to drive it to just "experimental " state by testing
6
6
provided packages with MicroPython.
7
7
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
8
8
~~~~
9
9
10
10
micropython-lib
11
11
===============
12
- micropython-lib is a project to develop non-monolothic standard library
13
- for MicroPython. Each module or package is available as a seprate
14
- distribution package from PyPI. Modules either written from scratch or
15
- ported from CPython. Note that main target of micropython-lib is so
16
- far "Unix" port of MicroPython. Actual requirements vary per module
17
- (basicly, if module is not related to I/O, it should work without
18
- problem on baremetal ports too).
12
+ micropython-lib is a project to develop a non-monolothic standard library
13
+ for MicroPython. Each module or package is available as a separate
14
+ distribution package from PyPI. Each module is either written from scratch or
15
+ ported from CPython.
16
+
17
+ Note that the main target of micropython-lib is a "Unix" port of MicroPython
18
+ (future ports to be determined). Actual system requirements vary per module.
19
+ Though if a module is not related to I/O, the module should work without
20
+ problem on bare-metal ports too.
21
+
19
22
20
23
Usage
21
24
-----
22
25
micropython-lib packages are published on PyPI (Python Package Index),
23
- standard Python community package repository: http://pypi.python.org/ .
24
- You can search for MicroPython related packages, read additional info,
25
- etc .
26
+ the standard Python community package repository: http://pypi.python.org/ .
27
+ On PyPi, you can search for MicroPython related packages and read
28
+ additional package information .
26
29
27
- To install packages from PyPI for usage on your local system, use
28
- " pip-micropython" tool, which is a simple wrapper around a standard
29
- " pip" tool, which is used to install package for CPython.
30
- " pip-micropython" tool can be found in " tools" subdirectory of the main
31
- MicroPython repository (https://github.com/micropython/micropython ).
32
- Just install " pip-micropython" script somewhere on your PATH.
30
+ To install packages from PyPI for usage on your local system, use the
31
+ ` pip-micropython ` tool, which is a simple wrapper around the standard
32
+ ` pip ` tool, which is used to install packages for CPython.
33
+ The ` pip-micropython ` tool can be found in ` tools ` subdirectory
34
+ of the main MicroPython repository (https://github.com/micropython/micropython ).
35
+ Just install the ` pip-micropython ` script somewhere on your ` PATH ` .
33
36
34
- Afterwards, just use pip-micropython in a way similar to pip:
37
+ Afterwards, just use ` pip-micropython ` in a way similar to ` pip ` :
35
38
36
39
~~~~
37
40
$ pip-micropython install micropython-copy
@@ -41,21 +44,23 @@ $ micropython
41
44
[1, 2, 3]
42
45
~~~~
43
46
44
- Review pip-micropython source code for more info.
47
+ Review the ` pip-micropython ` source code for more info.
48
+
45
49
46
50
Development
47
51
-----------
48
- To install modules during development, use "make install". By default, it
49
- will install all available packages. You can pass MOD=<module > parameter
50
- to install specific module.
52
+ To install modules during development, use ` make install ` . By default, all
53
+ available packages will be installed. To install a specific module, add the
54
+ ` MOD=<module> ` parameter to the end of the ` make install ` command.
55
+
51
56
52
57
Links
53
58
-----
54
- More info :
59
+ More information is on GitHub and in the MicroPython forums :
55
60
56
61
* https://github.com/micropython/micropython/issues/405
57
62
* http://forum.micropython.org/viewtopic.php?f=5&t=70
58
63
59
- Basic guidelines for installing packages from PyPI:
64
+ For basic guidelines for installing packages from PyPI:
60
65
61
66
* https://github.com/micropython/micropython/issues/413
0 commit comments