Execution Package

An execution package is a directory, which name defines the package's ID. There are a few mandatory essentials and the rest is dependent on what the Build Service or a developer puts there.

Mandatory Content

Each package has to contain a package.json file. Its content is defined by the PackageMeta dataclass, which properties are:

• name: str - user-readable name
• build: datetime - timestamp when the package was built
• executed: Optional[datetime] = None - timestamp of the last package execution

Another mandatory file is script.py, which defines the logic of the package. Depending on the project, it might be generated, or hand-written. For more details, please see Main Script.

Please note: a directory without package.json (with the defined content) or script.py (content does not matter) won't be recognized as an execution package.

Usual Content

Those are directories and files generated or bundled during the build process.

• action_points.py - generated file with helper classes for simplified access to poses and joints defined by Action Points.
• data/ - contains scene.json and project.json files.
  • models/ - there is a JSON file corresponding to each Object Type with the associated collision model.
• object_types/ - contains all Object Types that are needed (referenced in the scene, directly or indirectly), there is one file per Object Type, which's filename is a snake-case form of the Object Type class name.

Please note: once a package is executed and fails, there appears a text-based traceback file providing details on the exception that happened.