Projects

Prepare to export

You can send an API request to prepare the project for the export. You can use multiple filters to specify the content of the export bundle.

export_name = sa.prepare_export(project = "Project Name")

To prepare to export specific folders from a project:

sa.prepare_export(
    project = "Project Name",
    folder_names = ["Folder 1", "Folder 2"])

To prepare to export images that have Completed and Quality Check annotation statuses:

sa.prepare_export(
    project = "Project Name",
    folder_names = ["Folder 1", "Folder 2"],
    annotation_statuses = ["Completed", "QualityCheck"])

To include original and fused images in the export:

sa.prepare_export(
    project = "Project Name",
    folder_names = ["Folder 1", "Folder 2"],
    annotation_statuses = ["Completed","QualityCheck"],
    include_fuse = True)

To prepare to export pinned images only:

sa.prepare_export(
    project = "Project Name",
    folder_names = ["Folder 1", "Folder 2"],
    annotation_statuses = ["Completed","QualityCheck"],
    include_fuse = True, 
    only_pinned = True)

List exports

To get a project's list of available exports:

exports = sa.get_exports(project = "Project Name")

To retrieve the export metadata of the list of available exports:

exports = sa.get_exports(
              project = "Project Name",
              return_metadata = True)

Download export

To download the prepared export:

sa.download_export(
    project = "Project Name",
    export = export_name, 
    folder_path = "./downloads/export")

To prepare and download an export:

superannotatecli export-project --project "Project Name" 
                                --folder "./downloads/export"
                                [--include-fuse]
                                [--disable_extract_zip_contents]
                                [--annotation-statuses Completed, QualityCheck]