Utils

Ultility functions for plugins.

smarter.apps.plugin.utils.add_example_plugins(user_profile, verbose=False)[source]

Create example plugins for a new user.

This function provisions example plugins for a user by applying required secrets and connections, then instantiating plugin manifests for validation. It is intended to help new users get started with pre-configured plugin examples.

Parameters:

user_profile (Optional[UserProfile]) – The UserProfile instance representing the new user. Must not be None.

Returns:

Returns True if all example plugins are created and validated successfully.

Return type:

bool

Raises:

SmarterValueError – If user_profile is not provided, or if manifest/secret application fails, or if a plugin does not have a valid YAML representation.

Note

  • This function applies sample secrets and connections using Django management commands. Manifests for these are located in smarter/apps/plugin/data.

  • This function is called during deployment jobs.

Important

  • The user_profile parameter must be a valid UserProfile instance. Passing None or an incorrect type will result in an error.

  • If any manifest or secret update fails, the function raises an exception and does not proceed with plugin creation.

See also

  • PluginExamples

  • PluginController

  • SmarterValueError

Example usage:

from smarter.apps.account.models import UserProfile
from smarter.apps.plugin.utils import add_example_plugins

user_profile = UserProfile.objects.get(user__username="newuser")
success = add_example_plugins(user_profile)
if success:
    print("Example plugins created successfully.")
smarter.apps.plugin.utils.get_plugin_examples_by_name()[source]

Get the names of all example plugins.

This function returns a list of names for all available example plugins, or None if no names are found. It is useful for displaying or referencing example plugins in onboarding flows, documentation, or UI elements.

Returns:

A list of example plugin names, or None if no plugins are available.

Return type:

Optional[list[str]]

See also

  • PluginExamples

Example usage:

from smarter.apps.plugin.utils import get_plugin_examples_by_name

plugin_names = get_plugin_examples_by_name()
if plugin_names:
    print("Available example plugins:", plugin_names)
else:
    print("No example plugins found.")