msl.package_manager.install module
Install MSL packages.
- msl.package_manager.install.install(*names, **kwargs)[source]
Install MSL packages.
MSL packages can be installed from PyPI packages (only if a release has been uploaded to PyPI) or from GitHub repositories.
Note
If the MSL packages are available on PyPI then PyPI is used as the default location to install the package. If you want to force the installation to occur from the
mainbranch from GitHub (even though the package is available on PyPI) then setbranch='main'. If the package is not available on PyPI then themainbranch is used as the default installation location.Changed in version 2.4.0: Added the pip_options keyword argument.
Changed in version 2.5.0: Added the commit keyword argument. The default name of a repository branch changed to
main.- Parameters:
*names – The name(s) of the MSL package(s) to install. If not specified then install all MSL packages that begin with the
msl-prefix. Themsl-prefix can be omitted (e.g.,'loadlib'is equivalent to'msl-loadlib'). Also accepts shell-style wildcards (e.g.,'pr-*').**kwargs –
- branch –
str The name of a git branch to install. If not specified and neither a tag nor commit was specified then the
mainbranch is used to install a package if it is not available on PyPI.
- branch –
- commit –
str The hash value of a git commit to use to install a package.
- commit –
- tag –
str The name of a git tag to use to install a package.
- tag –
- update_cache –
bool The information about the MSL packages that are available on PyPI and about the repositories that are available on GitHub are cached to use for subsequent calls to this function. After 24 hours the cache is automatically updated. Set update_cache to be
Trueto force the cache to be updated when you call this function. Default isFalse.
- update_cache –