Mercurial Repositories > pipx Interface / changeset

changeset

Added the source code documentation.

Fri, 28 Jun 2024 17:24:18 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 28 Jun 2024 17:24:18 +0200
changeset 18
df1986d93746
parent 17
8c52c75a860c
child 19
70b187d5a9df

Added the source code documentation.

PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.PipxPage.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.Pipx.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxExecDialog.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxInterpretersDialog.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxPackagesInputDialog.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxReinstallDialog.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxSpecInputDialog.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxWidget.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PluginPipxInterface.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/index-Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/index-Plugin_Pipx_Interface.PipxInterface.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/index-Plugin_Pipx_Interface.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/index.html file | annotate | diff | comparison | revisions
PipxInterface/Documentation/Source/styles.css file | annotate | diff | comparison | revisions
PluginPipxInterface.epj file | annotate | diff | comparison | revisions 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.PipxPage.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,93 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.PipxPage</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.PipxPage</h1>
+<p>
+Module implementing the pipx configuration page.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxPage">PipxPage</a></td>
+<td>Class implementing the pipx configuration page.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxPage" ID="PipxPage"></a>
+<h2>PipxPage</h2>
+<p>
+    Class implementing the pipx configuration page.
+</p>
+
+<h3>Derived from</h3>
+ConfigurationPageBase, Ui_PipxPage
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxPage.__init__">PipxPage</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxPage.save">save</a></td>
+<td>Public slot to save the MQTT Monitor configuration.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxPage.__init__" ID="PipxPage.__init__"></a>
+<h4>PipxPage (Constructor)</h4>
+<b>PipxPage</b>(<i>plugin</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>plugin</i> (PluginPipxInterface)</dt>
+<dd>
+reference to the plugin object
+</dd>
+</dl>
+<a NAME="PipxPage.save" ID="PipxPage.save"></a>
+<h4>PipxPage.save</h4>
+<b>save</b>(<i></i>)
+<p>
+        Public slot to save the MQTT Monitor configuration.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.Pipx.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,608 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.Pipx</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.Pipx</h1>
+<p>
+Module implementing the pipx GUI logic.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Pipx">Pipx</a></td>
+<td>Class implementing the pip GUI logic.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="Pipx" ID="Pipx"></a>
+<h2>Pipx</h2>
+<p>
+    Class implementing the pip GUI logic.
+</p>
+
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Pipx.__init__">Pipx</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#Pipx.__getPipxExecutable">__getPipxExecutable</a></td>
+<td>Private method to get the path name of the pipx executable.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.__metadataDecoderHook">__metadataDecoderHook</a></td>
+<td>Private method to allow the JSON decoding of Path objects of a spec metadata file as created by 'pipx list --json'.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.checkPackageOutdated">checkPackageOutdated</a></td>
+<td>Public method to check, if a given package is outdated.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.createSpecMetadataFile">createSpecMetadataFile</a></td>
+<td>Public method to create a spec metadata file.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.getInstalledPackages">getInstalledPackages</a></td>
+<td>Public method to get the installed packages.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.getPipxInterpretersList">getPipxInterpretersList</a></td>
+<td>Public method returning a list all standalone interpreters.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.getPipxPaths">getPipxPaths</a></td>
+<td>Public method to get the paths used by pipx.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.getPipxStrPaths">getPipxStrPaths</a></td>
+<td>Public method to get the paths used by pipx.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.getPipxVersion">getPipxVersion</a></td>
+<td>Public method to get the version of the installed pipx package.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.getPipxVersionTuple">getPipxVersionTuple</a></td>
+<td>Public method to get the version tuple of the installed pipx package.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.installAllPackages">installAllPackages</a></td>
+<td>Public method to install all packages define by a given spec metadata file with given options.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.installPackages">installPackages</a></td>
+<td>Public method to install a list of packages with the given options.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.pruneInterpreters">pruneInterpreters</a></td>
+<td>Public method to prune unused interpreters.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.reinstallAllPackages">reinstallAllPackages</a></td>
+<td>Public method to reinstall all packages with given options.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.reinstallPackage">reinstallPackage</a></td>
+<td>Public method to reinstall the given package with given options.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.runPipxProcess">runPipxProcess</a></td>
+<td>Public method to execute pipx with the given arguments.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.uninstallAllPackages">uninstallAllPackages</a></td>
+<td>Public method to uninstall all pipx managed packages.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.uninstallPackage">uninstallPackage</a></td>
+<td>Public method to uninstall the given package.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.upgradeAllPackages">upgradeAllPackages</a></td>
+<td>Public method to upgrade all package.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.upgradeInterpreters">upgradeInterpreters</a></td>
+<td>Public method to upgrade the installed interpreters to the latest available micro/patch version.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.upgradePackage">upgradePackage</a></td>
+<td>Public method to upgrade the given package.</td>
+</tr>
+<tr>
+<td><a href="#Pipx.upgradeSharedLibraries">upgradeSharedLibraries</a></td>
+<td>Public method to upgrade shared libraries.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="Pipx.__init__" ID="Pipx.__init__"></a>
+<h4>Pipx (Constructor)</h4>
+<b>Pipx</b>(<i>parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>parent</i> (QObject)</dt>
+<dd>
+reference to the user interface object
+</dd>
+</dl>
+<a NAME="Pipx.__getPipxExecutable" ID="Pipx.__getPipxExecutable"></a>
+<h4>Pipx.__getPipxExecutable</h4>
+<b>__getPipxExecutable</b>(<i></i>)
+<p>
+        Private method to get the path name of the pipx executable.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+path name of the pipx executable
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="Pipx.__metadataDecoderHook" ID="Pipx.__metadataDecoderHook"></a>
+<h4>Pipx.__metadataDecoderHook</h4>
+<b>__metadataDecoderHook</b>(<i>jsonDict</i>)
+<p>
+        Private method to allow the JSON decoding of Path objects of a spec metadata
+        file as created by 'pipx list --json'.
+</p>
+
+<dl>
+
+<dt><i>jsonDict</i> (dict)</dt>
+<dd>
+JSON dictionary to be decoded
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+decoded Path object or the dictionary unaltered
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict or pathlib.Path
+</dd>
+</dl>
+<a NAME="Pipx.checkPackageOutdated" ID="Pipx.checkPackageOutdated"></a>
+<h4>Pipx.checkPackageOutdated</h4>
+<b>checkPackageOutdated</b>(<i>package</i>)
+<p>
+        Public method to check, if a given package is outdated.
+</p>
+
+<dl>
+
+<dt><i>package</i> (str)</dt>
+<dd>
+name of the package
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+latest version in case the package is outdated and None otherwise
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str or None
+</dd>
+</dl>
+<a NAME="Pipx.createSpecMetadataFile" ID="Pipx.createSpecMetadataFile"></a>
+<h4>Pipx.createSpecMetadataFile</h4>
+<b>createSpecMetadataFile</b>(<i>specFile</i>)
+<p>
+        Public method to create a spec metadata file.
+</p>
+
+<dl>
+
+<dt><i>specFile</i> (str)</dt>
+<dd>
+path of the spec metadata file
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message in case
+            of failure
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<a NAME="Pipx.getInstalledPackages" ID="Pipx.getInstalledPackages"></a>
+<h4>Pipx.getInstalledPackages</h4>
+<b>getInstalledPackages</b>(<i></i>)
+<p>
+        Public method to get the installed packages.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of dictionaries containing the installed packages and apps
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of dict[str, str | list]
+</dd>
+</dl>
+<a NAME="Pipx.getPipxInterpretersList" ID="Pipx.getPipxInterpretersList"></a>
+<h4>Pipx.getPipxInterpretersList</h4>
+<b>getPipxInterpretersList</b>(<i></i>)
+<p>
+        Public method returning a list all standalone interpreters.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing data of standalone interpreters
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<a NAME="Pipx.getPipxPaths" ID="Pipx.getPipxPaths"></a>
+<h4>Pipx.getPipxPaths</h4>
+<b>getPipxPaths</b>(<i></i>)
+<p>
+        Public method to get the paths used by pipx.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the various pipx paths. The keys are
+            'venvsPath', 'appsPath' and 'manPath'.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict[str, Path]
+</dd>
+</dl>
+<a NAME="Pipx.getPipxStrPaths" ID="Pipx.getPipxStrPaths"></a>
+<h4>Pipx.getPipxStrPaths</h4>
+<b>getPipxStrPaths</b>(<i></i>)
+<p>
+        Public method to get the paths used by pipx.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the various pipx paths. The keys are
+            'venvsPath', 'appsPath' and 'manPath'.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict[str, str]
+</dd>
+</dl>
+<a NAME="Pipx.getPipxVersion" ID="Pipx.getPipxVersion"></a>
+<h4>Pipx.getPipxVersion</h4>
+<b>getPipxVersion</b>(<i></i>)
+<p>
+        Public method to get the version of the installed pipx package.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+string containing the pipx version number
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="Pipx.getPipxVersionTuple" ID="Pipx.getPipxVersionTuple"></a>
+<h4>Pipx.getPipxVersionTuple</h4>
+<b>getPipxVersionTuple</b>(<i></i>)
+<p>
+        Public method to get the version tuple of the installed pipx package.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the elements of the pipx version number
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int, int)
+</dd>
+</dl>
+<a NAME="Pipx.installAllPackages" ID="Pipx.installAllPackages"></a>
+<h4>Pipx.installAllPackages</h4>
+<b>installAllPackages</b>(<i>specFile, interpreterVersion="", fetchMissingInterpreter=False, forceVenvModification=False, systemSitePackages=False, </i>)
+<p>
+        Public method to install all packages define by a given spec metadata file
+        with given options.
+</p>
+
+<dl>
+
+<dt><i>specFile</i> (str)</dt>
+<dd>
+path of the spec metadata file
+</dd>
+<dt><i>interpreterVersion</i> (str (optional))</dt>
+<dd>
+version of the Python interpreter (defaults to "")
+</dd>
+<dt><i>fetchMissingInterpreter</i> (bool (optional))</dt>
+<dd>
+flag indicating to fetch a standalone Python
+            build from GitHub if the specified Python version is not found locally
+            on the system (defaults to False)
+</dd>
+<dt><i>forceVenvModification</i> (bool (optional))</dt>
+<dd>
+flag indicating to allow modification of already
+            existing virtual environments (defaults to False)
+</dd>
+<dt><i>systemSitePackages</i> (bool (optional))</dt>
+<dd>
+flag indicating to give access to the system
+            site-packages directory (defaults to False)
+</dd>
+</dl>
+<a NAME="Pipx.installPackages" ID="Pipx.installPackages"></a>
+<h4>Pipx.installPackages</h4>
+<b>installPackages</b>(<i>packages, interpreterVersion="", fetchMissingInterpreter=False, forceVenvModification=False, systemSitePackages=False, </i>)
+<p>
+        Public method to install a list of packages with the given options.
+</p>
+
+<dl>
+
+<dt><i>packages</i> (list of str)</dt>
+<dd>
+list of packages to install
+</dd>
+<dt><i>interpreterVersion</i> (str (optional))</dt>
+<dd>
+version of the Python interpreter (defaults to "")
+</dd>
+<dt><i>fetchMissingInterpreter</i> (bool (optional))</dt>
+<dd>
+flag indicating to fetch a standalone Python
+            build from GitHub if the specified Python version is not found locally
+            on the system (defaults to False)
+</dd>
+<dt><i>forceVenvModification</i> (bool (optional))</dt>
+<dd>
+flag indicating to allow modification of already
+            existing virtual environments (defaults to False)
+</dd>
+<dt><i>systemSitePackages</i> (bool (optional))</dt>
+<dd>
+flag indicating to give access to the system
+            site-packages directory (defaults to False)
+</dd>
+</dl>
+<a NAME="Pipx.pruneInterpreters" ID="Pipx.pruneInterpreters"></a>
+<h4>Pipx.pruneInterpreters</h4>
+<b>pruneInterpreters</b>(<i>dialogParent=None</i>)
+<p>
+        Public method to prune unused interpreters.
+</p>
+
+<dl>
+
+<dt><i>dialogParent</i> (QWidget)</dt>
+<dd>
+parent widget of the execution dialog
+</dd>
+</dl>
+<a NAME="Pipx.reinstallAllPackages" ID="Pipx.reinstallAllPackages"></a>
+<h4>Pipx.reinstallAllPackages</h4>
+<b>reinstallAllPackages</b>(<i>interpreterVersion="", fetchMissingInterpreter=False, skipPackages=None, </i>)
+<p>
+        Public method to reinstall all packages with given options.
+</p>
+
+<dl>
+
+<dt><i>interpreterVersion</i> (str (optional))</dt>
+<dd>
+version of the Python interpreter (defaults to "")
+</dd>
+<dt><i>fetchMissingInterpreter</i> (bool (optional))</dt>
+<dd>
+flag indicating to fetch a standalone Python
+            build from GitHub if the specified Python version is not found locally
+            on the system (defaults to False)
+</dd>
+<dt><i>skipPackages</i> (list of str (optional))</dt>
+<dd>
+list of packages to be skipped by the 'reinstall-all'
+            command (defaults to None)
+</dd>
+</dl>
+<a NAME="Pipx.reinstallPackage" ID="Pipx.reinstallPackage"></a>
+<h4>Pipx.reinstallPackage</h4>
+<b>reinstallPackage</b>(<i>package, interpreterVersion="", fetchMissingInterpreter=False, </i>)
+<p>
+        Public method to reinstall the given package with given options.
+</p>
+
+<dl>
+
+<dt><i>package</i> (str)</dt>
+<dd>
+name of the package to reinstall
+</dd>
+<dt><i>interpreterVersion</i> (str (optional))</dt>
+<dd>
+version of the Python interpreter (defaults to "")
+</dd>
+<dt><i>fetchMissingInterpreter</i> (bool (optional))</dt>
+<dd>
+flag indicating to fetch a standalone Python
+            build from GitHub if the specified Python version is not found locally
+            on the system (defaults to False)
+</dd>
+</dl>
+<a NAME="Pipx.runPipxProcess" ID="Pipx.runPipxProcess"></a>
+<h4>Pipx.runPipxProcess</h4>
+<b>runPipxProcess</b>(<i>args</i>)
+<p>
+        Public method to execute pipx with the given arguments.
+</p>
+
+<dl>
+
+<dt><i>args</i> (list of str)</dt>
+<dd>
+list of command line arguments for pipx
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and the output
+            of the process
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<a NAME="Pipx.uninstallAllPackages" ID="Pipx.uninstallAllPackages"></a>
+<h4>Pipx.uninstallAllPackages</h4>
+<b>uninstallAllPackages</b>(<i></i>)
+<p>
+        Public method to uninstall all pipx managed packages.
+</p>
+
+<a NAME="Pipx.uninstallPackage" ID="Pipx.uninstallPackage"></a>
+<h4>Pipx.uninstallPackage</h4>
+<b>uninstallPackage</b>(<i>package</i>)
+<p>
+        Public method to uninstall the given package.
+</p>
+
+<dl>
+
+<dt><i>package</i> (str)</dt>
+<dd>
+name of the package to be uninstalled
+</dd>
+</dl>
+<a NAME="Pipx.upgradeAllPackages" ID="Pipx.upgradeAllPackages"></a>
+<h4>Pipx.upgradeAllPackages</h4>
+<b>upgradeAllPackages</b>(<i></i>)
+<p>
+        Public method to upgrade all package.
+</p>
+
+<a NAME="Pipx.upgradeInterpreters" ID="Pipx.upgradeInterpreters"></a>
+<h4>Pipx.upgradeInterpreters</h4>
+<b>upgradeInterpreters</b>(<i>dialogParent=None</i>)
+<p>
+        Public method to upgrade the installed interpreters to the latest available
+        micro/patch version.
+</p>
+
+<dl>
+
+<dt><i>dialogParent</i> (QWidget)</dt>
+<dd>
+parent widget of the execution dialog
+</dd>
+</dl>
+<a NAME="Pipx.upgradePackage" ID="Pipx.upgradePackage"></a>
+<h4>Pipx.upgradePackage</h4>
+<b>upgradePackage</b>(<i>package</i>)
+<p>
+        Public method to upgrade the given package.
+</p>
+
+<dl>
+
+<dt><i>package</i> (str)</dt>
+<dd>
+name of the package
+</dd>
+</dl>
+<a NAME="Pipx.upgradeSharedLibraries" ID="Pipx.upgradeSharedLibraries"></a>
+<h4>Pipx.upgradeSharedLibraries</h4>
+<b>upgradeSharedLibraries</b>(<i></i>)
+<p>
+        Public method to upgrade shared libraries.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,250 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog</h1>
+<p>
+Module implementing a dialog to enter the application command line parameters and
+to execute the app.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxAppStartDialog">PipxAppStartDialog</a></td>
+<td>Class implementing a dialog to enter the application command line parameters and to execute the app.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxAppStartDialog" ID="PipxAppStartDialog"></a>
+<h2>PipxAppStartDialog</h2>
+<p>
+    Class implementing a dialog to enter the application command line parameters and
+    to execute the app.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_PipxAppStartDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxAppStartDialog.__init__">PipxAppStartDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__addOutput">__addOutput</a></td>
+<td>Private method to add some text to the output pane.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__cancel">__cancel</a></td>
+<td>Private slot to cancel the current action.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__finish">__finish</a></td>
+<td>Private slot called when the process finished or the user pressed the button.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__populateWorkDirs">__populateWorkDirs</a></td>
+<td>Private method to populate the working directory selector.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__procFinished">__procFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStandardError signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStandardOutput signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.closeEvent">closeEvent</a></td>
+<td>Protected slot implementing a close event handler.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr>
+<tr>
+<td><a href="#PipxAppStartDialog.on_executeButton_clicked">on_executeButton_clicked</a></td>
+<td>Private slot to execute the selected app with the entered parameters.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxAppStartDialog.__init__" ID="PipxAppStartDialog.__init__"></a>
+<h4>PipxAppStartDialog (Constructor)</h4>
+<b>PipxAppStartDialog</b>(<i>app, plugin, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>app</i> (str)</dt>
+<dd>
+path of the application to be executed
+</dd>
+<dt><i>plugin</i> (PluginPipxInterface)</dt>
+<dd>
+reference to the plug-in object
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="PipxAppStartDialog.__addOutput" ID="PipxAppStartDialog.__addOutput"></a>
+<h4>PipxAppStartDialog.__addOutput</h4>
+<b>__addOutput</b>(<i>txt</i>)
+<p>
+        Private method to add some text to the output pane.
+</p>
+
+<dl>
+
+<dt><i>txt</i> (str)</dt>
+<dd>
+text to be added
+</dd>
+</dl>
+<a NAME="PipxAppStartDialog.__cancel" ID="PipxAppStartDialog.__cancel"></a>
+<h4>PipxAppStartDialog.__cancel</h4>
+<b>__cancel</b>(<i></i>)
+<p>
+        Private slot to cancel the current action.
+</p>
+
+<a NAME="PipxAppStartDialog.__finish" ID="PipxAppStartDialog.__finish"></a>
+<h4>PipxAppStartDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+        Private slot called when the process finished or the user pressed
+        the button.
+</p>
+
+<a NAME="PipxAppStartDialog.__populateWorkDirs" ID="PipxAppStartDialog.__populateWorkDirs"></a>
+<h4>PipxAppStartDialog.__populateWorkDirs</h4>
+<b>__populateWorkDirs</b>(<i>mostRecent=None</i>)
+<p>
+        Private method to populate the working directory selector.
+</p>
+
+<dl>
+
+<dt><i>mostRecent</i> (str)</dt>
+<dd>
+most recently used working directory
+</dd>
+</dl>
+<a NAME="PipxAppStartDialog.__procFinished" ID="PipxAppStartDialog.__procFinished"></a>
+<h4>PipxAppStartDialog.__procFinished</h4>
+<b>__procFinished</b>(<i>_exitCode, _exitStatus</i>)
+<p>
+        Private slot connected to the finished signal.
+</p>
+
+<dl>
+
+<dt><i>_exitCode</i> (int)</dt>
+<dd>
+exit code of the process (unused)
+</dd>
+<dt><i>_exitStatus</i> (QProcess.ExitStatus)</dt>
+<dd>
+exit status of the process (unused)
+</dd>
+</dl>
+<a NAME="PipxAppStartDialog.__readStderr" ID="PipxAppStartDialog.__readStderr"></a>
+<h4>PipxAppStartDialog.__readStderr</h4>
+<b>__readStderr</b>(<i></i>)
+<p>
+        Private slot to handle the readyReadStandardError signal.
+</p>
+<p>
+        It reads the error output of the process and inserts it into the
+        error pane.
+</p>
+
+<a NAME="PipxAppStartDialog.__readStdout" ID="PipxAppStartDialog.__readStdout"></a>
+<h4>PipxAppStartDialog.__readStdout</h4>
+<b>__readStdout</b>(<i></i>)
+<p>
+        Private slot to handle the readyReadStandardOutput signal.
+</p>
+<p>
+        It reads the output of the process, formats it and inserts it into
+        the contents pane.
+</p>
+
+<a NAME="PipxAppStartDialog.closeEvent" ID="PipxAppStartDialog.closeEvent"></a>
+<h4>PipxAppStartDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>e</i>)
+<p>
+        Protected slot implementing a close event handler.
+</p>
+
+<dl>
+
+<dt><i>e</i> (QCloseEvent)</dt>
+<dd>
+close event
+</dd>
+</dl>
+<a NAME="PipxAppStartDialog.on_buttonBox_clicked" ID="PipxAppStartDialog.on_buttonBox_clicked"></a>
+<h4>PipxAppStartDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+        Private slot called by a button of the button box clicked.
+</p>
+
+<dl>
+
+<dt><i>button</i> (QAbstractButton)</dt>
+<dd>
+button that was clicked
+</dd>
+</dl>
+<a NAME="PipxAppStartDialog.on_executeButton_clicked" ID="PipxAppStartDialog.on_executeButton_clicked"></a>
+<h4>PipxAppStartDialog.on_executeButton_clicked</h4>
+<b>on_executeButton_clicked</b>(<i></i>)
+<p>
+        Private slot to execute the selected app with the entered parameters.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxExecDialog.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,285 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxExecDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxExecDialog</h1>
+<p>
+Module implementing a dialog showing the output of a pip command.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxExecDialog">PipxExecDialog</a></td>
+<td>Class implementing a dialog showing the output of a 'python -m pip' command.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxExecDialog" ID="PipxExecDialog"></a>
+<h2>PipxExecDialog</h2>
+<p>
+    Class implementing a dialog showing the output of a 'python -m pip'
+    command.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_PipxExecDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxExecDialog.__init__">PipxExecDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__addOutput">__addOutput</a></td>
+<td>Private method to add some text to the output pane.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__cancel">__cancel</a></td>
+<td>Private slot to cancel the current action.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__finish">__finish</a></td>
+<td>Private slot called when the process finished or the user pressed the button.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__procFinished">__procFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStandardError signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStandardOutput signal.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.closeEvent">closeEvent</a></td>
+<td>Protected slot implementing a close event handler.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot called by a button of the button box clicked.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.startProcess">startProcess</a></td>
+<td>Public slot used to start the process.</td>
+</tr>
+<tr>
+<td><a href="#PipxExecDialog.startProcesses">startProcesses</a></td>
+<td>Public method to issue a list of commands to be executed.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxExecDialog.__init__" ID="PipxExecDialog.__init__"></a>
+<h4>PipxExecDialog (Constructor)</h4>
+<b>PipxExecDialog</b>(<i>text, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>text</i> (str)</dt>
+<dd>
+text to be shown by the label
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="PipxExecDialog.__addOutput" ID="PipxExecDialog.__addOutput"></a>
+<h4>PipxExecDialog.__addOutput</h4>
+<b>__addOutput</b>(<i>txt</i>)
+<p>
+        Private method to add some text to the output pane.
+</p>
+
+<dl>
+
+<dt><i>txt</i> (str)</dt>
+<dd>
+text to be added
+</dd>
+</dl>
+<a NAME="PipxExecDialog.__cancel" ID="PipxExecDialog.__cancel"></a>
+<h4>PipxExecDialog.__cancel</h4>
+<b>__cancel</b>(<i></i>)
+<p>
+        Private slot to cancel the current action.
+</p>
+
+<a NAME="PipxExecDialog.__finish" ID="PipxExecDialog.__finish"></a>
+<h4>PipxExecDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+        Private slot called when the process finished or the user pressed
+        the button.
+</p>
+
+<a NAME="PipxExecDialog.__procFinished" ID="PipxExecDialog.__procFinished"></a>
+<h4>PipxExecDialog.__procFinished</h4>
+<b>__procFinished</b>(<i>_exitCode, _exitStatus</i>)
+<p>
+        Private slot connected to the finished signal.
+</p>
+
+<dl>
+
+<dt><i>_exitCode</i> (int)</dt>
+<dd>
+exit code of the process (unused)
+</dd>
+<dt><i>_exitStatus</i> (QProcess.ExitStatus)</dt>
+<dd>
+exit status of the process (unused)
+</dd>
+</dl>
+<a NAME="PipxExecDialog.__readStderr" ID="PipxExecDialog.__readStderr"></a>
+<h4>PipxExecDialog.__readStderr</h4>
+<b>__readStderr</b>(<i></i>)
+<p>
+        Private slot to handle the readyReadStandardError signal.
+</p>
+<p>
+        It reads the error output of the process and inserts it into the
+        error pane.
+</p>
+
+<a NAME="PipxExecDialog.__readStdout" ID="PipxExecDialog.__readStdout"></a>
+<h4>PipxExecDialog.__readStdout</h4>
+<b>__readStdout</b>(<i></i>)
+<p>
+        Private slot to handle the readyReadStandardOutput signal.
+</p>
+<p>
+        It reads the output of the process, formats it and inserts it into
+        the contents pane.
+</p>
+
+<a NAME="PipxExecDialog.closeEvent" ID="PipxExecDialog.closeEvent"></a>
+<h4>PipxExecDialog.closeEvent</h4>
+<b>closeEvent</b>(<i>e</i>)
+<p>
+        Protected slot implementing a close event handler.
+</p>
+
+<dl>
+
+<dt><i>e</i> (QCloseEvent)</dt>
+<dd>
+close event
+</dd>
+</dl>
+<a NAME="PipxExecDialog.on_buttonBox_clicked" ID="PipxExecDialog.on_buttonBox_clicked"></a>
+<h4>PipxExecDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+        Private slot called by a button of the button box clicked.
+</p>
+
+<dl>
+
+<dt><i>button</i> (QAbstractButton)</dt>
+<dd>
+button that was clicked
+</dd>
+</dl>
+<a NAME="PipxExecDialog.startProcess" ID="PipxExecDialog.startProcess"></a>
+<h4>PipxExecDialog.startProcess</h4>
+<b>startProcess</b>(<i>pipx, args, showArgs=True</i>)
+<p>
+        Public slot used to start the process.
+</p>
+
+<dl>
+
+<dt><i>pipx</i> (str)</dt>
+<dd>
+path to the 'pipx' executable to be used
+</dd>
+<dt><i>args</i> (list of str)</dt>
+<dd>
+list of arguments for the process
+</dd>
+<dt><i>showArgs</i> (bool)</dt>
+<dd>
+flag indicating to show the arguments
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a successful start of the process
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PipxExecDialog.startProcesses" ID="PipxExecDialog.startProcesses"></a>
+<h4>PipxExecDialog.startProcesses</h4>
+<b>startProcesses</b>(<i>processParams</i>)
+<p>
+        Public method to issue a list of commands to be executed.
+</p>
+
+<dl>
+
+<dt><i>processParams</i> (list of tuples of (str, list of str))</dt>
+<dd>
+list of tuples containing the command
+            and arguments
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a successful start of the first process
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxInterpretersDialog.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,120 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxInterpretersDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxInterpretersDialog</h1>
+<p>
+Module implementing a dialog to show the available standalone Python interpreters.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxInterpretersDialog">PipxInterpretersDialog</a></td>
+<td>Class implementing a dialog to show the available standalone Python interpreters.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxInterpretersDialog" ID="PipxInterpretersDialog"></a>
+<h2>PipxInterpretersDialog</h2>
+<p>
+    Class implementing a dialog to show the available standalone Python interpreters.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_PipxInterpretersDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxInterpretersDialog.__init__">PipxInterpretersDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxInterpretersDialog.__populateInterpretersList">__populateInterpretersList</a></td>
+<td>Private slot to populate the list of standalone Python interpreters.</td>
+</tr>
+<tr>
+<td><a href="#PipxInterpretersDialog.on_pruneButton_clicked">on_pruneButton_clicked</a></td>
+<td>Private slot to prune unused interpreters.</td>
+</tr>
+<tr>
+<td><a href="#PipxInterpretersDialog.on_upgradeButton_clicked">on_upgradeButton_clicked</a></td>
+<td>Private slot to upgrade all pipx managed interpreters to the latest available micro/patch version.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxInterpretersDialog.__init__" ID="PipxInterpretersDialog.__init__"></a>
+<h4>PipxInterpretersDialog (Constructor)</h4>
+<b>PipxInterpretersDialog</b>(<i>pipx, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>pipx</i> (Pipx)</dt>
+<dd>
+reference to the pipx interface
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="PipxInterpretersDialog.__populateInterpretersList" ID="PipxInterpretersDialog.__populateInterpretersList"></a>
+<h4>PipxInterpretersDialog.__populateInterpretersList</h4>
+<b>__populateInterpretersList</b>(<i></i>)
+<p>
+        Private slot to populate the list of standalone Python interpreters.
+</p>
+
+<a NAME="PipxInterpretersDialog.on_pruneButton_clicked" ID="PipxInterpretersDialog.on_pruneButton_clicked"></a>
+<h4>PipxInterpretersDialog.on_pruneButton_clicked</h4>
+<b>on_pruneButton_clicked</b>(<i></i>)
+<p>
+        Private slot to prune unused interpreters.
+</p>
+
+<a NAME="PipxInterpretersDialog.on_upgradeButton_clicked" ID="PipxInterpretersDialog.on_upgradeButton_clicked"></a>
+<h4>PipxInterpretersDialog.on_upgradeButton_clicked</h4>
+<b>on_upgradeButton_clicked</b>(<i></i>)
+<p>
+        Private slot to upgrade all pipx managed interpreters to the latest available
+        micro/patch version.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxPackagesInputDialog.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,135 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxPackagesInputDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxPackagesInputDialog</h1>
+<p>
+Module implementing a dialog to enter package specifications.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxPackagesInputDialog">PipxPackagesInputDialog</a></td>
+<td>Class implementing a dialog to enter package specifications and installation options.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxPackagesInputDialog" ID="PipxPackagesInputDialog"></a>
+<h2>PipxPackagesInputDialog</h2>
+<p>
+    Class implementing a dialog to enter package specifications and installation
+    options.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_PipxPackagesInputDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxPackagesInputDialog.__init__">PipxPackagesInputDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxPackagesInputDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr>
+<tr>
+<td><a href="#PipxPackagesInputDialog.on_packagesEdit_textChanged">on_packagesEdit_textChanged</a></td>
+<td>Private slot handling entering package names.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxPackagesInputDialog.__init__" ID="PipxPackagesInputDialog.__init__"></a>
+<h4>PipxPackagesInputDialog (Constructor)</h4>
+<b>PipxPackagesInputDialog</b>(<i>title, install=True, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>title</i> (str)</dt>
+<dd>
+dialog title
+</dd>
+<dt><i>install</i> (bool)</dt>
+<dd>
+flag indicating an install action
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="PipxPackagesInputDialog.getData" ID="PipxPackagesInputDialog.getData"></a>
+<h4>PipxPackagesInputDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to get the entered data.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple with the list of package specifications, the desired Python
+            interpreter version, a flag indicating to fetch a missing interpreter
+            from GitHub, a flag indicating to force the installation and a flag
+            indicating to give access to the system site-packages directory.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, str, bool, bool, bool)
+</dd>
+</dl>
+<a NAME="PipxPackagesInputDialog.on_packagesEdit_textChanged" ID="PipxPackagesInputDialog.on_packagesEdit_textChanged"></a>
+<h4>PipxPackagesInputDialog.on_packagesEdit_textChanged</h4>
+<b>on_packagesEdit_textChanged</b>(<i>txt</i>)
+<p>
+        Private slot handling entering package names.
+</p>
+
+<dl>
+
+<dt><i>txt</i> (str)</dt>
+<dd>
+name of the requirements file
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxReinstallDialog.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,113 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxReinstallDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxReinstallDialog</h1>
+<p>
+Module implementing a dialog to enter the desired Python interpreter version.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxReinstallDialog">PipxReinstallDialog</a></td>
+<td>Class implementing a dialog to enter the desired Python interpreter version.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxReinstallDialog" ID="PipxReinstallDialog"></a>
+<h2>PipxReinstallDialog</h2>
+<p>
+    Class implementing a dialog to enter the desired Python interpreter version.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_PipxReinstallDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxReinstallDialog.__init__">PipxReinstallDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxReinstallDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxReinstallDialog.__init__" ID="PipxReinstallDialog.__init__"></a>
+<h4>PipxReinstallDialog (Constructor)</h4>
+<b>PipxReinstallDialog</b>(<i>reinstallAll=False, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>reinstallAll</i> (bool)</dt>
+<dd>
+flag indicating to get the parameters for a 'reinstall-all'
+            action
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="PipxReinstallDialog.getData" ID="PipxReinstallDialog.getData"></a>
+<h4>PipxReinstallDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to get the entered data.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the desired Python version, a flag indicating
+            to fetch a standalone Python build from GitHub if the specified Python
+            version is not found locally on the system and a list of packages to skip
+            in case of a 'reinstall-all'
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, bool, list of str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxSpecInputDialog.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,130 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxSpecInputDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxSpecInputDialog</h1>
+<p>
+Module implementing a dialog to enter the data for an 'install-all' operation.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxSpecInputDialog">PipxSpecInputDialog</a></td>
+<td>Class implementing a dialog to enter the data for an 'install-all' operation.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxSpecInputDialog" ID="PipxSpecInputDialog"></a>
+<h2>PipxSpecInputDialog</h2>
+<p>
+    Class implementing a dialog to enter the data for an 'install-all' operation.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_PipxSpecInputDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxSpecInputDialog.__init__">PipxSpecInputDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxSpecInputDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr>
+<tr>
+<td><a href="#PipxSpecInputDialog.on_specFilePicker_textChanged">on_specFilePicker_textChanged</a></td>
+<td>Private slot handling entering a file path.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxSpecInputDialog.__init__" ID="PipxSpecInputDialog.__init__"></a>
+<h4>PipxSpecInputDialog (Constructor)</h4>
+<b>PipxSpecInputDialog</b>(<i>title, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>title</i> (str)</dt>
+<dd>
+dialog title
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="PipxSpecInputDialog.getData" ID="PipxSpecInputDialog.getData"></a>
+<h4>PipxSpecInputDialog.getData</h4>
+<b>getData</b>(<i></i>)
+<p>
+        Public method to get the entered data.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple with the file path of the spec metadata file, the desired Python
+            interpreter version, a flag indicating to fetch a missing interpreter
+            from GitHub, a flag indicating to force the installation and a flag
+            indicating to give access to the system site-packages directory.
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, str, bool, bool, bool)
+</dd>
+</dl>
+<a NAME="PipxSpecInputDialog.on_specFilePicker_textChanged" ID="PipxSpecInputDialog.on_specFilePicker_textChanged"></a>
+<h4>PipxSpecInputDialog.on_specFilePicker_textChanged</h4>
+<b>on_specFilePicker_textChanged</b>(<i>txt</i>)
+<p>
+        Private slot handling entering a file path.
+</p>
+
+<dl>
+
+<dt><i>txt</i> (str)</dt>
+<dd>
+path of the spec metadata file
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.PipxWidget.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,384 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.PipxWidget</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PipxInterface.PipxWidget</h1>
+<p>
+Module implementing the pipx management widget.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PipxWidget">PipxWidget</a></td>
+<td>Class documentation goes here.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PipxWidget" ID="PipxWidget"></a>
+<h2>PipxWidget</h2>
+<p>
+    Class documentation goes here.
+</p>
+
+<h3>Derived from</h3>
+QWidget, Ui_PipxWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>AppPathRole</td></tr>
+<tr><td>LatestVersionRole</td></tr>
+<tr><td>PackageColumn</td></tr>
+<tr><td>PythonVersionColumn</td></tr>
+<tr><td>VersionColumn</td></tr>
+<tr><td>VersionRole</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PipxWidget.__init__">PipxWidget</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__aboutToShowPipxMenu">__aboutToShowPipxMenu</a></td>
+<td>Private slot to set the action enabled status.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__checkOutdatedPackages">__checkOutdatedPackages</a></td>
+<td>Private slot to check, if there are any outdated packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__createSpecMetadataFile">__createSpecMetadataFile</a></td>
+<td>Private slot to create a spec metadata file needed by 'pipx install-all'.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__initPipxMenu">__initPipxMenu</a></td>
+<td>Private method to create the super menu and attach it to the super menu button.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__installAllPackages">__installAllPackages</a></td>
+<td>Private slot to install all packages listed in a specification file.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__installPackages">__installPackages</a></td>
+<td>Private slot to install packages to be given by the user.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__markPackageOutdated">__markPackageOutdated</a></td>
+<td>Private method to mark the given package item as outdated.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__pipxConfigure">__pipxConfigure</a></td>
+<td>Private slot to show the pipx configuration page.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__populatePackages">__populatePackages</a></td>
+<td>Private method to populate the packages list.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__reinstallAllPackages">__reinstallAllPackages</a></td>
+<td>Private slot to force a re-installation of all packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__reinstallPackage">__reinstallPackage</a></td>
+<td>Private slot to force a re-installation of the selected package.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__resizePackagesColumns">__resizePackagesColumns</a></td>
+<td>Private method to resize the columns of the packages list.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__selectedPackages">__selectedPackages</a></td>
+<td>Private method to determine the list of selected packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__showInterpreters">__showInterpreters</a></td>
+<td>Private slot to show a list of standalone Python interpreters.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__showPipxVersion">__showPipxVersion</a></td>
+<td>Private method to show the pipx version in the widget header.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__uninstallAllPackages">__uninstallAllPackages</a></td>
+<td>Private slot to uninstall all packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__uninstallPackage">__uninstallPackage</a></td>
+<td>Private slot to uninstall the selected package.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__upgradeAllPackages">__upgradeAllPackages</a></td>
+<td>Private slot to upgrade all packages.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__upgradePackage">__upgradePackage</a></td>
+<td>Private slot to upgrade the selected package.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.__upgradeSharedLibs">__upgradeSharedLibs</a></td>
+<td>Private slot to upgrade the shared libraries.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.on_packagesList_itemActivated">on_packagesList_itemActivated</a></td>
+<td>Private slot to start the activated item, if it is not a top level one.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
+<td>Private slot to handle a change of selected packages and apps.</td>
+</tr>
+<tr>
+<td><a href="#PipxWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
+<td>Private slot to refresh the packages list.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PipxWidget.__init__" ID="PipxWidget.__init__"></a>
+<h4>PipxWidget (Constructor)</h4>
+<b>PipxWidget</b>(<i>plugin, fromEric=True, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>plugin</i> (MqttMonitorPlugin)</dt>
+<dd>
+reference to the plug-in object
+</dd>
+<dt><i>fromEric</i> (bool (optional))</dt>
+<dd>
+flag indicating the eric-ide mode (defaults to True)
+            (True = eric-ide mode, False = application mode)
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="PipxWidget.__aboutToShowPipxMenu" ID="PipxWidget.__aboutToShowPipxMenu"></a>
+<h4>PipxWidget.__aboutToShowPipxMenu</h4>
+<b>__aboutToShowPipxMenu</b>(<i></i>)
+<p>
+        Private slot to set the action enabled status.
+</p>
+
+<a NAME="PipxWidget.__checkOutdatedPackages" ID="PipxWidget.__checkOutdatedPackages"></a>
+<h4>PipxWidget.__checkOutdatedPackages</h4>
+<b>__checkOutdatedPackages</b>(<i></i>)
+<p>
+        Private slot to check, if there are any outdated packages.
+</p>
+
+<a NAME="PipxWidget.__createSpecMetadataFile" ID="PipxWidget.__createSpecMetadataFile"></a>
+<h4>PipxWidget.__createSpecMetadataFile</h4>
+<b>__createSpecMetadataFile</b>(<i></i>)
+<p>
+        Private slot to create a spec metadata file needed by 'pipx install-all'.
+</p>
+
+<a NAME="PipxWidget.__initPipxMenu" ID="PipxWidget.__initPipxMenu"></a>
+<h4>PipxWidget.__initPipxMenu</h4>
+<b>__initPipxMenu</b>(<i></i>)
+<p>
+        Private method to create the super menu and attach it to the super
+        menu button.
+</p>
+
+<a NAME="PipxWidget.__installAllPackages" ID="PipxWidget.__installAllPackages"></a>
+<h4>PipxWidget.__installAllPackages</h4>
+<b>__installAllPackages</b>(<i></i>)
+<p>
+        Private slot to install all packages listed in a specification file.
+</p>
+
+<a NAME="PipxWidget.__installPackages" ID="PipxWidget.__installPackages"></a>
+<h4>PipxWidget.__installPackages</h4>
+<b>__installPackages</b>(<i></i>)
+<p>
+        Private slot to install packages to be given by the user.
+</p>
+
+<a NAME="PipxWidget.__markPackageOutdated" ID="PipxWidget.__markPackageOutdated"></a>
+<h4>PipxWidget.__markPackageOutdated</h4>
+<b>__markPackageOutdated</b>(<i>item, latestVersion</i>)
+<p>
+        Private method to mark the given package item as outdated.
+</p>
+
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the outdated package item
+</dd>
+<dt><i>latestVersion</i> (str)</dt>
+<dd>
+latest version of the package
+</dd>
+</dl>
+<a NAME="PipxWidget.__pipxConfigure" ID="PipxWidget.__pipxConfigure"></a>
+<h4>PipxWidget.__pipxConfigure</h4>
+<b>__pipxConfigure</b>(<i></i>)
+<p>
+        Private slot to show the pipx configuration page.
+</p>
+
+<a NAME="PipxWidget.__populatePackages" ID="PipxWidget.__populatePackages"></a>
+<h4>PipxWidget.__populatePackages</h4>
+<b>__populatePackages</b>(<i></i>)
+<p>
+        Private method to populate the packages list.
+</p>
+
+<a NAME="PipxWidget.__reinstallAllPackages" ID="PipxWidget.__reinstallAllPackages"></a>
+<h4>PipxWidget.__reinstallAllPackages</h4>
+<b>__reinstallAllPackages</b>(<i></i>)
+<p>
+        Private slot to force a re-installation of all packages.
+</p>
+
+<a NAME="PipxWidget.__reinstallPackage" ID="PipxWidget.__reinstallPackage"></a>
+<h4>PipxWidget.__reinstallPackage</h4>
+<b>__reinstallPackage</b>(<i></i>)
+<p>
+        Private slot to force a re-installation of the selected package.
+</p>
+
+<a NAME="PipxWidget.__resizePackagesColumns" ID="PipxWidget.__resizePackagesColumns"></a>
+<h4>PipxWidget.__resizePackagesColumns</h4>
+<b>__resizePackagesColumns</b>(<i></i>)
+<p>
+        Private method to resize the columns of the packages list.
+</p>
+
+<a NAME="PipxWidget.__selectedPackages" ID="PipxWidget.__selectedPackages"></a>
+<h4>PipxWidget.__selectedPackages</h4>
+<b>__selectedPackages</b>(<i></i>)
+<p>
+        Private method to determine the list of selected packages.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of selected packages
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of QTreeWidgetItem
+</dd>
+</dl>
+<a NAME="PipxWidget.__showInterpreters" ID="PipxWidget.__showInterpreters"></a>
+<h4>PipxWidget.__showInterpreters</h4>
+<b>__showInterpreters</b>(<i></i>)
+<p>
+        Private slot to show a list of standalone Python interpreters.
+</p>
+
+<a NAME="PipxWidget.__showPipxVersion" ID="PipxWidget.__showPipxVersion"></a>
+<h4>PipxWidget.__showPipxVersion</h4>
+<b>__showPipxVersion</b>(<i></i>)
+<p>
+        Private method to show the pipx version in the widget header.
+</p>
+
+<a NAME="PipxWidget.__uninstallAllPackages" ID="PipxWidget.__uninstallAllPackages"></a>
+<h4>PipxWidget.__uninstallAllPackages</h4>
+<b>__uninstallAllPackages</b>(<i></i>)
+<p>
+        Private slot to uninstall all packages.
+</p>
+
+<a NAME="PipxWidget.__uninstallPackage" ID="PipxWidget.__uninstallPackage"></a>
+<h4>PipxWidget.__uninstallPackage</h4>
+<b>__uninstallPackage</b>(<i></i>)
+<p>
+        Private slot to uninstall the selected package.
+</p>
+
+<a NAME="PipxWidget.__upgradeAllPackages" ID="PipxWidget.__upgradeAllPackages"></a>
+<h4>PipxWidget.__upgradeAllPackages</h4>
+<b>__upgradeAllPackages</b>(<i></i>)
+<p>
+        Private slot to upgrade all packages.
+</p>
+
+<a NAME="PipxWidget.__upgradePackage" ID="PipxWidget.__upgradePackage"></a>
+<h4>PipxWidget.__upgradePackage</h4>
+<b>__upgradePackage</b>(<i></i>)
+<p>
+        Private slot to upgrade the selected package.
+</p>
+
+<a NAME="PipxWidget.__upgradeSharedLibs" ID="PipxWidget.__upgradeSharedLibs"></a>
+<h4>PipxWidget.__upgradeSharedLibs</h4>
+<b>__upgradeSharedLibs</b>(<i></i>)
+<p>
+        Private slot to upgrade the shared libraries.
+</p>
+
+<a NAME="PipxWidget.on_packagesList_itemActivated" ID="PipxWidget.on_packagesList_itemActivated"></a>
+<h4>PipxWidget.on_packagesList_itemActivated</h4>
+<b>on_packagesList_itemActivated</b>(<i>item, column</i>)
+<p>
+        Private slot to start the activated item, if it is not a top level one.
+</p>
+
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the activated item
+</dd>
+<dt><i>column</i> (int)</dt>
+<dd>
+column number of the activation
+</dd>
+</dl>
+<a NAME="PipxWidget.on_packagesList_itemSelectionChanged" ID="PipxWidget.on_packagesList_itemSelectionChanged"></a>
+<h4>PipxWidget.on_packagesList_itemSelectionChanged</h4>
+<b>on_packagesList_itemSelectionChanged</b>(<i></i>)
+<p>
+        Private slot to handle a change of selected packages and apps.
+</p>
+
+<a NAME="PipxWidget.on_refreshButton_clicked" ID="PipxWidget.on_refreshButton_clicked"></a>
+<h4>PipxWidget.on_refreshButton_clicked</h4>
+<b>on_refreshButton_clicked</b>(<i></i>)
+<p>
+        Private slot to refresh the packages list.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PluginPipxInterface.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,324 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PluginPipxInterface</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>Plugin_Pipx_Interface.PluginPipxInterface</h1>
+<p>
+Module implementing the pipx Interface plug-in.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>_Side</td></tr>
+<tr><td>__header__</td></tr>
+<tr><td>error</td></tr>
+<tr><td>pipxInterfacePluginObject</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PluginPipxInterface">PluginPipxInterface</a></td>
+<td>Class documentation goes here.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#createPipxPage">createPipxPage</a></td>
+<td>Module function to create the autocompletion configuration page.</td>
+</tr>
+<tr>
+<td><a href="#exeDisplayData">exeDisplayData</a></td>
+<td>Module function to support the display of some executable info.</td>
+</tr>
+<tr>
+<td><a href="#getConfigData">getConfigData</a></td>
+<td>Module function returning data as required by the configuration dialog.</td>
+</tr>
+<tr>
+<td><a href="#installDependencies">installDependencies</a></td>
+<td>Function to install dependencies of this plug-in.</td>
+</tr>
+<tr>
+<td><a href="#prepareUninstall">prepareUninstall</a></td>
+<td>Module function to prepare for an un-installation.</td>
+</tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="PluginPipxInterface" ID="PluginPipxInterface"></a>
+<h2>PluginPipxInterface</h2>
+<p>
+    Class documentation goes here.
+</p>
+
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>PreferencesKey</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PluginPipxInterface.__init__">PluginPipxInterface</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PluginPipxInterface.__activateWidget">__activateWidget</a></td>
+<td>Private slot to handle the activation of the MQTT Monitor.</td>
+</tr>
+<tr>
+<td><a href="#PluginPipxInterface.__initialize">__initialize</a></td>
+<td>Private slot to (re)initialize the plugin.</td>
+</tr>
+<tr>
+<td><a href="#PluginPipxInterface.__loadTranslator">__loadTranslator</a></td>
+<td>Private method to load the translation file.</td>
+</tr>
+<tr>
+<td><a href="#PluginPipxInterface.activate">activate</a></td>
+<td>Public method to activate this plug-in.</td>
+</tr>
+<tr>
+<td><a href="#PluginPipxInterface.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plug-in.</td>
+</tr>
+<tr>
+<td><a href="#PluginPipxInterface.getPreferences">getPreferences</a></td>
+<td>Public method to retrieve the various settings values.</td>
+</tr>
+<tr>
+<td><a href="#PluginPipxInterface.setPreferences">setPreferences</a></td>
+<td>Public method to store the various settings values.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="PluginPipxInterface.__init__" ID="PluginPipxInterface.__init__"></a>
+<h4>PluginPipxInterface (Constructor)</h4>
+<b>PluginPipxInterface</b>(<i>ui</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>ui</i> (UI.UserInterface)</dt>
+<dd>
+reference to the user interface object
+</dd>
+</dl>
+<a NAME="PluginPipxInterface.__activateWidget" ID="PluginPipxInterface.__activateWidget"></a>
+<h4>PluginPipxInterface.__activateWidget</h4>
+<b>__activateWidget</b>(<i></i>)
+<p>
+        Private slot to handle the activation of the MQTT Monitor.
+</p>
+
+<a NAME="PluginPipxInterface.__initialize" ID="PluginPipxInterface.__initialize"></a>
+<h4>PluginPipxInterface.__initialize</h4>
+<b>__initialize</b>(<i></i>)
+<p>
+        Private slot to (re)initialize the plugin.
+</p>
+
+<a NAME="PluginPipxInterface.__loadTranslator" ID="PluginPipxInterface.__loadTranslator"></a>
+<h4>PluginPipxInterface.__loadTranslator</h4>
+<b>__loadTranslator</b>(<i></i>)
+<p>
+        Private method to load the translation file.
+</p>
+
+<a NAME="PluginPipxInterface.activate" ID="PluginPipxInterface.activate"></a>
+<h4>PluginPipxInterface.activate</h4>
+<b>activate</b>(<i></i>)
+<p>
+        Public method to activate this plug-in.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple of None and activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="PluginPipxInterface.deactivate" ID="PluginPipxInterface.deactivate"></a>
+<h4>PluginPipxInterface.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+<p>
+        Public method to deactivate this plug-in.
+</p>
+
+<a NAME="PluginPipxInterface.getPreferences" ID="PluginPipxInterface.getPreferences"></a>
+<h4>PluginPipxInterface.getPreferences</h4>
+<b>getPreferences</b>(<i>key</i>)
+<p>
+        Public method to retrieve the various settings values.
+</p>
+
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the value to get
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the requested setting value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
+<a NAME="PluginPipxInterface.setPreferences" ID="PluginPipxInterface.setPreferences"></a>
+<h4>PluginPipxInterface.setPreferences</h4>
+<b>setPreferences</b>(<i>key, value</i>)
+<p>
+        Public method to store the various settings values.
+</p>
+
+<dl>
+
+<dt><i>key</i> (str)</dt>
+<dd>
+the key of the setting to be set
+</dd>
+<dt><i>value</i> (Any)</dt>
+<dd>
+the value to be set
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="createPipxPage" ID="createPipxPage"></a>
+<h2>createPipxPage</h2>
+<b>createPipxPage</b>(<i>_configDlg, </i>)
+<p>
+    Module function to create the autocompletion configuration page.
+</p>
+
+<dl>
+
+<dt><i>_configDlg</i> (ConfigurationWidget)</dt>
+<dd>
+reference to the configuration dialog (unused)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the configuration page
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+AutoCompletionRopePage
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="exeDisplayData" ID="exeDisplayData"></a>
+<h2>exeDisplayData</h2>
+<b>exeDisplayData</b>(<i></i>)
+<p>
+    Module function to support the display of some executable info.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the data to query the presence of
+        the executable
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getConfigData" ID="getConfigData"></a>
+<h2>getConfigData</h2>
+<b>getConfigData</b>(<i></i>)
+<p>
+    Module function returning data as required by the configuration dialog.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the relevant data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="installDependencies" ID="installDependencies"></a>
+<h2>installDependencies</h2>
+<b>installDependencies</b>(<i>pipInstall</i>)
+<p>
+    Function to install dependencies of this plug-in.
+</p>
+
+<dl>
+
+<dt><i>pipInstall</i> (function)</dt>
+<dd>
+function to be called with a list of package names.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="prepareUninstall" ID="prepareUninstall"></a>
+<h2>prepareUninstall</h2>
+<b>prepareUninstall</b>(<i></i>)
+<p>
+    Module function to prepare for an un-installation.
+</p>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/index-Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface.ConfigurationPage</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<h1>Plugin_Pipx_Interface.PipxInterface.ConfigurationPage</h1>
+<p>
+Package containing the 'pipx' configuration page.
+</p>
+
+
+
+<h3>Modules</h3>
+<table>
+
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.PipxPage.html">PipxPage</a></td>
+<td>Module implementing the pipx configuration page.</td>
+</tr>
+</table>
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/index-Plugin_Pipx_Interface.PipxInterface.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface.PipxInterface</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<h1>Plugin_Pipx_Interface.PipxInterface</h1>
+<p>
+Package implementing widgets and dialogues to interface with the pipx command.
+</p>
+
+
+<h3>Packages</h3>
+<table>
+
+<tr>
+<td><a href="index-Plugin_Pipx_Interface.PipxInterface.ConfigurationPage.html">ConfigurationPage</a></td>
+<td>Package containing the 'pipx' configuration page.</td>
+</tr>
+</table>
+
+<h3>Modules</h3>
+<table>
+
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.Pipx.html">Pipx</a></td>
+<td>Module implementing the pipx GUI logic.</td>
+</tr>
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.PipxAppStartDialog.html">PipxAppStartDialog</a></td>
+<td>Module implementing a dialog to enter the application command line parameters and to execute the app.</td>
+</tr>
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.PipxExecDialog.html">PipxExecDialog</a></td>
+<td>Module implementing a dialog showing the output of a pip command.</td>
+</tr>
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.PipxInterpretersDialog.html">PipxInterpretersDialog</a></td>
+<td>Module implementing a dialog to show the available standalone Python interpreters.</td>
+</tr>
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.PipxPackagesInputDialog.html">PipxPackagesInputDialog</a></td>
+<td>Module implementing a dialog to enter package specifications.</td>
+</tr>
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.PipxReinstallDialog.html">PipxReinstallDialog</a></td>
+<td>Module implementing a dialog to enter the desired Python interpreter version.</td>
+</tr>
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.PipxSpecInputDialog.html">PipxSpecInputDialog</a></td>
+<td>Module implementing a dialog to enter the data for an 'install-all' operation.</td>
+</tr>
+<tr>
+<td><a href="Plugin_Pipx_Interface.PipxInterface.PipxWidget.html">PipxWidget</a></td>
+<td>Module implementing the pipx management widget.</td>
+</tr>
+</table>
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/index-Plugin_Pipx_Interface.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Pipx_Interface</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<h1>Plugin_Pipx_Interface</h1>
+<p>
+Package implementing the pipx interface plug-in.
+</p>
+
+
+<h3>Packages</h3>
+<table>
+
+<tr>
+<td><a href="index-Plugin_Pipx_Interface.PipxInterface.html">PipxInterface</a></td>
+<td>Package implementing widgets and dialogues to interface with the pipx command.</td>
+</tr>
+</table>
+
+<h3>Modules</h3>
+<table>
+
+<tr>
+<td><a href="Plugin_Pipx_Interface.PluginPipxInterface.html">PluginPipxInterface</a></td>
+<td>Module implementing the pipx Interface plug-in.</td>
+</tr>
+</table>
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/index.html	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html><head>
+<title>Table of contents</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<h1>Table of contents</h1>
+
+
+<h3>Packages</h3>
+<table>
+
+<tr>
+<td><a href="index-Plugin_Pipx_Interface.html">Plugin_Pipx_Interface</a></td>
+<td>Package implementing the pipx interface plug-in.</td>
+</tr>
+</table>
+
+</body></html>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PipxInterface/Documentation/Source/styles.css	Fri Jun 28 17:24:18 2024 +0200
@@ -0,0 +1,12 @@
+body {
+    color: black;
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
--- a/PluginPipxInterface.epj	Fri Jun 28 17:20:46 2024 +0200
+++ b/PluginPipxInterface.epj	Fri Jun 28 17:24:18 2024 +0200
@@ -152,7 +152,24 @@
     },
     "DESCRIPTION": "This plugin implements widgets and dialogs to interact with the 'pipx' application management command.",
     "DOCSTRING": "ericdoc",
-    "DOCUMENTATIONPARMS": {},
+    "DOCUMENTATIONPARMS": {
+      "ERIC4DOC": {
+        "cssFile": "%PYTHON%/eric7/CSSs/default.css",
+        "ignoreDirectories": [
+          ".eric7project",
+          ".hg",
+          ".jedi",
+          ".ropeproject"
+        ],
+        "ignoreFilePatterns": [
+          "Ui_*.py"
+        ],
+        "outputDirectory": "PipxInterface/Documentation/Source",
+        "qtHelpEnabled": false,
+        "startDirectory": "",
+        "useRecursion": true
+      }
+    },
     "EMAIL": "detlev@die-offenbachs.de",
     "EMBEDDED_VENV": false,
     "EOL": 1,
@@ -213,6 +230,7 @@
     "MIXEDLANGUAGE": false,
     "OTHERS": [
       ".hgignore",
+      "PipxInterface/Documentation/Source",
       "PipxInterface/icons/pipx22.svg",
       "PipxInterface/icons/pipx48.svg",
       "PipxInterface/icons/pipx96.svg",

Mercurial Repository: pipx Interface

eric ide

mercurial