Metadata-Version: 2.1
Name: minipip
Version: 0.1b2
Summary: Tool for installing packages for MicroPython and CircuitPython
Home-page: https://github.com/aivarannamaa/minipip
Author: Aivar Annamaa
License: MIT
Project-URL: Source code, https://github.com/aivarannamaa/minipip
Project-URL: Bug tracker, https://github.com/aivarannamaa/minipip/issues
Keywords: MicroPython CircuitPython pip upip
Platform: Windows
Platform: macOS
Platform: Linux
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: Freeware
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development
Requires-Python: >=3.6
Requires-Dist: pip
Requires-Dist: setuptools

minipip
=======
Tool for installing distribution packages for MicroPython and CircuitPython.

Supports both `upip-compatible packages <https://docs.micropython.org/en/latest/reference/packages.html>`_.
and regular pip-compatible
packages (by using `pip install --target ... <https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-t>`_).

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

If ``--port`` is given and `rshell <https://pypi.org/project/rshell/>`_ is available then uploads
extracted to the target device, otherwise just extracts to local filesystem.
``--target`` directory must be explicitly given in both cases. If target is local filesystem, then
makes sure data gets synced (useful, if target is a USB volume representing MicroPython or
CircuitPython filesystem)

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


