- class RepoPlugin(handle: LP_BNRepoPlugin)¶
RepoPluginis mostly read-only, however you can install/uninstall enable/disable plugins. RepoPlugins are created by parsing the plugins.json in a plugin repository.
handle (LP_BNRepoPlugin) –
- enable(force: bool = False) bool ¶
Enable this plugin, optionally trying to force it. Force loading a plugin with ignore platform and api constraints. (e.g. The plugin author says the plugin will only work on Linux-python3 but you’d like to attempt to load it on Macos-python2)
- install_instructions(platform: str) str | None ¶
Installation instructions for the given platform
String of the plugin author
String URL of the plugin author’s url
- property delete_pending: bool¶
Boolean status indicating that the plugin will be deleted after the next restart
- property dependencies_being_installed: bool¶
Boolean status indicating that the plugin’s dependencies are currently being installed
- property disable_pending: bool¶
Boolean status indicating that the plugin will be disabled after the next restart
- property plugin_types: List[PluginType]¶
List of PluginType enumeration objects indicating the plugin type(s)
- property subdir: str¶
Optional sub-directory the plugin code lives in as a relative path from the plugin root
- property update_pending: bool¶
Boolean status indicating that the plugin has updates will be installed after the next restart
- class Repository(handle: LP_BNRepository)¶
Repositoryis a read-only class. Use RepositoryManager to Enable/Disable/Install/Uninstall plugins.
handle (LP_BNRepository) –
- class RepositoryManager¶
RepositoryManagerKeeps track of all the repositories and keeps the enabled_plugins.json file coherent with the plugins that are installed/uninstalled enabled/disabled
- add_repository(url: str | None = None, repopath: str | None = None) bool ¶
add_repositoryadds a new plugin repository for the manager to track.
There is currently no function to remove a repository. If you want to remove a repository, you must delete the directory and remove the plugin_status.json entries from repositories/ file in the User Folder
Boolean value True if the repository was successfully added, False otherwise.
- Return type:
>>> mgr = RepositoryManager() >>> mgr.add_repository("https://raw.githubusercontent.com/Vector35/community-plugins/master/plugins.json", "community") True >>>