Skip to main content

Plugins

Plugins extend Strongly itself (DataHub lineage, Stripe App Payments). Use this resource to install them, turn them on or off, change their settings and uninstall them.

Access it as client.plugins on a Strongly client, or the same path on AsyncStrongly with await. All methods exist on both with identical signatures.

Quick start​

from strongly import Strongly

client = Strongly()

# List (auto-paginates as you iterate)
for plugin in client.plugins.list():
print(plugin.id)

Methods​

Core​

list​

list() -> list[Plugin]

List the installable plugins, each with its configuration fields and features.

Other​

install​

install(plugin_id: str, *, values: dict[str, Any] | None = None, features: dict[str, bool] | None = None, organization_id: str | None = None) -> PluginInstance

Install a plugin; installing it again replaces its configuration and turns it on.

Parameters

  • plugin_id (str): The plugin, from list.
  • values (dict | None, optional): Its configuration, by field key (every required field).
  • features (dict | None, optional): Feature ids to turn on or off; the rest take their defaults.
  • organization_id (str | None, optional): Multi-tenant administrators only: the organization to install it for.

list_instances​

list_instances() -> SyncPaginator[PluginInstance]

List the installed plugins you may see.

retrieve_instance​

retrieve_instance(instance_id: str) -> PluginInstance

Get an installed plugin.

uninstall​

uninstall(instance_id: str) -> None

Uninstall a plugin (stripe-app-payments not while any app still charges).

update_instance​

update_instance(instance_id: str, *, enabled: bool | None = None, values: dict[str, Any] | None = None, features: dict[str, bool] | None = None) -> PluginInstance

Turn an installed plugin on or off, or change its configuration or features.

stripe-app-payments cannot be turned off while any app still charges for access (ConflictError).