Matthias Stecher
8eccacec59
This is a poor implementation of optional dependencies for pip packages. It ensures to install them if the package will be installed, but does not take into account if they must be added/removed after the package is already installed. Also, it will not be autoremoved, as all dependencies will not be removed.
78 lines
1.9 KiB
ReStructuredText
78 lines
1.9 KiB
ReStructuredText
cdist-type__package_pip(7)
|
|
==========================
|
|
|
|
NAME
|
|
----
|
|
cdist-type__package_pip - Manage packages with pip
|
|
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Pip is used in Python environments to install packages.
|
|
It is also included in the python virtualenv environment.
|
|
|
|
|
|
REQUIRED PARAMETERS
|
|
-------------------
|
|
None
|
|
|
|
|
|
OPTIONAL PARAMETERS
|
|
-------------------
|
|
name
|
|
If supplied, use the name and not the object id as the package name.
|
|
|
|
extra
|
|
Extra optional dependencies which should be installed along the selected
|
|
package. Can be specified multiple times. Will only be applied if the
|
|
package actually will be installed, but will not explicitly checked.
|
|
|
|
pip
|
|
Instead of using pip from PATH, use the specific pip path.
|
|
|
|
state
|
|
Either "present" or "absent", defaults to "present"
|
|
|
|
runas
|
|
Run pip as specified user. By default it runs as root.
|
|
|
|
|
|
EXAMPLES
|
|
--------
|
|
|
|
.. code-block:: sh
|
|
|
|
# Install a package
|
|
__package_pip pyro --state present
|
|
|
|
# Use pip in a virtualenv located at /root/shinken_virtualenv
|
|
__package_pip pyro --state present --pip /root/shinken_virtualenv/bin/pip
|
|
|
|
# Use pip in a virtualenv located at /foo/shinken_virtualenv as user foo
|
|
__package_pip pyro --state present --pip /foo/shinken_virtualenv/bin/pip --runas foo
|
|
|
|
# Install package with optional dependencies
|
|
__package_pip mautrix-telegram --extra speedups --extra webp_convert --extra hq_thumbnails
|
|
# or do a little cheating
|
|
__package_pip mautrix-telegram --extra speedups,webp_convert,hq_thumbnails
|
|
|
|
# or take all extras
|
|
__package_pip mautrix-telegram --extra all
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
:strong:`cdist-type__package`\ (7)
|
|
|
|
|
|
AUTHORS
|
|
-------
|
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
|
|
|
|
COPYING
|
|
-------
|
|
Copyright \(C) 2012 Nico Schottelius. You can redistribute it
|
|
and/or modify it under the terms of the GNU General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|