Bundle

Functions

wrapica.bundle.add_data_to_bundle(bundle_id, data_id)

Add data to a bundle

Parameters:

• bundle_id (Union[UUID, str])

• data_id (Union[UUID, str])

Returns:

True if successful, False otherwise

Return type:

bool

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import add_project_data_to_bundle
from wrapica.data import convert_icav2_uri_to_data_obj

# Set vars
# Use get_bundle_obj_from_bundle_name to get bundle_id if
# you have the bundle name and not the bundle id
bundle_id = "abcdef-1234"
data_uri = "icav2://project_id/path/to/data"

# Add project data to bundle
add_data_to_bundle(bundle_id, convert_icav2_uri_to_data_obj(data_uri).id)

wrapica.bundle.add_pipeline_to_bundle(bundle_id, pipeline_id)

Add a pipeline to a bundle.

Parameters:

• bundle_id (Union[UUID, str])

• pipeline_id (Union[UUID, str])

Returns:

True if successful, False otherwise

Return type:

bool

Raises:

ApiException

Examples:

# Wrapica imports
from wrapica.pipeline import get_pipeline_obj_from_pipeline_id
from wrapica.bundle import add_pipeline_to_bundle

# Set vars
pipeline_code = "my_pipeline_code"
bundle_name = "my_bundle_name"

# Get pipeline id from pipeline code
pipeline_id = get_pipeline_obj_from_pipeline_id(pipeline_code).id

# Get bundle id from bundle name
bundle_id = get_bundle_obj_from_bundle_name(bundle_name).id

# Link pipeline to bundle
add_pipeline_to_bundle(bundle_id, pipeline_id)

wrapica.bundle.add_project_data_to_bundle(bundle_id, project_id, data_id)

Add project data to a bundle

Parameters:

• bundle_id (Union[UUID, str])

• project_id (Union[UUID, str])

• data_id (Union[UUID, str])

Returns:

True if successful, False otherwise

Return type:

bool

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import add_project_data_to_bundle
from wrapica.project_data import convert_icav2_uri_to_data_obj

# Set vars
bundle_id = "abcdef-1234"
data_uri = "icav2://project_id/path/to/data"

# Get project id and data id from data uri
project_data_obj = convert_icav2_uri_to_data_obj(data_uri)

# Add project data to bundle
add_project_data_to_bundle(bundle_id, project_data_obj.project_id, project_data_obj.data.id)

wrapica.bundle.coerce_bundle_id_or_name_to_bundle_id(bundle_id_or_name)

Given either a bundle id or bundle name, return the bundle id

Parameters:

bundle_id_or_name (str)

Returns:

The bundle id

Return type:

str

wrapica.bundle.coerce_bundle_id_or_name_to_bundle_obj(bundle_id_or_name)

Given either a bundle id or bundle name, return the bundle object

Parameters:

bundle_id_or_name (str)

Returns:

The bundle as an object

Return type:

Bundle

wrapica.bundle.deprecate_bundle(bundle_id)

Given a bundle id, deprecate the bundle

Parameters:

bundle_id (Union[UUID, str])

Returns:

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import deprecate_bundle

# Set vars
bundle_id = "abcdef-1234"

# Deprecate the bundle
deprecate_bundle(bundle_id)

wrapica.bundle.filter_bundle_data_to_top_level_only(bundle_data)

Filter bundle data to top level only (no subdirectories or files underneath folders)

Parameters:

bundle_data (List[BundleData]) – List of linked bundle data items

Returns:

List of top level bundle data items

Return type:

List[BundleData]

Examples:

# Imports
from wrapica.bundle import filter_bundle_data_to_top_level_only, list_data_in_bundle

# Set vars
bundle_id = "abcdef-1234"

# Get all data
bundle_data = list_data_in_bundle(bundle_id)

# Filter to top level only
top_level_bundle_data = filter_bundle_data_to_top_level_only(bundle_data)

wrapica.bundle.filter_bundles(bundle_name=None, project_id=None, region_id=None, status=None, creator_id=None)

Get a list of bundles but filter by name, region id, status, and creator id

Parameters:

• bundle_name (Optional[str]) – The name of the bundle

• project_id (Union[UUID, str, None]) – The project id

• region_id (Union[UUID, str, None]) – The region id of the bundle

• status (Optional[Literal['DRAFT', 'RELEASED', 'DEPRECATED']]) – The status of the bundle

• creator_id (Union[UUID, str, None]) – The creator id of the bundle

Returns:

List of bundles

Return type:

List[Bundle]

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import filter_bundles
from wrapica.libica_models import Bundle
from wrapica.enums import BundleStatus
from wrapica.user import get_user_from_user_name

