gh-views 3.0.0

No project description provided

Github command-line views

@readwithai - X - blog - machine-aided-reading

Fetch (and update) information about the number of views or clones of a Github repository.

This tools requires the gh Github command-line tool which is used to handle authentication.

Motivation

It can be quite natural to host some material such as documentation, cookbooks and lists on Github. Github provides an API to query the number of views and clones a repository has received on a daily basis, with some limitations. The main limitation is that data is only retained for two weeks. gh-view, if run periodically, will collect data about the number of downloads and views of a repository and can provide both aggregates of this data such as the total number of views to date or a complete timelines of statistics.

Alternatives and prior work

This makes use of the Github REST API specifically traffic endpoints. You can use the API yourself with gh command-line client command, gh api or, indeed perform HTTP requests yourself directly or with a library after you have obtained a Github token. The gh command-line makes it very easy to authenticate with Github.

There are some repositories intended for use as github actions which store these actions. I find Github actions unwieldy and difficult to debug.

repohistory provides similar functionality through a browser GUI - it has no intructions for running locally but provides an externally hosted service. ghstats is another GUI interface but has instructions on how to run it, collects more information and provides an end-point for querying (I may have used this if I discovered it earlier).

There are tools for forward this data to splunk.

gh-view appears to be the only command-line tool for this task. My experience is that command-line tools are easier to understand, set up and debug.

Installation

Make sure you have the github command line-interface, gh, installed and that you have logged in with gh auth login

You can then install gh-views with pipx like so:

pipx install gh-views

Usage

To fetch statistics for a repository run:

gh-views talwrii/plugin-repl --fetch

This will fetch the clone and view statistics for the repository talwrii/plugin-repl.

After this you can fetch the cached statistics with:

gh-views talwrii/plugin-repl

Todays data is not not included when you run the above command as it could change. To include today's (partial) data include --fetch

To show all the repositories for which stats are collected you can run:

gh-views

To display all statistics you can run:

gh-views --all

To update all stats for tracked repositories (those for which you have collected statistics), you can run:

gh-views --fetch

You can output statistics in data format using the --json flag

gh-views talwrii/plugin-repl --json

You may wish to run this periodically for example using a systemd timer or cron job, to ensure that all data is collected.

to output a complete timeseries of statistics in JSONL format for each day you can run:

gh-views talwrii/plugin-repl --timeseries

Note that it there are e.g. no downloads for a day keys are missing from the timeseries rather than zeros.

Missing features

I have not tested this on mac or windows. The code for storing fetched may need different paths: patches for this will be quickly merged.

Support

If you found this tool particularly useful you can give me some money (maybe $3?) on my ko-fi

This will incentivise me to respond to tickets on this repository and release similar command-line tools.

About me

I am @readwithai I create tools for reading, research and agency sometimes using Obsidian.

If this sounds interesting, of you found this tool useful you might like to:

1. Follow me on X where I post about these sort of tools.
2. Look at my collection of productivity tools similar to this
3. Read about taking better notes with the note taking app, Obsidian

If you rae interested in reading and research you can follow me on my blog.