src/eric7/Documentation/Source/eric7.PipInterface.piplicenses.html

branch
eric7
changeset 10035
3a423b723a99
parent 9851
ec12090e9cd9
child 10229
e50bbf250343
equal deleted inserted replaced
10034:bf2d02317ba6 10035:3a423b723a99
39 SOFTWARE. 39 SOFTWARE.
40 </p> 40 </p>
41 <h3>Global Attributes</h3> 41 <h3>Global Attributes</h3>
42 42
43 <table> 43 <table>
44 <tr><td>DEFAULT_OUTPUT_FIELDS</td></tr><tr><td>FIELDS_TO_METADATA_KEYS</td></tr><tr><td>FIELD_NAMES</td></tr><tr><td>LICENSE_UNKNOWN</td></tr><tr><td>MAP_DEST_TO_ENUM</td></tr><tr><td>METADATA_KEYS</td></tr><tr><td>SUMMARY_FIELD_NAMES</td></tr><tr><td>SUMMARY_OUTPUT_FIELDS</td></tr><tr><td>SYSTEM_PACKAGES</td></tr><tr><td>__author__</td></tr><tr><td>__license__</td></tr><tr><td>__pkgname__</td></tr><tr><td>__summary__</td></tr><tr><td>__url__</td></tr><tr><td>__version__</td></tr> 44 <tr><td>DEFAULT_OUTPUT_FIELDS</td></tr><tr><td>FIELDS_TO_METADATA_KEYS</td></tr><tr><td>FIELD_NAMES</td></tr><tr><td>LICENSE_UNKNOWN</td></tr><tr><td>MAP_DEST_TO_ENUM</td></tr><tr><td>PATTERN_DELIMITER</td></tr><tr><td>SUMMARY_FIELD_NAMES</td></tr><tr><td>SUMMARY_OUTPUT_FIELDS</td></tr><tr><td>SYSTEM_PACKAGES</td></tr><tr><td>__author__</td></tr><tr><td>__license__</td></tr><tr><td>__pkgname__</td></tr><tr><td>__summary__</td></tr><tr><td>__url__</td></tr><tr><td>__version__</td></tr>
45 </table> 45 </table>
46 <h3>Classes</h3> 46 <h3>Classes</h3>
47 47
48 <table> 48 <table>
49 49
111 <tr> 111 <tr>
112 <td><a href="#enum_key_to_value">enum_key_to_value</a></td> 112 <td><a href="#enum_key_to_value">enum_key_to_value</a></td>
113 <td></td> 113 <td></td>
114 </tr> 114 </tr>
115 <tr> 115 <tr>
116 <td><a href="#extract_homepage">extract_homepage</a></td>
117 <td>Extracts the homepage attribute from the package metadata.</td>
118 </tr>
119 <tr>
116 <td><a href="#filter_string">filter_string</a></td> 120 <td><a href="#filter_string">filter_string</a></td>
117 <td></td> 121 <td></td>
118 </tr> 122 </tr>
119 <tr> 123 <tr>
120 <td><a href="#find_license_from_classifier">find_license_from_classifier</a></td> 124 <td><a href="#find_license_from_classifier">find_license_from_classifier</a></td>
135 <tr> 139 <tr>
136 <td><a href="#get_pkg_info">get_pkg_info</a></td> 140 <td><a href="#get_pkg_info">get_pkg_info</a></td>
137 <td></td> 141 <td></td>
138 </tr> 142 </tr>
139 <tr> 143 <tr>
144 <td><a href="#get_python_sys_path">get_python_sys_path</a></td>
145 <td></td>
146 </tr>
147 <tr>
140 <td><a href="#main">main</a></td> 148 <td><a href="#main">main</a></td>
141 <td></td> 149 <td></td>
150 </tr>
151 <tr>
152 <td><a href="#normalize_pkg_name">normalize_pkg_name</a></td>
153 <td>Return normalized name according to PEP specification</td>
142 </tr> 154 </tr>
143 <tr> 155 <tr>
144 <td><a href="#select_license_by_source">select_license_by_source</a></td> 156 <td><a href="#select_license_by_source">select_license_by_source</a></td>
145 <td></td> 157 <td></td>
146 </tr> 158 </tr>
358 <h3>Derived from</h3> 370 <h3>Derived from</h3>
359 NoValueEnum 371 NoValueEnum
360 <h3>Class Attributes</h3> 372 <h3>Class Attributes</h3>
361 373
362 <table> 374 <table>
363 <tr><td>AUTHOR</td></tr><tr><td>COUNT</td></tr><tr><td>LICENSE</td></tr><tr><td>NAME</td></tr><tr><td>URL</td></tr> 375 <tr><td>AUTHOR</td></tr><tr><td>COUNT</td></tr><tr><td>LICENSE</td></tr><tr><td>MAINTAINER</td></tr><tr><td>NAME</td></tr><tr><td>URL</td></tr>
364 </table> 376 </table>
365 <h3>Class Methods</h3> 377 <h3>Class Methods</h3>
366 378
367 <table> 379 <table>
368 <tr><td>None</td></tr> 380 <tr><td>None</td></tr>
478 <b>enum_key_to_value</b>(<i>enum_key: Enum</i>) 490 <b>enum_key_to_value</b>(<i>enum_key: Enum</i>)
479 491
480 <div align="right"><a href="#top">Up</a></div> 492 <div align="right"><a href="#top">Up</a></div>
481 <hr /> 493 <hr />
482 <hr /> 494 <hr />
495 <a NAME="extract_homepage" ID="extract_homepage"></a>
496 <h2>extract_homepage</h2>
497 <b>extract_homepage</b>(<i>metadata: Message</i>)
498
499 <p>
500 Extracts the homepage attribute from the package metadata.
501 </p>
502 <p>
503 Not all python packages have defined a home-page attribute.
504 As a fallback, the `Project-URL` metadata can be used.
505 The python core metadata supports multiple (free text) values for
506 the `Project-URL` field that are comma separated.
507 </p>
508 <p>
509 Args:
510 metadata: The package metadata to extract the homepage from.
511 </p>
512 <p>
513 Returns:
514 The home page if applicable, None otherwise.
515 </p>
516 <div align="right"><a href="#top">Up</a></div>
517 <hr />
518 <hr />
483 <a NAME="filter_string" ID="filter_string"></a> 519 <a NAME="filter_string" ID="filter_string"></a>
484 <h2>filter_string</h2> 520 <h2>filter_string</h2>
485 <b>filter_string</b>(<i>item: str</i>) 521 <b>filter_string</b>(<i>item: str</i>)
486 522
487 <div align="right"><a href="#top">Up</a></div> 523 <div align="right"><a href="#top">Up</a></div>
524 <b>get_pkg_info</b>(<i>pkg</i>) 560 <b>get_pkg_info</b>(<i>pkg</i>)
525 561
526 <div align="right"><a href="#top">Up</a></div> 562 <div align="right"><a href="#top">Up</a></div>
527 <hr /> 563 <hr />
528 <hr /> 564 <hr />
565 <a NAME="get_python_sys_path" ID="get_python_sys_path"></a>
566 <h2>get_python_sys_path</h2>
567 <b>get_python_sys_path</b>(<i>executable: str</i>)
568
569 <div align="right"><a href="#top">Up</a></div>
570 <hr />
571 <hr />
529 <a NAME="main" ID="main"></a> 572 <a NAME="main" ID="main"></a>
530 <h2>main</h2> 573 <h2>main</h2>
531 <b>main</b>(<i></i>) 574 <b>main</b>(<i></i>)
532 575
533 <div align="right"><a href="#top">Up</a></div> 576 <div align="right"><a href="#top">Up</a></div>
534 <hr /> 577 <hr />
535 <hr /> 578 <hr />
579 <a NAME="normalize_pkg_name" ID="normalize_pkg_name"></a>
580 <h2>normalize_pkg_name</h2>
581 <b>normalize_pkg_name</b>(<i>pkg_name: str</i>)
582
583 <p>
584 Return normalized name according to PEP specification
585 </p>
586 <p>
587 See here: https://peps.python.org/pep-0503/#normalized-names
588 </p>
589 <p>
590 Args:
591 pkg_name: Package name it is extracted from the package metadata
592 or specified in the CLI
593 </p>
594 <p>
595 Returns:
596 normalized packege name
597 </p>
598 <div align="right"><a href="#top">Up</a></div>
599 <hr />
600 <hr />
536 <a NAME="select_license_by_source" ID="select_license_by_source"></a> 601 <a NAME="select_license_by_source" ID="select_license_by_source"></a>
537 <h2>select_license_by_source</h2> 602 <h2>select_license_by_source</h2>
538 <b>select_license_by_source</b>(<i>from_source: FromArg, license_classifier: list[str], license_meta: str</i>) 603 <b>select_license_by_source</b>(<i>from_source: FromArg, license_classifier: list[str], license_meta: str</i>)
539 604
540 <div align="right"><a href="#top">Up</a></div> 605 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial