- Description
- Setup - The basics of getting started with pipx
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
This module provides a puppet solution to overcome the implications of PEP 668 – Marking Python base environments as “externally managed” by leveraging pipx.
For such a thing, it provides a pipx package provider enabled to (optionally)
install python dependencies system-wide. The provider code is based
on Puppet's pip provider.
Due to pipx doesn't provide an option to install packages system-wide (ref),
this module also provides the pipx-global wrapper script installed to /usr/local/bin.
You can use this wrapper to directly manage pip packages system-wide.
The most basic thing to do is to just include the main class and use the package provider:
include pipx
package { certbot:
provider: pipx
}
It will perform:
- Install
pipxpackage via OS default provider - Install
/usr/local/bin/pipx-globalscript - Install
certbotviapipxto/opt/pipxand binaries symlinked from/usr/local/bin
You can tweak this default behaviour with the main class parameters. See Code documentation for reference.
This module requires Puppet 4.x or above, and is compatible with the following OSes/versions:
- Debian 10, 11, 12
- Ubuntu 18.04, 20.04, 22.04
It may work for other versions and OSes. Please report us if you are using it on another envinment.
Development happens on GitHub.
Please log issues for any bug report, feature or support request.
Pull requests are welcome.
This module has a poor quality score. We're not fixing it because it comes from Puppet's pip package provider code it is based. It makes no sense to us to address lint warnings and diverge from the base code.
MIT License, see LICENSE file
Use contact form on http://sbit.io