fiftyone.plugins.utils

module documentation

(source)

FiftyOne plugin utilities.

Function	`find_plugins`	Returns the paths to the fiftyone YAML files for all plugins found in the given GitHub repository.
Function	`get_plugin_info`	Returns a dict of plugin info for a FiftyOne plugin hosted in GitHub.
Function	`list_zoo_plugins`	Returns a list of available plugins registered in the FiftyOne Plugins repository README.
Variable	`logger`	Undocumented
Function	`_do_get_plugin_info`	Undocumented
Function	`_get_all_plugin_info`	Undocumented

def find_plugins(gh_repo, path=None, info=False): (source) ¶

Returns the paths to the fiftyone YAML files for all plugins found in the given GitHub repository.

Example usage:

import fiftyone.plugins.utils as fopu

# Search the entire repository
plugins = fopu.find_plugins("https://github.com/voxel51/fiftyone-plugins")
print(plugins)

# Search a specific tree root
plugins = fopu.find_plugins(
    "https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/annotation"
)
print(plugins)

# Search a specific branch + subdirectory
plugins = fopu.find_plugins(
    "https://github.com/voxel51/fiftyone-plugins/tree/main",
    path="plugins/annotation",
)
print(plugins)

Parameters
gh_repo	the GitHub repository, identifier, or tree path, which can be: a GitHub repo URL like `https://github.com/<user>/<repo>` a GitHub ref like `https://github.com/<user>/<repo>/tree/<branch>` or `https://github.com/<user>/<repo>/commit/<commit>` a GitHub ref string like `<user>/<repo>[/<ref>]` a GitHub tree path like `https://github.com/<user>/<repo>/tree/<branch>/<path>`
path:`None`	an optional subdirectory of the repository to which to restrict the search. If `gh_repo` also contains a `<path>`, it is prepended to this value
info:`False`	whether to retrieve full plugin info for each plugin (True) or just return paths to the fiftyone YAML files (False)
Returns
a list of paths to fiftyone YAML files or plugin info dicts

def get_plugin_info(gh_repo, path=None): (source) ¶

Returns a dict of plugin info for a FiftyOne plugin hosted in GitHub.

Example usage:

import fiftyone.plugins.utils as fopu

# A repository with a top-level fiftyone YAML file
info = fopu.get_plugin_info("https://github.com/voxel51/voxelgpt")
print(info)

# A plugin that lives in a subdirectory
# Manually specify the branch to use
info = fopu.get_plugin_info(
    "https://github.com/voxel51/fiftyone-plugins/tree/main/plugins/annotation"
)
print(info)

# Directly link to a fiftyone YAML file
info = fopu.get_plugin_info(
    "https://github.com/voxel51/fiftyone-plugins/blob/main/plugins/annotation/fiftyone.yml"
)
print(info)

# Provide subdirectory separately
info = fopu.get_plugin_info(
    "voxel51/fiftyone-plugins",
    path="plugins/annotation",
)
print(info)

# Provide fiftyone YAML file path separately
info = fopu.get_plugin_info(
    "voxel51/fiftyone-plugins",
    path="plugins/annotation/fiftyone.yml",
)
print(info)

Parameters
gh_repo	the GitHub repository, identifier, tree path, or blob path, which can be: a GitHub repo URL like `https://github.com/<user>/<repo>` a GitHub ref like `https://github.com/<user>/<repo>/tree/<branch>` or `https://github.com/<user>/<repo>/commit/<commit>` a GitHub ref string like `<user>/<repo>[/<ref>]` a GitHub tree path like `https://github.com/<user>/<repo>/tree/<branch>/<path>` a GitHub blob path like `https://github.com/<user>/<repo>/blob/<branch>/<path>`
path:`None`	the path to a fiftyone YAML file or the directory that contains it. This is only necessary if the fiftyone YAML file is not at the root of the repository and you have not implicitly included this path in `gh_repo` by providing a tree or blob path
Returns
a dict or list of dicts of plugin info

def list_zoo_plugins(info=False): (source) ¶

Returns a list of available plugins registered in the FiftyOne Plugins repository README.

Example usage:

import fiftyone.plugins.utils as fopu

plugins = fopu.list_zoo_plugins()
print(plugins)

plugins = fopu.list_zoo_plugins(info=True)
print(plugins)

Parameters
info:`False`	whether to retrieve full plugin info for each plugin (True) or just return the available info from the README (False)
Returns
a list of dicts describing the plugins

logger = (source) ¶

Undocumented

def _do_get_plugin_info(task): (source) ¶

Undocumented

def _get_all_plugin_info(tasks): (source) ¶

Undocumented