cmipcite.cli

Command-line interface

Functions:

Name	Description
cli	Entrypoint for the command-line interface
get	Generate citations from CMIP files or tracking IDs or PIDs
version_callback	If requested, print the version string and exit

cli

cli(
    version: Annotated[
        Optional[bool],
        Option(
            --version,
            help="Print the version number and exit",
            callback=version_callback,
            is_eager=True,
        ),
    ] = None,
) -> None

Entrypoint for the command-line interface

Source code in src/cmipcite/cli/__init__.py

@app.callback()
def cli(
    version: Annotated[
        Optional[bool],
        typer.Option(
            "--version",
            help="Print the version number and exit",
            callback=version_callback,
            is_eager=True,
        ),
    ] = None,
) -> None:
    """
    Entrypoint for the command-line interface
    """

get

get(
    in_values: Annotated[
        list[str],
        Argument(
            help="Tracking IDs, PIDs or file paths for which to generate citations."
        ),
    ],
    out_path: Annotated[
        Union[Path, None],
        Option(
            help="Path in which to write the output. If not provided, it is printed."
        ),
    ] = None,
    format: Annotated[
        FormatOption,
        Option(
            help="Format in which to retrieve the citations."
        ),
    ] = TEXT,
    author_list_style: Annotated[
        AuthorListStyle,
        Option(
            help="Whether the author list should be long (all names) or short (et al.)."
        ),
    ] = LONG,
    doi_granularity: Annotated[
        DOIGranularity,
        Option(
            help="Desired granularity of the retrieved DOIs."
        ),
    ] = MODEL,
    multi_dataset_handling: Annotated[
        Optional[MultiDatasetHandlingStrategy],
        Option(
            help="Strategy to use when a given ID or file belongs to multiple datasets."
        ),
    ] = None,
    handle_server_url: Annotated[
        str,
        Option(
            help="URL of the server to use for handling tracking IDs i.e. handles"
        ),
    ] = "http://hdl.handle.net/",
) -> None

Generate citations from CMIP files or tracking IDs or PIDs

Source code in src/cmipcite/cli/__init__.py

@app.command(name="get")
def get(  # noqa: PLR0913
    in_values: Annotated[
        list[str],
        typer.Argument(
            help="Tracking IDs, PIDs or file paths for which to generate citations."
        ),
    ],
    out_path: Annotated[
        Union[Path, None],
        typer.Option(
            help="Path in which to write the output. If not provided, it is printed."
        ),
    ] = None,
    format: Annotated[
        FormatOption,
        typer.Option(help="Format in which to retrieve the citations."),
    ] = FormatOption.TEXT,
    author_list_style: Annotated[
        AuthorListStyle,
        typer.Option(
            help="Whether the author list should be long (all names) or short (et al.)."
        ),
    ] = AuthorListStyle.LONG,
    doi_granularity: Annotated[
        DOIGranularity,
        typer.Option(help="Desired granularity of the retrieved DOIs."),
    ] = DOIGranularity.MODEL,
    multi_dataset_handling: Annotated[
        Optional[MultiDatasetHandlingStrategy],
        typer.Option(
            help="Strategy to use when a given ID or file belongs to multiple datasets."
        ),
    ] = None,
    handle_server_url: Annotated[
        str,
        typer.Option(
            help="URL of the server to use for handling tracking IDs i.e. handles"
        ),
    ] = "http://hdl.handle.net/",
) -> None:
    """
    Generate citations from CMIP files or tracking IDs or PIDs
    """
    get_citations_kwargs = translate_get_args_to_get_citations_kwargs(
        format=format,
        author_list_style=author_list_style,
        handle_server_url=handle_server_url,
    )

    try:
        citations = get_citations(
            ids_or_paths=in_values,
            doi_granularity=doi_granularity,
            multi_dataset_handling=multi_dataset_handling,
            **get_citations_kwargs,
        )

    except MultipleDatasetMemberError as exc:
        msg = (
            "One of your input values is a member of more than one dataset. "
            "You can resolve this by passing a value for the "
            "`--multi-dataset-handling` option. "
            "In most cases, passing `--multi-dataset-handling latest` "
            "is what you will want "
            "(this will give you the reference to the last published dataset "
            "that includes your ID)"
        )
        raise ValueError(msg) from exc

    text = "\n\n".join(citations)

    if out_path is None:
        print(text)
    else:
        with open(out_path, "w") as fh:
            fh.write(text)

version_callback

version_callback(version: Optional[bool]) -> None

If requested, print the version string and exit

Source code in src/cmipcite/cli/__init__.py

def version_callback(version: Optional[bool]) -> None:
    """
    If requested, print the version string and exit
    """
    if version:
        print(f"cmipcite {cmipcite.__version__}")
        raise typer.Exit(code=0)