Skip to content

bookshelf_producer.commands.cmd_publish#

bookshelf_producer.commands.cmd_publish #

publish CLI command

cli(name, version, include_private, force) #

Build and upload a Book to the Bookshelf

Uploading a Book requires the correct AWS credentials (until an authentication scheme is introduced). At Climate Resource we use aws-vault for managing multiple sets of AWS credentials. Documentation about the different sources of authentication can be found here: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html

To ensure a reproducible build, the Book is built from a notebook in an isolated output directory. There currently isn't any functionality to upload a pre-built Book.

Source code in packages/bookshelf-producer/src/bookshelf_producer/commands/cmd_publish.py 
17
18
19
20
21
22
23
24
25
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
69
@click.command("publish", short_help="Upload a book to the bookshelf")
@click.argument("name", required=True)
@click.option(
    "--version",
    multiple=True,
    help="List of versions to run",
    required=False,
)
@click.option(
    "--include-private/--no-include-private",
    help="Run private versions. These will likely fail if the data is not available locally",
    default=False,
)
@click.option(
    "--force",
    is_flag=True,
    help="Override the existing published data",
    default=False,
)
def cli(name: str, version: tuple[str, ...], include_private: bool, force: bool) -> None:
    """
    Build and upload a Book to the Bookshelf

    Uploading a Book requires the correct AWS credentials (until an authentication
    scheme is introduced). At Climate Resource we use aws-vault for managing multiple
    sets of AWS credentials. Documentation about the different sources of authentication
    can be found here: [https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html]()

    To ensure a reproducible build, the Book is built from a notebook in an isolated
    output directory. There currently isn't any functionality to upload a pre-built Book.
    """
    if not version:
        all_versions = get_available_versions(name, include_private=include_private)
    else:
        all_versions = version

    for dataset_version in all_versions:
        with tempfile.TemporaryDirectory() as temp_dir:
            logger.info(f"Building Book in isolated environment: {temp_dir}")
            try:
                book = run_notebook(
                    name,
                    output_directory=temp_dir,
                    force=False,
                    version=dataset_version,
                )
                logger.info(f"Finish building {name}@{book.long_version()}")

                shelf = BookShelf()
                publish(shelf, book, force=force)
            except Exception as exc:
                logger.exception(f"Unable to process {name}@{dataset_version}")
                raise click.Abort() from exc