Skip to content

Python SDK - Project

askanna.project.get

import askanna

project = askanna.project.get(project_suuid="{PROJECT_SUUID}")

Parameters

Name Type Required Description
project_suuid String Yes Project SUUID you want to retrieve the information from

Output

Dataclass: Project

askanna.project.list

import askanna

project_list = askanna.project.list()

Parameters

Name Type Required Description
workspace_suuid String No Workspace SUUID for which you want to get a list of projects
limit Integer No Limit the number of projects in the result. Defaults to 100.
offset Integer No Offset the number of projects in the result. Defaults to 0.
ordering String No Sets the ordering of the project list. Defaults to "-created"

Output

List with elements with Dataclass: Project

askanna.project.create

import askanna

project = askanna.project.create(workspace_suuid="{WORKSPACE_SUUID}", name="{PROJECT_NAME}")

Parameters

Name Type Required Description
workspace_suuid String Yes SUUID of the workspace to create the project in
name String Yes Name for the new project
description String No Description for the new project. Defaults to an empty description.
visibility String No Visibility of the new project. Allowed values are "PRIVATE" and "PUBLIC". Defaults to "PRIVATE".

Output

Dataclass: Project

askanna.project.change

import askanna

project = askanna.project.change(project_suuid="{PROJECT_SUUID}", name="{NEW_NAME}")

Parameters

Name Type Required Description
project_suuid String Yes SUUID of the project you want to change
name String No New name for the project. Defaults to None (do not change).
description String No New description for the project. Defaults to None (do not change).
visibility String No Visibility of the project. Allowed values are "PRIVATE", "PUBLIC" or None. Defaults to None (do not change).

To change project info, at least we need a new name, description or visibility

Output

Dataclass: Project

askanna.project.delete

import askanna

askanna.project.delete(project_suuid="{PROJECT_SUUID}")

Parameters

Name Type Required Description
project_suuid String Yes SUUID of the project you want to delete

Output

Bool: True if the project is succesfully deleted