Skip to main content

github-repository-report

Generate timestamp reports for local GitHub repositories and include command output from each repository.

Requirements

  • Python 3
  • GitHub CLI (gh) installed

The script only checks that gh exists. It does not call GitHub for the timestamp report.

Usage

github-repository-report

Without repository arguments, the CLI scans your home directory for local Git repositories with GitHub remotes, prints the discovered repositories, and asks which reports to generate. You can enter a single number, a comma-separated list, a range, or all.

Generate a direct report:

github-repository-report --repo=kaizten/tools
github-repository-report --organization=kaizten --repository=tools

Useful options:

github-repository-report --root=~/workspace --output-dir=~/.github-repository-report --commit-days=30

Each selected local repository is reported after running:

./sheriff.sh

If the repository contains schemathesis.sh, the report also runs:

./schemathesis.sh

If the repository contains run-e2e.sh, the report also runs:

./run-e2e.sh

The report includes the command, exit code, standard output, and standard error for each command. If schemathesis.sh or run-e2e.sh is not found, the report records that it was skipped. It also includes commits from the last 14 days by default, with each commit's short hash, timestamp, author name, subject, and counts for files added, deleted, and changed. Commit hashes link to GitHub, subjects are limited to 50 characters in the table, and the commits section summarizes commit counts by GitHub user. Use --commit-days to choose a different number of days.

If a repository is provided directly without a discovered local path, the report records that the command was not executed and that commits are unavailable.

Reports are written to:

~/.github-repository-report/<owner>/<repository>/<owner>_<repository>_<timestamp>.md

Development

python3 -m unittest discover -s . -p 'test_*.py'
npm pack --dry-run

Publish

npm run publish:npm -- --dry-run
npm run publish:npm

Metadata

Release files for github-repository-report 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for github-repository-report 0.0.1
File Size Uploaded
github_repository_report-0.0.1.tar.gz 10.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for github-repository-report 0.0.1
File Interpreter ABI Platform
github_repository_report-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 19.0 kB

Release files / github_repository_report-0.0.1.tar.gz

Download URL github_repository_report-0.0.1.tar.gz
Size 10.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e558a5fe70b6b5aef21ee3ecbe21838b5017dff5eb84552f80579f83e895314c
BLAKE2b-256 checksum
How to use checksums
4314dfd5c4d00a124176fbae3548065afe3fffc3414a5de7b40026084db5a50b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release files / github_repository_report-0.0.1-py3-none-any.whl

Download URL github_repository_report-0.0.1-py3-none-any.whl
Size 8.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ac6f1811c5bfd6be50713784cf9d61ec335b0356871ffa78d5121bdb473430ff
BLAKE2b-256 checksum
How to use checksums
187214bdae343acf567efd19df509bbf6fad1fe35d6e906afa9ebe76b517331e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release history Release notifications | RSS feed

0.0.3

2 release files

0.0.2

2 release files

This release

0.0.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page