scipion.install.plugin_funcs module

class scipion.install.plugin_funcs.PluginInfo(pipName='', name='', pluginSourceUrl='', remote=True, plugin=None, **kwargs)

Bases: object

getAuthor()

Return the plugin author

getBinVersions()

Get list with names of binaries of this plugin

getCompatiblePipReleases(pipJsonData=None)

Get pip releases of this plugin that are compatible with current Scipion version. Returns dict with all compatible releases and a special key “latest” with the most recent one.

getDirName()

Get the name of the folder that contains the plugin code itself (e.g. to import the _plugin object.)

getHomePage()

Return the plugin Home page

getInstallenv(envArgs=None)

Reads the defineBinaries function from Plugin class and returns an Environment object with the plugin’s binaries.

getLatestRelease()

Get the plugin latest release

getPipData(info, keys)

Extracts a value from a dictionary (info) based on the primary key. Supports nested keys using dot notation (e.g., “project_urls.Homepage”).

Parameters

• info – Dictionary containing data (e.g., pip info).

• keys – List of keys to extract the value (dot notation for nested keys).

Returns

The extracted value or ‘’ if no keys match.

getPipJsonData()

“Request json data from pypi, return json content

getPipName()

Return the plugin pip name

getPipVersion()

Return the plugin pip version

getPluginClass()

Tries to find the Plugin object.

getPluginName()

Return the plugin name

getReleaseDate(release)

Return the uploaded date from the release

getSourceUrl()

Return the plugin source url

getSummary()

Return the plugin summary

hasPipPackage()

Checks if the current plugin is installed via pip

install()

Installs both pip module and default binaries of the plugin

installBin(args=None)

Install binaries of the plugin. Args is the list of args to be passed to the install environment.

installPipModule(version='')

Installs the version specified of the pip plugin, as long as it is compatible with the current Scipion version. If no version specified, will install latest compatible one.

isInstalled()

Checks if the current plugin is installed (i.e. has pip package). NOTE: we might want to change definition of isInstalled, hence the extra function.

printBinInfoStr()

Returns string with info of binaries installed to print in console with flag –help

setFakedRemotePluginInfo()

Sets value for the attributes that need to be obtained from json file

setLocalPluginInfo()

Sets value for the attributes that can be obtained locally if the plugin is installed.

setRemotePluginInfo()

Sets value for the attributes that need to be obtained from pypi

uninstallBins(binList=None)

Uninstall binaries of the plugin.

Parameters

binList – if given, will uninstall the binaries in it. The binList

may contain strings with only the name of the binary or name and version in the format name-version

:returns None

uninstallPip()

Removes pip package from site-packages

class scipion.install.plugin_funcs.PluginRepository(repoUrl='plugins.json')

Bases: object

static getBinToPluginDict()

getPlugins(pluginList=None, getPipData=False)

Reads available plugins from self.repoUrl and returns a dict with PluginInfo objects. Params: - pluginList: A list with specific plugin pip-names we want to get. - getPipData: If true, each PluginInfo object will try to get the data of the plugin from pypi.

printPluginInfoStr(withBins=False, withUpdates=False)

Returns string to print in console which plugins are installed.

Parameters

• withBins – If true, will add binary info for the plugins installed

• withUpdates – If true, will check if the installed plugins have new releases.

:return A string with the plugin information summarized

scipion.install.plugin_funcs.installBinsDefault()

Returns the default behaviour for installing binaries By default it is TRUE, define “SCIPION_DONT_INSTALL_BINARIES” to anything to deactivate binaries installation