esm_version_checker package

esm_version_checker - Mini package to check versions of diverse esm_tools software

Submodules

esm_version_checker.cli module

Console script for esm_version_checker.

class esm_version_checker.cli.GlobalVars[source]

Bases: object

A struct-like class for holding the global variables. GlobalVars instance should only be updated by the main function and should be ‘read-only’ by the other functions

from_github

top-level command-line option flag for connecting to the GitHub repo

Type

bool

esm_tools_github_url

repository URL of the ESM-Tools

Type

str

esm_tools_installed

each key is the specidif ESM-Tools package and value is bool

Type

dict

esm_tools_github_url = 'https://github.com/esm-tools/'
esm_tools_installed = {}
from_github = False
esm_version_checker.cli.check_importable_tools()[source]
esm_version_checker.cli.dist_is_editable(dist)[source]

Is distribution an editable install?

esm_version_checker.cli.editable_dist_location(dist)[source]

Determines where an editable dist is installed

esm_version_checker.cli.get_esm_package_attributes(tool)[source]

Gets the attributes of the ESM-Tools package

Parameters

tool (str) – name of the ESM-Tools package

Returns

attr_dict – dictionary of attributes.

Return type

dict

esm_version_checker.cli.get_esm_packages()[source]

Gets the list of the installed ESM-Tools packages either locally or from the GitHub repository

Returns

esm_tools_modules – list of strings where each item corresponds to a ESM-Tools package name

Return type

list

esm_version_checker.cli.global_options_decorator(func)[source]

decorator function for the global option

esm_version_checker.cli.pip_install(package)[source]
esm_version_checker.cli.pip_or_pull(tool, version=None)[source]
esm_version_checker.cli.pip_uninstall(package)[source]
esm_version_checker.cli.pip_upgrade(package, version=None)[source]
esm_version_checker.cli.report_single_package(package, version, file_path, branch, describe)[source]

Nice output similar to the tree command in Linux

esm_version_checker.cli.user_owns(binary)[source]

True or False if user owns binary