Forge Home

pipx

Provides pipx package provider

180 downloads

121 latest version

3.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.0.1 (latest)
  • 1.0.0
released Oct 16th 2023
This version is compatible with:
  • Puppet Enterprise 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
  • Puppet >= 7.24 < 9.0.0
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'sbitio-pipx', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add sbitio-pipx
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install sbitio-pipx --version 1.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

sbitio/pipx — version 1.0.1 Oct 16th 2023

pipx

Table of Contents

  1. Description
  2. Setup - The basics of getting started with pipx
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

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.

Usage

The most basic thing to do is to just include the main class and use the package provider:

include python_pipx

package { certbot:
  provider: pipx
}

It will perform:

  • Install pipx package via OS default provider
  • Install /usr/local/bin/pipx-global script
  • Install certbot via pipx to /opt/pipx and binaries symlinked from /usr/local/bin

You can tweak this default behaviour with the main class parameters. See Code documentation for reference.

Limitations

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

Development happens on GitHub.

Please log issues for any bug report, feature or support request.

Pull requests are welcome.

Disclaimer

A note on quality score

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.

License

MIT License, see LICENSE file

Contact

Use contact form on http://sbit.io