527 list of tuple of (str, str) |
527 list of tuple of (str, str) |
528 </dd> |
528 </dd> |
529 </dl> |
529 </dl> |
530 <a NAME="Pip.getLicenses" ID="Pip.getLicenses"></a> |
530 <a NAME="Pip.getLicenses" ID="Pip.getLicenses"></a> |
531 <h4>Pip.getLicenses</h4> |
531 <h4>Pip.getLicenses</h4> |
532 <b>getLicenses</b>(<i>envName, localPackages=True, usersite=False, summary=False</i>) |
532 <b>getLicenses</b>(<i>envName, summary=False</i>) |
533 |
533 |
534 <p> |
534 <p> |
535 Public method to get the licenses per package for a given environment. |
535 Public method to get the licenses per package for a given environment. |
536 </p> |
536 </p> |
537 <dl> |
537 <dl> |
538 |
538 |
539 <dt><i>envName</i> (str)</dt> |
539 <dt><i>envName</i> (str)</dt> |
540 <dd> |
540 <dd> |
541 name of the environment to get the licenses for |
541 name of the environment to get the licenses for |
542 </dd> |
|
543 <dt><i>localPackages</i> (bool)</dt> |
|
544 <dd> |
|
545 flag indicating to get the licenses for local |
|
546 packages only |
|
547 </dd> |
|
548 <dt><i>usersite</i> (bool)</dt> |
|
549 <dd> |
|
550 flag indicating to get the licenses for packages |
|
551 installed in user-site directory only |
|
552 </dd> |
542 </dd> |
553 <dt><i>summary</i> (bool (optional))</dt> |
543 <dt><i>summary</i> (bool (optional))</dt> |
554 <dd> |
544 <dd> |
555 flag indicating to get a summary listing (defaults to |
545 flag indicating to get a summary listing (defaults to |
556 False) |
546 False) |
569 dict |
559 dict |
570 </dd> |
560 </dd> |
571 </dl> |
561 </dl> |
572 <a NAME="Pip.getLicensesSummary" ID="Pip.getLicensesSummary"></a> |
562 <a NAME="Pip.getLicensesSummary" ID="Pip.getLicensesSummary"></a> |
573 <h4>Pip.getLicensesSummary</h4> |
563 <h4>Pip.getLicensesSummary</h4> |
574 <b>getLicensesSummary</b>(<i>envName, localPackages=True, usersite=False</i>) |
564 <b>getLicensesSummary</b>(<i>envName</i>) |
575 |
565 |
576 <p> |
566 <p> |
577 Public method to get a summary of licenses found in a given |
567 Public method to get a summary of licenses found in a given |
578 environment. |
568 environment. |
579 </p> |
569 </p> |
580 <dl> |
570 <dl> |
581 |
571 |
582 <dt><i>envName</i> (str)</dt> |
572 <dt><i>envName</i> (str)</dt> |
583 <dd> |
573 <dd> |
584 name of the environment to get the licenses summary for |
574 name of the environment to get the licenses summary for |
585 </dd> |
|
586 <dt><i>localPackages</i> (bool)</dt> |
|
587 <dd> |
|
588 flag indicating to get the licenses summary for |
|
589 local packages only |
|
590 </dd> |
|
591 <dt><i>usersite</i> (bool)</dt> |
|
592 <dd> |
|
593 flag indicating to get the licenses summary for |
|
594 packages installed in user-site directory only |
|
595 </dd> |
575 </dd> |
596 </dl> |
576 </dl> |
597 <dl> |
577 <dl> |
598 <dt>Return:</dt> |
578 <dt>Return:</dt> |
599 <dd> |
579 <dd> |