ProjectManager.archive_project#

ProjectManager.archive_project(project_name, file_path, is_archive_src_media: bool = True, is_archive_render_cache: bool = True, is_archive_proxy_media: bool = False) → bool[source]#

Archives project to provided filePath with the configuration as provided by the optional arguments

Parameters:

  • project_name (str) – project to archive

  • file_path (path) – file path to archive to

  • is_archive_src_media (bool, optional) – archive project with source media. Defaults to True.

  • is_archive_render_cache (bool, optional) – archive project with render cache. Defaults to True.

  • is_archive_proxy_media (bool, optional) – archive project with proxy media. Defaults to False.

Returns:

Returns true if archive project is successful; false otherwise

Return type:

bool