--- a/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.Pipx.html Mon Jul 29 11:58:31 2024 +0200 +++ b/PipxInterface/Documentation/Source/Plugin_Pipx_Interface.PipxInterface.Pipx.html Tue Jul 30 17:45:46 2024 +0200 @@ -56,6 +56,10 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#Pipx.__getPackageDependencies">__getPackageDependencies</a></td> +<td>Private method to get a list of dependencies of a given package.</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> @@ -76,10 +80,18 @@ <td>Public method to ensure that the directory where pipx stores apps is in your PATH environment variable.</td> </tr> <tr> +<td><a href="#Pipx.getAllPackageDependencies">getAllPackageDependencies</a></td> +<td>Public method to get the list of package dependencies.</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.getOutdatedPackageDependencies">getOutdatedPackageDependencies</a></td> +<td>Public method to get the list of outdated package dependencies.</td> +</tr> +<tr> <td><a href="#Pipx.getPipxInterpretersList">getPipxInterpretersList</a></td> <td>Public method returning a list all standalone interpreters.</td> </tr> @@ -100,6 +112,10 @@ <td>Public method to get the version tuple of the installed pipx package.</td> </tr> <tr> +<td><a href="#Pipx.getUptodatePackageDependencies">getUptodatePackageDependencies</a></td> +<td>Public method to get the list of up-to-date package dependencies.</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> @@ -144,6 +160,10 @@ <td>Public method to upgrade the given package.</td> </tr> <tr> +<td><a href="#Pipx.upgradePackageDependencies">upgradePackageDependencies</a></td> +<td>Public method to upgrade the dependencies of the given package.</td> +</tr> +<tr> <td><a href="#Pipx.upgradeSharedLibraries">upgradeSharedLibraries</a></td> <td>Public method to upgrade shared libraries.</td> </tr> @@ -169,6 +189,40 @@ reference to the user interface object </dd> </dl> +<a NAME="Pipx.__getPackageDependencies" ID="Pipx.__getPackageDependencies"></a> +<h4>Pipx.__getPackageDependencies</h4> +<b>__getPackageDependencies</b>(<i>package, uptodate=False, outdated=False</i>) +<p> + Private method to get a list of dependencies of a given package. +</p> + +<dl> + +<dt><i>package</i> (str)</dt> +<dd> +name of the package +</dd> +<dt><i>uptodate</i> (TYPE (optional))</dt> +<dd> +DESCRIPTION (defaults to False) +</dd> +<dt><i>outdated</i> (TYPE (optional))</dt> +<dd> +DESCRIPTION (defaults to False) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of dictionaries as returned by 'pip' +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list[dict[str: str]] +</dd> +</dl> <a NAME="Pipx.__getPipxExecutable" ID="Pipx.__getPipxExecutable"></a> <h4>Pipx.__getPipxExecutable</h4> <b>__getPipxExecutable</b>(<i></i>) @@ -277,6 +331,32 @@ in your PATH environment variable. </p> +<a NAME="Pipx.getAllPackageDependencies" ID="Pipx.getAllPackageDependencies"></a> +<h4>Pipx.getAllPackageDependencies</h4> +<b>getAllPackageDependencies</b>(<i>package</i>) +<p> + Public method to get the list of package dependencies. +</p> + +<dl> + +<dt><i>package</i> (str)</dt> +<dd> +name of the package +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of tuples containing the dependency name and version +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of tuple of (str, str) +</dd> +</dl> <a NAME="Pipx.getInstalledPackages" ID="Pipx.getInstalledPackages"></a> <h4>Pipx.getInstalledPackages</h4> <b>getInstalledPackages</b>(<i></i>) @@ -296,6 +376,33 @@ list of dict[str, str | list] </dd> </dl> +<a NAME="Pipx.getOutdatedPackageDependencies" ID="Pipx.getOutdatedPackageDependencies"></a> +<h4>Pipx.getOutdatedPackageDependencies</h4> +<b>getOutdatedPackageDependencies</b>(<i>package</i>) +<p> + Public method to get the list of outdated package dependencies. +</p> + +<dl> + +<dt><i>package</i> (str)</dt> +<dd> +name of the package +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of tuples containing the dependency name, version and latest + version +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of tuple of (str, str, str) +</dd> +</dl> <a NAME="Pipx.getPipxInterpretersList" ID="Pipx.getPipxInterpretersList"></a> <h4>Pipx.getPipxInterpretersList</h4> <b>getPipxInterpretersList</b>(<i></i>) @@ -393,6 +500,32 @@ tuple of (int, int, int) </dd> </dl> +<a NAME="Pipx.getUptodatePackageDependencies" ID="Pipx.getUptodatePackageDependencies"></a> +<h4>Pipx.getUptodatePackageDependencies</h4> +<b>getUptodatePackageDependencies</b>(<i>package</i>) +<p> + Public method to get the list of up-to-date package dependencies. +</p> + +<dl> + +<dt><i>package</i> (str)</dt> +<dd> +name of the package +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of tuples containing the dependency name and version +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of tuple of (str, str) +</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>) @@ -609,6 +742,20 @@ name of the package </dd> </dl> +<a NAME="Pipx.upgradePackageDependencies" ID="Pipx.upgradePackageDependencies"></a> +<h4>Pipx.upgradePackageDependencies</h4> +<b>upgradePackageDependencies</b>(<i>package</i>) +<p> + Public method to upgrade the dependencies of 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>)