Project

Functions

wrapica.project.check_project_has_data_sharing_enabled(project_id)

Given a project id return whether the project has data sharing enabled

Parameters:: project_id (Union[UUID, str]) – The id of the project
Returns:: True if data sharing is enabled, False otherwise
Return type:: str

:raises ValueError, ApiException

Examples:

from wrapica.project import get_project_id_from_project_name

project_id = get_project_id_from_project_name("my_project")

print(check_project_has_data_sharing_enabled(project_id))
# False

wrapica.project.coerce_project_id_or_name_to_project_id(project_id_or_name)

Given a project id or name, return the project id

Parameters:: project_id_or_name (str) – The id or name of the project
Returns:: The id of the project
Return type:: str

:raises ValueError, ApiException

Examples:

from wrapica.project import coerce_project_id_or_name_to_project_id

project_id = coerce_project_id_or_name_to_project_id("my_project")

print(project_id)
# "1234-5678-9012-3456"

wrapica.project.coerce_project_id_or_name_to_project_obj(project_id_or_name)

Given a project id or name, coerce to a project object

Parameters:: project_id_or_name (str) – The project id or name
Return type:: Project
Returns:: The project object

wrapica.project.get_project_id()

Return type:: str

wrapica.project.get_project_id_from_project_name(project_name)

Given a project name return the id of the project Will raise an error if the project id cannot be found

Parameters:: project_name (str) – The name of the project
Returns:: The id of the project
Return type:: str

:raises StopIteration, ApiException

Examples:

from wrapica.project import get_project_id_from_project_name

project_id = get_project_id_from_project_name("my_project")

print(project_id)
# "1234-5678-9012-3456"

wrapica.project.get_project_name_from_project_id(project_id): Given a project id, get the project object and return the name attribute :type project_id: Union[UUID, str] :param project_id: :rtype: str :return:

wrapica.project.get_project_obj_from_project_id(project_id)

Given a project id return the project object

Parameters:

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

Returns:

The project object

Return type:

List[Project]

wrapica.project.get_project_obj_from_project_name(project_name)

Given a project name, get the project as an object

Will raise an error if the project id cannot be found

Parameters:: project_name (str) – The name of the project
Returns:: The id of the project
Return type:: str

:raises ValueError, ApiException

Examples:

from wrapica.project import get_project_id_from_project_name

project_obj = get_project_obj_from_project_name("my_project")

print(project_obj.id)
# "1234-5678-9012-3456"

wrapica.project.list_projects(include_hidden_projects=False)

List all projects

Parameters:

include_hidden_projects (bool)

Returns:

List of project objects

Return type:

List[Project]

Raises:

ApiException

Examples:

from wrapica.project import list_projects
all_active_projects = list_projects()