httk.core.plugins.install

Install, build, and uninstall httk plugins from local directories.

Functions

install_plugin(source, *[, force])

Install one plugin from an existing local directory.

build_plugin(name)

Build and publish the declared programs of an installed plugin.

uninstall_plugin(name)

Remove an installed plugin and its still-owned shims.

Module Contents

httk.core.plugins.install.install_plugin(source, *, force=False)[source]

Install one plugin from an existing local directory.

source_sha256 is pre-build provenance: build output and the build log may change the installed tree after this digest is recorded.

Parameters:
  • source (str | pathlib.Path) – Supply the local plugin directory.

  • force (bool) – Replace an installed plugin with the same name.

Returns:

The installed plugin.

Raises:

ValueError – If the source or plugin is invalid or cannot be built.

Return type:

httk.core.plugins.installed.InstalledPlugin

httk.core.plugins.install.build_plugin(name)[source]

Build and publish the declared programs of an installed plugin.

httk.core.plugins.install.uninstall_plugin(name)[source]

Remove an installed plugin and its still-owned shims.