pdstools.utils.show_versions¶

Attributes¶

package_name

Functions¶

`show_versions`(…)	Get a list of currently installed versions of pdstools and its dependencies.
`expand_nested_deps`(→ Dict[str, Set[str]])
`grouped_dependencies`(→ Dict[str, Set[str]])
`_get_dependency_version`(→ str)
`_dependency_table`([public_only])
`dependency_great_table`([public_only])

Module Contents¶

package_name = 'pdstools'¶

show_versions(print_output: Literal[True] = True) → None¶

show_versions(print_output: Literal[False] = False) → str

Get a list of currently installed versions of pdstools and its dependencies.

Parameters:: print_output (bool, optional) – If True, print the version information to stdout. If False, return the version information as a string. Default is True.
Returns:: Version information as a string if print_output is False, else None.
Return type:: Optional[str]

Examples

>>> from pdstools import show_versions
>>> show_versions()
--- Version info ---
pdstools: 4.0.0-alpha
Platform: macOS-14.7-arm64-arm-64bit
Python: 3.12.4 (main, Jun  6 2024, 18:26:44) [Clang 15.0.0 (clang-1500.3.9.4)]

— Dependencies — typing_extensions: 4.12.2 polars>=1.9: 1.9.0

— Dependency group: adm — plotly>=5.5.0: 5.24.1

— Dependency group: api — pydantic: 2.9.2 httpx: 0.27.2

expand_nested_deps(extras: Dict[str, Set[str]]) → Dict[str, Set[str]]¶

Parameters:: extras (Dict[str, Set[str]])
Return type:: Dict[str, Set[str]]

grouped_dependencies() → Dict[str, Set[str]]¶

Return type:: Dict[str, Set[str]]

_get_dependency_version(dep_name: str) → str¶

Parameters:: dep_name (str)
Return type:: str

_dependency_table(public_only: bool = False)¶

Parameters:: public_only (bool)

dependency_great_table(public_only: bool = True)¶

Parameters:: public_only (bool)