eric7/Documentation/Source/eric7.PipInterface.Pip.html

branch
eric7
changeset 9007
01b73d9ef09e
parent 8997
d8946c2a22b5
child 9123
aefb731a4b4e
diff -r b9e04026f9d5 -r 01b73d9ef09e eric7/Documentation/Source/eric7.PipInterface.Pip.html
--- a/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Mon Mar 28 18:18:49 2022 +0200
+++ b/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Mon Mar 28 18:21:42 2022 +0200
@@ -107,6 +107,14 @@
 <td>Public method to get the list of installed packages.</td>
 </tr>
 <tr>
+<td><a href="#Pip.getLicenses">getLicenses</a></td>
+<td>Public method to get the licenses per package for a given environment.</td>
+</tr>
+<tr>
+<td><a href="#Pip.getLicensesSummary">getLicensesSummary</a></td>
+<td>Public method to get a summary of licenses found in a given environment.</td>
+</tr>
+<tr>
 <td><a href="#Pip.getNetworkAccessManager">getNetworkAccessManager</a></td>
 <td>Public method to get a reference to the network access manager object.</td>
 </tr>
@@ -511,6 +519,86 @@
 list of tuple of (str, str)
 </dd>
 </dl>
+<a NAME="Pip.getLicenses" ID="Pip.getLicenses"></a>
+<h4>Pip.getLicenses</h4>
+<b>getLicenses</b>(<i>envName, localPackages=True, usersite=False, summary=False</i>)
+
+<p>
+        Public method to get the licenses per package for a given environment.
+</p>
+<dl>
+
+<dt><i>envName</i> (str)</dt>
+<dd>
+name of the environment to get the licenses for
+</dd>
+<dt><i>localPackages</i> (bool)</dt>
+<dd>
+flag indicating to get the licenses for local
+            packages only
+</dd>
+<dt><i>usersite</i> (bool)</dt>
+<dd>
+flag indicating to get the licenses for packages
+            installed in user-site directory only
+</dd>
+<dt><i>summary</i> (bool (optional))</dt>
+<dd>
+flag indicating to get a summary listing (defaults to
+            False)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of dictionaries containing the license and version per
+            package
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<a NAME="Pip.getLicensesSummary" ID="Pip.getLicensesSummary"></a>
+<h4>Pip.getLicensesSummary</h4>
+<b>getLicensesSummary</b>(<i>envName, localPackages=True, usersite=False</i>)
+
+<p>
+        Public method to get a summary of licenses found in a given
+        environment.
+</p>
+<dl>
+
+<dt><i>envName</i> (str)</dt>
+<dd>
+name of the environment to get the licenses summary for
+</dd>
+<dt><i>localPackages</i> (bool)</dt>
+<dd>
+flag indicating to get the licenses summary for
+            local packages only
+</dd>
+<dt><i>usersite</i> (bool)</dt>
+<dd>
+flag indicating to get the licenses summary for
+            packages installed in user-site directory only
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of dictionaries containing the license and the count of
+            packages
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="Pip.getNetworkAccessManager" ID="Pip.getNetworkAccessManager"></a>
 <h4>Pip.getNetworkAccessManager</h4>
 <b>getNetworkAccessManager</b>(<i></i>)

eric ide

mercurial