Skip to content

mecfs_bio.figures.key_scripts.pull_figures

Download figures from Github, merging them with contents of the local figure directory.

Functions:

  • pull_figures –

    Download figures from Github, merging them with contents of the local figure directory.

Attributes:

logger module-attribute 

logger = get_logger()

pull_figures 

pull_figures(
    tag: str = FIGURE_GITHUB_RELEASE_TAG,
    repo_name: str = GH_REPO_NAME,
    fig_dir: Path = FIGURE_DIRECTORY,
    title: str = FIGURES_ARCHIVE_TITLE,
    use_gh_cli: bool = False,
)

Download figures from Github, merging them with contents of the local figure directory.

Source code in mecfs_bio/figures/key_scripts/pull_figures.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def pull_figures(
    tag: str = FIGURE_GITHUB_RELEASE_TAG,
    repo_name: str = GH_REPO_NAME,
    fig_dir: Path = FIGURE_DIRECTORY,
    title: str = FIGURES_ARCHIVE_TITLE,
    use_gh_cli: bool = False,
):
    """
    Download figures from Github, merging them with contents of the local figure directory.
    """
    fig_dir.mkdir(parents=True, exist_ok=True)

    if use_gh_cli and not does_release_exist(repo_name=repo_name, release_tag=tag):
        logger.debug(
            f"No release with the tag '{tag}' exists in repository {repo_name}.  Nothing to download."
        )
        return
    with tempfile.TemporaryDirectory() as tmpdir:
        staging_dir = Path(tmpdir)
        logger.debug(f"Downloading {tag} to {staging_dir}")
        if use_gh_cli:
            download_release_to_dir(
                release_tag=tag,
                dir_path=staging_dir,
                repo_name=repo_name,
            )
        else:
            download_release_to_dir_no_auth(
                release_tag=tag,
                repo_name=repo_name,
                title=title,
                dir_path=staging_dir,
            )

        logger.debug("download complete")
        logger.debug(
            "Overlaying existing figures on downloaded figures in staging directory."
        )
        shutil.copytree(fig_dir, staging_dir, dirs_exist_ok=True)
        logger.debug(
            f"Copying figures back from staging directory to figures directory {fig_dir}."
        )
        shutil.copytree(staging_dir, fig_dir, dirs_exist_ok=True)