# Set vars
user_name = "Alexis Lucattini"

# Get creator id from user name
creator_id = get_user_from_user_name(user_name).id

# Filter bundles
bundle_list: List[Bundle] = filter_bundles(
    bundle_status=BundleStatus.RELEASED,
    creator_id=creator_id
)

wrapica.bundle.generate_empty_bundle(bundle_name, bundle_version, short_description, version_comment, region_id=None, categories=None, pipeline_release_url=None)

Generate an empty bundle (in DRAFT format) and return the bundle object

Parameters:

• bundle_name (str) – The name of the bundle

• bundle_version (str) – The version of the bundle

• short_description (str) – The description of the bundle

• version_comment (str) – The description of the version

• region_id (Union[UUID, str, None]) – The region id of the bundle

• categories (Optional[List[str]])

• pipeline_release_url (Optional[str])

Returns:

The newly created bundle object

Return type:

Bundle

Raises:

ApiException

Examples:

:linenos:

from wrapica.bundle import generate_empty_bundle
from wrapica.libica_models import Bundle

# Initialise bundle
bundle_obj: Bundle = generate_empty_bundle(
    bundle_name="my-first-bundle",
    bundle_description="A quick description of the bundle",
    bundle_version="1.0.0",
    bundle_version_description="First release of my-first-bundle",
    categories=["Test"]
)

wrapica.bundle.get_bundle_obj_from_bundle_id(bundle_id)

Given a bundle_id, return the bundle object

Parameters:

bundle_id (Union[UUID, str])

Returns:

The bundle as an object

Return type:

Bundle

Raises:

ApiException

Examples:

from wrapica.bundle import get_bundle_obj_from_bundle_id
from wrapica.libica_models import Bundle

# Get bundle object from the bundle id
bundle_obj: Bundle = get_bundle_obj_from_bundle_id(
    bundle_id='abcdef-1234'
)

wrapica.bundle.get_bundle_obj_from_bundle_name(bundle_name, region_id=None)

Given a bundle name, return the bundle object

Parameters:

• bundle_name (str) – The bundle name

• region_id (Union[UUID, str, None]) – The region id of the bundle

Returns:

The bundle as an object

Return type:

Bundle

Raises:

ApiException

Examples:

from wrapica.bundle import get_bundle_obj_from_bundle_name
from wrapica.libica_models import Bundle

# Get bundle object from the bundle name
bundle_obj: Bundle = get_bundle_obj_from_bundle_name(
    bundle_name='my-first-bundle'
)

wrapica.bundle.link_bundle_to_project(project_id, bundle_id)

Link bundle to project

Parameters:

• project_id (Union[UUID, str]) – The project id

• bundle_id (Union[UUID, str]) – The bundle id

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import link_bundle_to_project

# Set vars
project_id = "abcdef-1234"
bundle_id = "abcdef-1234"

# Link bundle to project
link_bundle_to_project(project_id, bundle_id)

wrapica.bundle.list_bundles_in_project(project_id)

List bundles in a project

Parameters:

project_id (Union[UUID, str]) – The project id

Returns:

List of bundles linked to this project

Return type:

List[Bundle]

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import list_bundles_in_project

list_bundles_in_project(project_id='abcdef-1234')    

wrapica.bundle.list_data_in_bundle(bundle_id)

Given a bundle id, list data in a bundle

Parameters:

bundle_id (Union[UUID, str])

Returns:

List of data items

Return type:

List[BundleData]

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import list_data_in_bundles

list_data_in_bundle(bundle_id='abcdef-1234')

wrapica.bundle.list_pipelines_in_bundle(bundle_id)

Given a bundle id, list pipelines in a bundle

Parameters:

bundle_id (Union[UUID, str]) – The bundle id

Returns:

List of pipeline items

Return type:

List[BundlePipeline]

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import list_pipelines_in_bundle

list_pipelines_in_bundle(bundle_id='abcdef-1234')

wrapica.bundle.release_bundle(bundle_id)

Release a bundle, converts a bundle status from DRAFT to RELEASED.

Parameters:

bundle_id (Union[UUID, str])

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import release_bundle

# Set vars
bundle_id = "abcdef-1234"

# Release bundle
release_bundle(bundle_id)

wrapica.bundle.unlink_bundle_from_project(project_id, bundle_id)

Remove the bundle from the project

Parameters:

• project_id (Union[UUID, str]) – The project id

• bundle_id (Union[UUID, str]) – The bundle id

Raises:

ApiException

Examples:

# Imports
from wrapica.bundle import unlink_bundle_from_project

# Set vars
project_id = "abcdef-1234"
bundle_id = "abcdef-1234"

# Unlink bundle to project
unlink_bundle_from_project(project_id, bundle_id)