Skip to content

Commit 88c9eae

Browse files
committed
README: Update to the current state of affairs (pip-micropython -> upip, etc.)
1 parent fceed2b commit 88c9eae

File tree

1 file changed

+24
-22
lines changed

1 file changed

+24
-22
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,55 @@
11
micropython-lib
22
===============
33
micropython-lib is a project to develop a non-monolothic standard library
4-
for MicroPython. Each module or package is available as a separate
5-
distribution package from PyPI. Each module is either written from scratch or
6-
ported from CPython.
4+
for MicroPython (https://github.com/micropython/micropython). Each module
5+
or package is available as a separate distribution package from PyPI. Each
6+
module is either written from scratch or ported from CPython.
77

8-
Note that the main target of micropython-lib is a "Unix" port of MicroPython
9-
(additional ports to support are to be determined). Actual system requirements
10-
vary per module. Though if a module is not related to I/O, the module should
11-
work without problem on bare-metal ports too (e.g. pyboard).
8+
Note that the main target of micropython-lib is a "Unix" port of MicroPython.
9+
Actual system requirements vary per module. Though if a module is not related
10+
to I/O, the module should work without problems on bare-metal ports too (e.g.
11+
pyboard).
1212

1313

1414
Usage
1515
-----
1616
micropython-lib packages are published on PyPI (Python Package Index),
1717
the standard Python community package repository: http://pypi.python.org/ .
18-
On PyPi, you can search for MicroPython related packages and read
18+
On PyPI, you can search for MicroPython related packages and read
1919
additional package information.
2020

2121
To install packages from PyPI for usage on your local system, use the
22-
`pip-micropython` tool, which is a simple wrapper around the standard
23-
`pip` tool, which is used to install packages for CPython.
24-
The `pip-micropython` tool can be found in `tools` subdirectory
25-
of the main MicroPython repository (https://github.com/micropython/micropython).
26-
Just install the `pip-micropython` script somewhere on your `PATH`.
27-
28-
Afterwards, just use `pip-micropython` in a way similar to `pip`:
22+
`upip` tool, which is MicroPython's native package manager, similar to
23+
`upip`, which is used to install packages for CPython. `upip` is bundled
24+
with MicroPython "Unix" port (i.e. if you build "Unix" port, you
25+
automatically have `upip` tool). Following examples assume that
26+
`micropython` binary is available on your `PATH`:
2927

3028
~~~~
31-
$ pip-micropython install micropython-copy
29+
$ micropython -m upip install micropython-pystone
30+
...
3231
$ micropython
33-
>>> import copy
34-
>>> copy.copy([1, 2, 3])
35-
[1, 2, 3]
32+
>>> import pyston
33+
>>> pystone.main()
34+
Pystone(1.2) time for 50000 passes = 0.534
35+
This machine benchmarks at 93633 pystones/second
3636
~~~~
3737

38-
Review the `pip-micropython` source code for more info.
38+
Run `micropython -m upip --help` for more information about `upip`.
3939

4040

4141
Development
4242
-----------
4343
To install modules during development, use `make install`. By default, all
44-
available packages will be installed. To install a specific module, add the
44+
available packages will be installed. To install a specific module, add the
4545
`MOD=<module>` parameter to the end of the `make install` command.
4646

4747

4848
Links
4949
-----
50-
More information is on GitHub and in the MicroPython forums:
50+
If you would like to trace evolution of MicroPython packaging support,
51+
you may find following links useful (note that they may contain outdated
52+
information):
5153

5254
* https://github.com/micropython/micropython/issues/405
5355
* http://forum.micropython.org/viewtopic.php?f=5&t=70

0 commit comments

Comments
 (0)