dss.examples

Help/utility functions for the documentation and examples

Module Contents

Functions

download_examples
download_repo_snapshot	This will try to download the snapshot of repo_name (from DSS-Extensions) as a zip file, decompressing it inside target_path, renaming the resulting folder to repo_name.

API

dss.examples.download_examples(target_path: Union[pathlib.Path, str], error_if_exists=False, repo_name='dss_python')

dss.examples.download_repo_snapshot(target_path: Union[pathlib.Path, str], error_if_exists=False, repo_name='dss_python', use_version=True) → bool

This will try to download the snapshot of repo_name (from DSS-Extensions) as a zip file, decompressing it inside target_path, renaming the resulting folder to repo_name.

The file will be decompressed inside target_path first to avoid potential issues with moving across different filesystems.