105 <tr> |
105 <tr> |
106 <td><a href="#Pip.getInstalledPackages">getInstalledPackages</a></td> |
106 <td><a href="#Pip.getInstalledPackages">getInstalledPackages</a></td> |
107 <td>Public method to get the list of installed packages.</td> |
107 <td>Public method to get the list of installed packages.</td> |
108 </tr> |
108 </tr> |
109 <tr> |
109 <tr> |
|
110 <td><a href="#Pip.getLicenses">getLicenses</a></td> |
|
111 <td>Public method to get the licenses per package for a given environment.</td> |
|
112 </tr> |
|
113 <tr> |
|
114 <td><a href="#Pip.getLicensesSummary">getLicensesSummary</a></td> |
|
115 <td>Public method to get a summary of licenses found in a given environment.</td> |
|
116 </tr> |
|
117 <tr> |
110 <td><a href="#Pip.getNetworkAccessManager">getNetworkAccessManager</a></td> |
118 <td><a href="#Pip.getNetworkAccessManager">getNetworkAccessManager</a></td> |
111 <td>Public method to get a reference to the network access manager object.</td> |
119 <td>Public method to get a reference to the network access manager object.</td> |
112 </tr> |
120 </tr> |
113 <tr> |
121 <tr> |
114 <td><a href="#Pip.getOutdatedPackages">getOutdatedPackages</a></td> |
122 <td><a href="#Pip.getOutdatedPackages">getOutdatedPackages</a></td> |
509 <dt>Return Type:</dt> |
517 <dt>Return Type:</dt> |
510 <dd> |
518 <dd> |
511 list of tuple of (str, str) |
519 list of tuple of (str, str) |
512 </dd> |
520 </dd> |
513 </dl> |
521 </dl> |
|
522 <a NAME="Pip.getLicenses" ID="Pip.getLicenses"></a> |
|
523 <h4>Pip.getLicenses</h4> |
|
524 <b>getLicenses</b>(<i>envName, localPackages=True, usersite=False, summary=False</i>) |
|
525 |
|
526 <p> |
|
527 Public method to get the licenses per package for a given environment. |
|
528 </p> |
|
529 <dl> |
|
530 |
|
531 <dt><i>envName</i> (str)</dt> |
|
532 <dd> |
|
533 name of the environment to get the licenses for |
|
534 </dd> |
|
535 <dt><i>localPackages</i> (bool)</dt> |
|
536 <dd> |
|
537 flag indicating to get the licenses for local |
|
538 packages only |
|
539 </dd> |
|
540 <dt><i>usersite</i> (bool)</dt> |
|
541 <dd> |
|
542 flag indicating to get the licenses for packages |
|
543 installed in user-site directory only |
|
544 </dd> |
|
545 <dt><i>summary</i> (bool (optional))</dt> |
|
546 <dd> |
|
547 flag indicating to get a summary listing (defaults to |
|
548 False) |
|
549 </dd> |
|
550 </dl> |
|
551 <dl> |
|
552 <dt>Return:</dt> |
|
553 <dd> |
|
554 list of dictionaries containing the license and version per |
|
555 package |
|
556 </dd> |
|
557 </dl> |
|
558 <dl> |
|
559 <dt>Return Type:</dt> |
|
560 <dd> |
|
561 dict |
|
562 </dd> |
|
563 </dl> |
|
564 <a NAME="Pip.getLicensesSummary" ID="Pip.getLicensesSummary"></a> |
|
565 <h4>Pip.getLicensesSummary</h4> |
|
566 <b>getLicensesSummary</b>(<i>envName, localPackages=True, usersite=False</i>) |
|
567 |
|
568 <p> |
|
569 Public method to get a summary of licenses found in a given |
|
570 environment. |
|
571 </p> |
|
572 <dl> |
|
573 |
|
574 <dt><i>envName</i> (str)</dt> |
|
575 <dd> |
|
576 name of the environment to get the licenses summary for |
|
577 </dd> |
|
578 <dt><i>localPackages</i> (bool)</dt> |
|
579 <dd> |
|
580 flag indicating to get the licenses summary for |
|
581 local packages only |
|
582 </dd> |
|
583 <dt><i>usersite</i> (bool)</dt> |
|
584 <dd> |
|
585 flag indicating to get the licenses summary for |
|
586 packages installed in user-site directory only |
|
587 </dd> |
|
588 </dl> |
|
589 <dl> |
|
590 <dt>Return:</dt> |
|
591 <dd> |
|
592 list of dictionaries containing the license and the count of |
|
593 packages |
|
594 </dd> |
|
595 </dl> |
|
596 <dl> |
|
597 <dt>Return Type:</dt> |
|
598 <dd> |
|
599 dict |
|
600 </dd> |
|
601 </dl> |
514 <a NAME="Pip.getNetworkAccessManager" ID="Pip.getNetworkAccessManager"></a> |
602 <a NAME="Pip.getNetworkAccessManager" ID="Pip.getNetworkAccessManager"></a> |
515 <h4>Pip.getNetworkAccessManager</h4> |
603 <h4>Pip.getNetworkAccessManager</h4> |
516 <b>getNetworkAccessManager</b>(<i></i>) |
604 <b>getNetworkAccessManager</b>(<i></i>) |
517 |
605 |
518 <p> |
606 <p> |