Skip to content

Help Module ​

CLI help command and version update checking for the xulbux-lib tool.

PACKAGE_META_URL ​

python
PACKAGE_META_URL: Final[str] = "https://pypi.org/pypi/xulbux/json"

URL to fetch the package metadata from PyPI.

get_latest_version() ​

python
def get_latest_version(timeout: float = 1.0) -> str | None

Fetches the latest version of the library from PyPI in the format x.y.z.


  • timeout – Maximum duration in seconds to wait for the version check before aborting and continuing.

Returns None if the latest version could not be fetched.

is_latest_version() ​

python
def is_latest_version(latest_version: str | None = None, /) -> bool | None

Checks if the currently installed version of the library is the latest one available on PyPI.


  • latest_version – Optional already fetched latest version to avoid duplicate network requests.

Returns None if the check failed.

show_help() ​

python
def show_help() -> None

CLI command function for xulbux-lib command,
which shows some information about the library.

Released under the MIT License.