Skip to content

cli

dir()

Print the directory mkreports uses by default to the screen.

Source code in mkreports/cli.py 
14
15
16
17
@app.command()
def dir():
    """Print the directory mkreports uses by default to the screen."""
    typer.echo(f"{get_mkreports_dir()}")

new(mkreports_dir=typer.Argument(None, help='mkreports directory to use to serve out of. If not given, then default directory as shown by `dir` subcommand used.'), name=typer.Option('Mkreports report', help='Name of the report'))

Create a new mkreports report.

Source code in mkreports/cli.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
@app.command()
def new(
    mkreports_dir: Optional[Path] = typer.Argument(
        None,
        help="mkreports directory to use to serve out of. If not given, then default directory as shown by `dir` subcommand used.",
    ),
    name: str = typer.Option("Mkreports report", help="Name of the report"),
):
    """Create a new mkreports report."""
    if mkreports_dir is None:
        mkreports_dir = get_mkreports_dir()
    try:
        Report.create(mkreports_dir, report_name=name)
        typer.echo(f"Create report in {mkreports_dir}")
    except:
        if mkreports_dir.is_dir():
            typer.echo(
                f"Directory already exists and could not create report in {mkreports_dir}"
            )
        else:
            typer.echo(f"Could not create report in {mkreports_dir}")

serve(mkreports_dir=typer.Argument(None, help='mkreports directory to use to serve out of. If not given, then default directory as shown by `dir` subcommand used.'), mkdocs_args=typer.Argument(None, help='All values passed directly to `mkdocs serve` function. Use `--` to separate options for mkdocs from options for the core command.'))

Serve an mkdocs site.

This is a convenience wrapper for mkdocs serve that changes to the correct directory and invokes mkdocs serve, restarting when error occur.

Source code in mkreports/cli.py 
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
@app.command()
def serve(
    mkreports_dir: Optional[Path] = typer.Argument(
        None,
        help="mkreports directory to use to serve out of. If not given, then default directory as shown by `dir` subcommand used.",
    ),
    mkdocs_args: List[str] = typer.Argument(
        None,
        help="All values passed directly to `mkdocs serve` function. Use `--` to separate options for mkdocs from options for the core command.",
    ),
):
    """
    Serve an mkdocs site.

    This is a convenience wrapper for `mkdocs serve` that changes to the correct directory
    and invokes `mkdocs serve`, restarting when error occur.
    """
    if mkreports_dir is None:
        mkreports_dir = get_mkreports_dir()

    mkdocs_cmd = f"cd {mkreports_dir} && mkdocs serve {' '.join(mkdocs_args)}"

    # we first do an initial start; this has to run without error
    # for a few seconds before the automatic restart is initiated
    if not mkreports_dir.is_dir():
        typer.echo(
            f"Directory {mkreports_dir} does not exist or is not a directory.", err=True
        )
        raise typer.Exit(1)

    # we do the initial run; this needs to last for at least 5 seconds;
    # if an error occurs in this time, we do not restart
    time_first_start = datetime.now()
    try:
        while True:
            try:
                typer.echo(f"Run bash command: {mkdocs_cmd}")
                cmd = sh.bash("-c", mkdocs_cmd, _out=_process_out, _err=_process_err, _bg=True)  # type: ignore
                cmd.wait()
            except sh.ErrorReturnCode:
                time_error = datetime.now()

                elapsed_time = time_error - time_first_start
                if elapsed_time.total_seconds() <= 5:
                    typer.echo("Error occured before 5 seconds. Exiting.")
                    raise typer.Exit(2)
                else:
                    typer.echo("Restarting!")

    except KeyboardInterrupt:
        try:
            if cmd.is_alive():  # type: ignore
                cmd.terminate()  # type: ignore
                typer.echo("\nTerminated mkdocs serve")
            typer.Abort()
        except UnboundLocalError:
            pass