PluginApi¶

class PluginApi[source]¶

Bases: supervisely.api.module_api.ModuleApi

API for working with plugins. PluginApi object is immutable.

Parameters

api : Api: API connection to the server

Usage example

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))
api = sly.Api.from_env()

# Pass values into the API constructor (optional, not recommended)
# api = sly.Api(server_address="https://app.supervise.ly", token="4r47N...xaTatb")

team_id = 8
plugin_info = api.plugin.get_list(team_id)

Methods

`exists`	Checks if an entity with the given parent_id and name exists
`get_free_name`	Generates a free name for an entity with the given parent_id and name.
`get_info_by_id`	Get Plugin information by ID.
`get_info_by_name`	Get information about an entity by its name from the Supervisely server.
`get_list`	Get list of plugins in the Team.
`get_list_all_pages`	Get list of all or limited quantity entities from the Supervisely server.
`get_list_all_pages_generator`	This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
`info_sequence`	NamedTuple PluginInfo information about Plugin.
`info_tuple_name`	NamedTuple name - PluginInfo.

Attributes

`MAX_WAIT_ATTEMPTS`	Maximum number of attempts that will be made to wait for a certain condition to be met.
`WAIT_ATTEMPT_TIMEOUT_SEC`	Number of seconds for intervals between attempts.

InfoType¶: alias of supervisely.api.module_api.PluginInfo

exists(parent_id, name)¶

Checks if an entity with the given parent_id and name exists

Parameters

parent_id : int: ID of the parent entity.
name : str: Name of the entity.

Returns

Returns True if entity exists, and False if not

Return type

bool

Usage example

import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


name = "IMG_0315.jpeg"
dataset_id = 55832
exists = api.image.exists(dataset_id, name)
print(exists) # True

get_free_name(parent_id, name)¶

Generates a free name for an entity with the given parent_id and name. Adds an increasing suffix to original name until a unique name is found.

Parameters

parent_id : int: ID of the parent entity.
name : str: Name of the entity.

Returns

Returns free name.

Return type

str

Usage example

import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


name = "IMG_0315.jpeg"
dataset_id = 55832
free_name = api.image.get_free_name(dataset_id, name)
print(free_name) # IMG_0315_001.jpeg

get_info_by_id(team_id, plugin_id)[source]¶

Get Plugin information by ID.

Parameters

team_id : int: Team ID in Supervisely.
plugin_id : int: Plugin ID in Supervisely.

Returns

Information about Plugin. See info_sequence

Return type

NamedTuple

Usage example

import supervisely as sly

os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()

plugin_info = api.plugin.get_info_by_id(8, 3)
print(plugin_info)
# Output: PluginInfo(id=3,
#                    name='DTL',
#                    description='Allows to combine datasets, to make class mapping, filter objects and images, apply auto augmentations and so on ...',
#                    type='dtl',
#                    default_version='latest',
#                    docker_image='docker.deepsystems.io/supervisely/five/dtl',
#                    readme='# Data Transformation Language (DTL)...',
#                    configs=[],
#                    versions=['lately', 'docs', ...],
#                    created_at='2020-03-30T09:17:36.000Z',
#                    updated_at='2020-04-23T06:26:29.000Z')

get_info_by_name(parent_id, name)¶

Get information about an entity by its name from the Supervisely server.

Parameters

parent_id : int: ID of the parent entity.
name : str: Name of the entity for which the information is being retrieved

Usage example

import supervisely as sly

# You can connect to API directly
address = 'https://app.supervise.ly/'
token = 'Your Supervisely API Token'
api = sly.Api(address, token)

# Or you can use API from environment
os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()


dataset_id = 55832
name = "IMG_0315.jpeg"
info = api.image.get_info_by_name(dataset_id, name)
print(info)
# Output: ImageInfo(id=19369643, name='IMG_0315.jpeg', ...)

get_list(team_id, filters=None)[source]¶

Get list of plugins in the Team.

Parameters

team_id : int: Team ID in Supervisely.
filters : List[dict], optional: List of params to sort output Plugins.

Returns

List of Plugins with information. See info_sequence

Return type

List[NamedTuple]

Usage example

import supervisely as sly

os.environ['SERVER_ADDRESS'] = 'https://app.supervise.ly'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
api = sly.Api.from_env()

team_id = 8
plugin_info = api.plugin.get_list(team_id)

plugin_list_filter = api.plugin.get_list(team_id, filters=[{'field': 'name', 'operator': '=', 'value': 'Images'}])

get_list_all_pages(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)¶

Get list of all or limited quantity entities from the Supervisely server.

Parameters

method : str: Request method name
data : dict: Dictionary with request body info
progress_cb : Progress, optional: Function for tracking download progress.
convert_json_info_cb : Callable, optional: Function for convert json info
limit : int, optional: Number of entity to retrieve
return_first_response : bool, optional: Specify if return first response

get_list_all_pages_generator(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)¶

This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved

Parameters

method : str: Request method name
data : dict: Dictionary with request body info
progress_cb : Progress, optional: Function for tracking download progress.
convert_json_info_cb : Callable, optional: Function for convert json info
limit : int, optional: Number of entity to retrieve
return_first_response : bool, optional: Specify if return first response

static info_sequence()[source]¶

NamedTuple PluginInfo information about Plugin.

Example

PluginInfo(id=3,
           name='DTL',
           description='Allows to combine datasets, to make class mapping, filter objects and images, apply auto augmentations and so on ...',
           type='dtl',
           default_version='latest',
           docker_image='docker.deepsystems.io/supervisely/five/dtl',
           readme='# Data Transformation Language (DTL)...',
           configs=[],
           versions=['lately', 'docs', ...],
           created_at='2020-03-30T09:17:36.000Z',
           updated_at='2020-04-23T06:26:29.000Z')

static info_tuple_name()[source]¶: NamedTuple name - PluginInfo.