Skip to content

main

main 

main(
    dataset_dir: Annotated[
        Path,
        Argument(
            exists=True,
            file_okay=False,
            dir_okay=True,
            readable=True,
            help="Path to directory with *.timeline.*.json files",
        ),
    ],
)

Run the GitHub Insights-like web application visualizing changesets.

Starts the web dashboard, listening on port 7860, at http://localhost:7860/. It is powered by the Panel framework and served with the Bokeh server.

You need to provide the path to the directory with *.timeline.*.json files, generated with diff-gather-stats script, which in turn creates those JSON files based on a set of JSON files created by diff-annotate.

To go to the "Author Statistics" page, at http://localhost:7860/author, click on the name and email of one of the contributors in the per-contributor grid below the main plot on the "Contributors' Graph" page (the default page).

Graphs configuration is hidden in the hamburger menu in the top right corner (on both pages).

Source code in src/diffinsights_web/main.py 
15
16
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
@app.command()
def main(
    dataset_dir: Annotated[
        Path,
        typer.Argument(
            exists=True,
            file_okay=False,
            dir_okay=True,
            readable=True,
            help="Path to directory with *.timeline.*.json files",
        )
    ],
):
    """Run the GitHub Insights-like web application visualizing changesets.

    Starts the web dashboard, listening on port 7860, at http://localhost:7860/.
    It is powered by the Panel framework and served with the Bokeh server.

    You need to provide the path to the directory with `*.timeline.*.json` files,
    generated with `diff-gather-stats` script, which in turn creates those JSON
    files based on a set of JSON files created by `diff-annotate`.

    To go to the "Author Statistics" page, at http://localhost:7860/author,
    click on the name and email of one of the contributors in the per-contributor
    grid below the main plot on the "Contributors' Graph" page (the default page).

    Graphs configuration is hidden in the hamburger menu
    in the top right corner (on both pages).
    """
    datastore.DATASET_DIR = str(dataset_dir)

    # NOTE: imports must be after setting diffinsights_web.datastore.DATASET_DIR
    from diffinsights_web.apps.author import template as author_app
    from diffinsights_web.apps.contributors import template as contributors_app

    # run the application in a development server
    pn.serve(
        {
            '': contributors_app,
            'contributors': contributors_app,
            'author': author_app,
        },
        address="0.0.0.0",
        port=7860,
        websocket_origin="*",
        show=False,

        # NOTE: missing equivalents of --reuse-sessions, --global-loading-spinner
    )