doc/index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  File: README
  
    &mdash; Documentation by YARD 0.9.20
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  pathId = "";
  relpath = '';
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div class="nav_wrap">
      <iframe id="nav" src="puppet_class_list.html?1"></iframe>
      <div id="resizer"></div>
    </div>

    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
  
    <a href="_index.html">Index</a> &raquo; 
    <span class="title">File: README</span>
  
</div>

        <div id="search">
  
    <a class="full_list_link" id="puppet_class_list_link"
        href="puppet_class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>
  
</div>
        <div class="clear"></div>
      </div>

      <div id="content"><div id='filecontents'>
<h1 id="label-pipx">pipx</h1>

<h2 id="label-Table+of+Contents">Table of Contents</h2>
<ol><li>
<p><a href="#label-Description">Description</a></p>
</li><li>
<p><a href="#label-Setup">Setup - The basics of getting started with pipx</a></p>
<ul><li>
<p><a href="#label-What+pipx+affects">What pipx affects</a></p>
</li><li>
<p><a href="#label-Setup+requirements">Setup requirements</a></p>
</li><li>
<p><a href="#label-Beginning+with+pipx">Beginning with pipx</a></p>
</li></ul>
</li><li>
<p><a href="#label-Usage">Usage - Configuration options and additional
functionality</a></p>
</li><li>
<p><a href="#label-Limitations">Limitations - OS compatibility, etc.</a></p>
</li><li>
<p><a href="#label-Development">Development - Guide for contributing to the
module</a></p>
</li></ol>

<h2 id="label-Description">Description</h2>

<p>This module provides a puppet solution to overcome the implications of <a
href="https://peps.python.org/pep-0668/">PEP 668 – Marking Python base
environments as “externally managed”</a> by leveraging <a
href="https://github.com/pypa/pipx">pipx</a>.</p>

<p>For such a thing, it provides a <code>pipx</code> package provider enabled
to (optionally) install python dependencies system-wide. The provider code
is based on <a
href="https://github.com/puppetlabs/puppet/blob/main/lib/puppet/provider/package/pip.rb">Puppet’s
pip provider</a>.</p>

<p>Due to <code>pipx</code> doesn&#39;t provide an option to install packages
system-wide (<a href="https://github.com/pypa/pipx/issues/754">ref</a>),
this module also provides the <code>pipx-global</code> wrapper script
installed to <code>/usr/local/bin</code>. You can use this wrapper to
directly manage pip packages system-wide.</p>

<h2 id="label-Usage">Usage</h2>

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

<pre class="code ruby"><code class="ruby">include python_pipx

package { certbot:
  provider: pipx
}</code></pre>

<p>It will perform:  * Install <code>pipx</code> package via OS default
provider  * Install <code>/usr/local/bin/pipx-global</code> script  *
Install <code>certbot</code> via <code>pipx</code> to
<code>/opt/pipx</code> and binaries symlinked from
<code>/usr/local/bin</code></p>

<p>You can tweak this default behaviour with the main class parameters. See <a
href="./doc/">Code documentation</a> for reference.</p>

<h2 id="label-Limitations">Limitations</h2>

<p>This module requires Puppet 4.x or above, and is compatible with the
following OSes/versions:</p>
<ul><li>
<p>Debian 10, 11, 12</p>
</li><li>
<p>Ubuntu 18.04, 20.04, 22.04</p>
</li></ul>

<p>It may work for other versions and OSes. Please report us if you are using
it on another envinment.</p>

<h2 id="label-Development">Development</h2>

<p>Development happens on <a
href="https://github.com/sbitio/puppet-pipx">GitHub</a>.</p>

<p>Please log issues for any bug report, feature or support request.</p>

<p>Pull requests are welcome.</p>

<h2 id="label-Disclaimer">Disclaimer</h2>

<h3 id="label-A+note+on+quality+score">A note on quality score</h3>

<p>This module has a poor quality score. We&#39;re not fixing it because it
comes from Puppet&#39;s pip package provider code it is based. It makes no
sense to us to address lint warnings and diverge from the base code.</p>

<h2 id="label-License">License</h2>

<p>MIT License, see LICENSE file</p>

<h2 id="label-Contact">Contact</h2>

<p>Use contact form on <a href="http://sbit.io">sbit.io</a></p>
</div></div>

      <div id="footer">
     Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

    </div>
  </body>
</html>