pdstools.utils.show_versions
============================

.. py:module:: pdstools.utils.show_versions


Attributes
----------

.. autoapisummary::

   pdstools.utils.show_versions.package_name


Functions
---------

.. autoapisummary::

   pdstools.utils.show_versions.show_versions
   pdstools.utils.show_versions.expand_nested_deps
   pdstools.utils.show_versions.grouped_dependencies
   pdstools.utils.show_versions._get_dependency_version
   pdstools.utils.show_versions._dependency_table
   pdstools.utils.show_versions.dependency_great_table


Module Contents
---------------

.. py:data:: package_name
   :value: 'pdstools'


.. py:function:: 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.

   :param print_output: If True, print the version information to stdout.
                        If False, return the version information as a string.
                        Default is True.
   :type print_output: bool, optional

   :returns: Version information as a string if print_output is False, else None.
   :rtype: Optional[str]

   .. rubric:: 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


.. py:function:: expand_nested_deps(extras: Dict[str, Set[str]]) -> Dict[str, Set[str]]

.. py:function:: grouped_dependencies() -> Dict[str, Set[str]]

.. py:function:: _get_dependency_version(dep_name: str) -> str

.. py:function:: _dependency_table(public_only: bool = False)

.. py:function:: dependency_great_table(public_only: bool = True)