Create project

To create a project:

sa.create_project(
    project_name = "Project Name",
    project_description = "Project Description",
    project_type = "Vector")

To create a Video Project and set the frame rate:

sa.create_project(
    project_name = "Project Name",
    project_description = "Project Description",
    project_type = "Video",
    settings = [{‘attribute”: “FrameRate”, “value”: 24}]
)

Rename project

To rename a project:

sa.rename_project(
    project = "Project Name",
    new_name = "New Project Name")

Delete project

To delete a project:

sa.delete_project(project = "Project Name")

Clone project

To clone an existing project with its setup, annotation classes, and contributors:

sa.clone_project(
    project_name = "Clone Project Name",
    from_project = "Existing Project Name",
    project_description = "Clone Project Description",
    copy_annotation_classes = True,
    copy_settings = True,
    copy_workflow = True,
    copy_contributors = False)

To clone projects with attached URLs:

sa.clone_project( 
    project_name = "New Project Name",
    from_project = "Source Project Name",
    project_description = "New Project Description", 
    copy_annotation_classes = True, 
    copy_settings = True,
    copy_contributors = False)

📘

Newly created projects will have a Not Started status.

Share project

To share a project with the project contributors:

sa.share_project(
    project = "Project Name",
    user = "[email protected]",
    user_role = "Annotator")

📘

The value of the user role field can be: Admin, Annotator, or QA.

Search project

To get the list of projects in the current team:

sa.search_projects()

To get projects by status:

superannotate.search_projects(  
  status="Completed"
)

📘

Project statuses

A project can have one of the following statuses: NotStarted, InProgress , OnHold , Completed , and
Undefined .

To get projects with the specified search string:

sa.search_projects(name = "Project Prefix")

To get the list of projects that contain at least one image that has the Completed annotations status:

sa.search_projects(
    name = "Project Prefix",
    include_complete_image_count = True)

Project settings

To get project settings:

sa.get_project_settings(project = "Project Name")

Project workflow

To get the project workflow:

sa.get_project_workflow(project = "Project Name")

Did this page help you?