Skip to main content

Tool for installing packages for MicroPython and CircuitPython

Project description

Tool for installing distribution packages for MicroPython and CircuitPython.

Supports both upip-compatible packages, and regular pip-compatible packages (by using pip install –target …).

By default it prefers packages at micropython.org-s index. If the package or the required version is not found there, then it turns to PyPI.

If --port is given and rshell is available then it uploads the extracted files to the target device, otherwise it just extracts modules to a directory in the local filesystem. --target directory must be explicitly given in both cases. If target is at local filesystem, then makes sure data gets synced (useful, if target is a USB volume representing MicroPython or CircuitPython filesystem)

Installation

pip install minipip

Requires Python 3.6+. The only required dependencies are pip and setuptools (most likely already present). rshell is an optional dependency.

Usage examples

  • minipip install --port /dev/ttyACM0 --target /lib micropython-logging

  • minipip install --target G:\lib adafruit-circuitpython-ssd1306

minipip -h

minipip [-h] [-r [REQUIREMENT_FILE [REQUIREMENT_FILE ...]]] [-p [PORT]] -t TARGET_DIR [-i INDEX_URL] [-v] [-q] [--version] {install} [package_spec [package_spec ...]]

Meant for installing both upip and pip compatible distribution packages from PyPI and micropython.org/pi to a local directory, USB volume or directly to MicroPython filesystem over
serial connection (requires rshell).

positional arguments:
  {install}             Currently the only supported command is 'install'
  package_spec          Package specification, eg. 'micropython-os' or 'micropython-os>=0.6'

optional arguments:
  -h, --help            show this help message and exit
  -r [REQUIREMENT_FILE [REQUIREMENT_FILE ...]], --requirement [REQUIREMENT_FILE [REQUIREMENT_FILE ...]]
                        Install from the given requirements file.
  -p [PORT], --port [PORT]
                        Serial port of the device (specify if you want minipip to upload the result to the device)
  -t TARGET_DIR, --target TARGET_DIR
                        Target directory (on device, if port is given, otherwise local)
  -i INDEX_URL, --index-url INDEX_URL
                        Custom index URL
  -v, --verbose         Show more details about the process
  -q, --quiet           Don't show non-error output
  --version             Show program version and exit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minipip-0.1b5.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

minipip-0.1b5-py3-none-any.whl (9.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page