Licensecheck Index / Licensecheck / Packageinfo
Auto-generated documentation for licensecheck.packageinfo module.
- Packageinfo
Show source in packageinfo.py:126
Handles retrieval of package info from local installation.
class LocalPackageInfo:
def __init__(self, package: PackageInfo) -> None: ...Show source in packageinfo.py:153
def get_author(self) -> str | None: ...Show source in packageinfo.py:150
def get_homePage(self) -> str | None: ...Show source in packageinfo.py:137
def get_license(self) -> str | None: ...Show source in packageinfo.py:144
def get_name(self) -> str | None: ...Show source in packageinfo.py:156
Retrieve installed package size.
packageucstr - Package name.
Type: int Size in bytes.
def get_size(self) -> int: ...Show source in packageinfo.py:147
def get_version(self) -> str | None: ...Show source in packageinfo.py:28
Manages retrieval of local and remote package information.
class PackageInfoManager:
def __init__(self, base_pypi_url: str = "https://pypi.org") -> None: ...Show source in packageinfo.py:73
Retrieve package information from local installation or PyPI.
:param set[ucstr] reqs: Set of dependency names to retrieve information for.
Type: set[PackageInfo] A set of package information objects.
def getPackages(self) -> set[PackageInfo]: ...Show source in packageinfo.py:87
Retrieve package information, preferring local data.
pacageucstr - Package name.
Type: PackageInfo Information about the package.
def get_package_info(self, package: PackageInfo) -> PackageInfo: ...Show source in packageinfo.py:41
def resolve_requirements(
self,
requirements_paths: list[str],
groups: list[str],
extras: list[str],
skip_dependencies: list[ucstr],
) -> None: ...Show source in packageinfo.py:277
Handles extraction of project metadata from configuration files.
class ProjectMetadata: ...Show source in packageinfo.py:305
Extract license from project metadata.
Type: ucstr License string.
@staticmethod
def get_license() -> ucstr: ...Show source in packageinfo.py:280
Extract project metadata from setup.cfg or pyproject.toml.
Type: dict[str, Any] Extracted metadata.
@staticmethod
def get_metadata() -> dict[str, Any]: ...Show source in packageinfo.py:169
Handles retrieval of package info from PyPI.
class RemotePackageInfo:
def __init__(self, pypi_api: str, package: PackageInfo) -> None: ...Show source in packageinfo.py:227
def get_author(self) -> str | None: ...Show source in packageinfo.py:223
def get_homePage(self) -> str | None: ...Show source in packageinfo.py:207
def get_license(self) -> str | None: ...Show source in packageinfo.py:215
def get_name(self) -> str | None: ...Show source in packageinfo.py:231
Retrieve package size from PyPI metadata.
:param dict[str, Any] data: PyPI response JSON.
Type: int Package size in bytes.
def get_size(self) -> int: ...Show source in packageinfo.py:219
def get_version(self) -> str | None: ...Show source in packageinfo.py:191
def make_req(self, url: str) -> dict: ...Show source in packageinfo.py:178
def poke_pypi(self) -> None: ...Show source in packageinfo.py:258
Extract license from classifiers.
:param list[str] | None classifiers: list of classifiers
Type: ucstr licenses as a ucstr
def from_classifiers(classifiers: list[str] | None) -> str | None: ...Show source in packageinfo.py:245
Retrieve metadata value safely.
:param Message | dict[str, Any] self.meta: Metadata source.
keystr - Metadata key.
Type: str Retrieved metadata value.
def meta_get(meta: Message | dict[str, Any], key: str) -> str | None: ...