diff -r bf2d02317ba6 -r 3a423b723a99 src/eric7/Documentation/Source/eric7.PipInterface.piplicenses.html --- a/src/eric7/Documentation/Source/eric7.PipInterface.piplicenses.html Tue May 16 17:42:54 2023 +0200 +++ b/src/eric7/Documentation/Source/eric7.PipInterface.piplicenses.html Tue May 16 17:43:14 2023 +0200 @@ -41,7 +41,7 @@ <h3>Global Attributes</h3> <table> -<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> +<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> </table> <h3>Classes</h3> @@ -113,6 +113,10 @@ <td></td> </tr> <tr> +<td><a href="#extract_homepage">extract_homepage</a></td> +<td>Extracts the homepage attribute from the package metadata.</td> +</tr> +<tr> <td><a href="#filter_string">filter_string</a></td> <td></td> </tr> @@ -137,10 +141,18 @@ <td></td> </tr> <tr> +<td><a href="#get_python_sys_path">get_python_sys_path</a></td> +<td></td> +</tr> +<tr> <td><a href="#main">main</a></td> <td></td> </tr> <tr> +<td><a href="#normalize_pkg_name">normalize_pkg_name</a></td> +<td>Return normalized name according to PEP specification</td> +</tr> +<tr> <td><a href="#select_license_by_source">select_license_by_source</a></td> <td></td> </tr> @@ -360,7 +372,7 @@ <h3>Class Attributes</h3> <table> -<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> +<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> </table> <h3>Class Methods</h3> @@ -480,6 +492,30 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<a NAME="extract_homepage" ID="extract_homepage"></a> +<h2>extract_homepage</h2> +<b>extract_homepage</b>(<i>metadata: Message</i>) + +<p> +Extracts the homepage attribute from the package metadata. +</p> +<p> + Not all python packages have defined a home-page attribute. + As a fallback, the `Project-URL` metadata can be used. + The python core metadata supports multiple (free text) values for + the `Project-URL` field that are comma separated. +</p> +<p> + Args: + metadata: The package metadata to extract the homepage from. +</p> +<p> + Returns: + The home page if applicable, None otherwise. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="filter_string" ID="filter_string"></a> <h2>filter_string</h2> <b>filter_string</b>(<i>item: str</i>) @@ -526,6 +562,13 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<a NAME="get_python_sys_path" ID="get_python_sys_path"></a> +<h2>get_python_sys_path</h2> +<b>get_python_sys_path</b>(<i>executable: str</i>) + +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="main" ID="main"></a> <h2>main</h2> <b>main</b>(<i></i>) @@ -533,6 +576,28 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<a NAME="normalize_pkg_name" ID="normalize_pkg_name"></a> +<h2>normalize_pkg_name</h2> +<b>normalize_pkg_name</b>(<i>pkg_name: str</i>) + +<p> +Return normalized name according to PEP specification +</p> +<p> + See here: https://peps.python.org/pep-0503/#normalized-names +</p> +<p> + Args: + pkg_name: Package name it is extracted from the package metadata + or specified in the CLI +</p> +<p> + Returns: + normalized packege name +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="select_license_by_source" ID="select_license_by_source"></a> <h2>select_license_by_source</h2> <b>select_license_by_source</b>(<i>from_source: FromArg, license_classifier: list[str], license_meta: str</i>)