8.4.12. pymodaq_utils.packages module

pymodaq_utils.packages.extract_authors_from_description(description)

returns the authors as a list from the plugin package description (it should follow the template structure)

Parameters:

description ((str))

Return type:

list of string

pymodaq_utils.packages.get_check_repo(plugin_dict)

Unused

pymodaq_utils.packages.get_entrypoints(group='pymodaq.plugins')

Get the list of modules defined from a group entry point

Because of evolution in the package, one or another of the forms below may be deprecated. We start from the newer way down to the older

Parameters:

group (str) – the name of the group

pymodaq_utils.packages.get_metadata_from_json(json_as_dict)

Transform dict of metadata from pypi to a simpler dict

Return type:

dict

pymodaq_utils.packages.get_package_metadata(name, version=None)

Retrieve the metadata of a given package on pypi matching or not a specific version

Parameters:

• name (str) – package name

• version (Union[str, Version]) – package version specifier

Return type:

dict

pymodaq_utils.packages.get_pymodaq_specifier(requirements)

Get specifiers for pymodaq version from a list of requirements

Return type:

SpecifierSet

pymodaq_utils.packages.get_pypi_package_list(match_name=None, print_method=<bound method Logger.info of <Logger pymodaq.packages (DEBUG)>>)

Connect to the “simple” pypi url to get the list of all packages matching all or part of the given name

Parameters:

• match_name (Union[str, list[str]]) – The package name to be (partially) matched

• print_method (Callable)

Return type:

List[str]

Examples

get_pypi_package_list(‘pymodaq_plugins’) will retrieve the names of all packages having ‘pymodaq_plugins’ in their name

pymodaq_utils.packages.get_pypi_pymodaq(package_name='pymodaq-plugins', pymodaq_version=None, pymodaq_latest=None)

Get the latest plugin info compatible with a given version of pymodaq

Parameters:

• package_name (str)

• pymodaq_version (Version)

Return type:

dict containing metadata of the latest compatible plugin

pymodaq_utils.packages.post_error(message)