oracular (7) cdist-type__package_pip.7.gz

Provided by: cdist_7.0.0-4_all bug

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. Multiple extras can be passed in one --extra as a comma-separated list.

              Extra  optional  dependencies  will  be installed even when the base package is already installed.
              Notice that the type will not remove installed extras that are not explicitly named for  the  type
              because  pip  does  not  offer  a  management  for orphaned packages and they may be used by other
              packages.

       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
          # 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
          # the extras can also be specified comma-separated
          __package_pip mautrix-telegram --extra speedups,webp_convert,hq_thumbnails --extra postgres

          # or take all extras
          __package_pip mautrix-telegram --extra all


SEE ALSO
       cdist-type__package(7)


AUTHORS
       Nico Schottelius <nico-cdist--@--schottelius.org>
       Matthias Stecher <matthiasstecher--@--gmx.de>


COPYING
       Copyright (C) 2012 Nico Schottelius, 2021 Matthias Stecher. 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.


       ungleich GmbH 2021