pdstools.utils.show_versions¶

Attributes¶

`package_name`
`logger`

Functions¶

`show_versions`(…)	Get a list of currently installed versions of pdstools and its dependencies.
`expand_nested_deps`(→ dict[str, set[str]])	Expand nested deps.
`grouped_dependencies`(→ dict[str, set[str]])	Grouped dependencies.
`dependency_great_table`([public_only])	Dependency great table.

Module Contents¶

package_name = 'pdstools'¶

logger¶

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.
include_dependencies (bool, optional) – If True, include the versions of dependencies in the output. If False, only include the pdstools version and system information. Default is True.
include_runtime_diagnostics (bool, optional) – If True, also report runtime details that are useful when diagnosing environment issues: the polars index-type runtime (rt64 vs rt32) and the presence/version of external tools (quarto, pandoc) used by the report-rendering path. Default is False (the CLI pdstools doctor subcommand sets this flag).

Returns:

Version information as a string if print_output is False, else None.

Return type:

str | None

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]]¶

Expand nested deps.

Parameters:: extras (dict[str, set[str]])
Return type:: dict[str, set[str]]

grouped_dependencies() → dict[str, set[str]]¶

Grouped dependencies.

Return type:: dict[str, set[str]]

dependency_great_table(public_only: bool = True)¶

Dependency great table.

Parameters:: public_only (bool)