Menu
Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version
Publication date

Mar 9, 2022

Confidentiality
Public
Reactions
1
Share

ScenarioArchiveZipper

Creates a single tar archive containing a scenario and its selected resources.

Archive format::

scenario_archive.tar
├── scenario_info.json          # ScenarioArchivePackage
└── resources/
    ├── <resource_id_1>.tar     # Individual resource tar (ResourceZipper format)
    ├── <resource_id_2>.tar
    └── ...
Attributes
COMPRESS_FORMATS: dict
Functions
__init__

Initialize self. See help(type(self)) for accurate signature.

scenario_id : str
resource_mode : str
user : User
compress_format : str - tar
zip

Export the scenario and selected resources into a single tar archive.

Return type : str
unzip @classmethod

Extract a scenario archive and return its metadata and resource tar paths.

archive_path : str
Path to the scenario archive tar file.
Return type : tuple
Shine Logo
Technical bricks to reuse or customize

Have you developed a brick?

Share it to accelerate projects for the entire community.