Summarize a repository

Before you begin

• Python 3.12 or later.
• Git must be installed on PATH. --repo must be an existing non-bare repository.

Set up your example

1. Save as git-repository-overview.py.
2. Open a terminal in its folder.
3. Run python "git-repository-overview.py" --help and prepare the listed input files.

This recipe uses your own local input or creates its own example output. Follow the setup steps below.

Download the ZIP, extract it, and open a terminal inside the extracted folder. The source file is git-repository-overview.py.

Run the script

python "git-repository-overview.py"

If your system uses python3 instead of python, use that command for Python examples. Keep paths containing spaces in quotes. Required inputs and optional settings are described in the code and setup steps.

What to expect

The complete script

#!/usr/bin/env python3
"""Show repository root, current branch, HEAD, and concise working-tree state."""
import argparse
import sys
import json
from pathlib import Path
import os
import subprocess
from collections import Counter
from datetime import datetime, timezone

def git(repo,*arguments,allow=(0,)):
    env=dict(os.environ,GIT_OPTIONAL_LOCKS='0',GIT_PAGER='cat',GIT_TERMINAL_PROMPT='0')
    result=subprocess.run(['git','--no-pager','--no-optional-locks','-C',str(repo),*arguments],capture_output=True,timeout=60,env=env)
    if result.returncode not in allow:
        raise RuntimeError(result.stderr.decode('utf-8','replace').strip() or f'git exited {result.returncode}')
    return result.stdout

def text(repo,*arguments,allow=(0,)):
    return git(repo,*arguments,allow=allow).decode('utf-8','replace')

def main():
    parser = argparse.ArgumentParser(description='Show repository root, current branch, HEAD, and concise working-tree state.')
    parser.add_argument("--repo",type=Path,default=Path("."))
    args = parser.parse_args()
    repo=Path(text(args.repo,"rev-parse","--show-toplevel").strip())
    
    print('Root:',repo)
    print('Branch:',text(repo,'branch','--show-current').strip() or '(detached HEAD)')
    print('HEAD:',text(repo,'rev-parse','--verify','HEAD').strip())
    print(text(repo,'status','--short','--branch'),end='')

if __name__ == '__main__':
    try:
        main()
    except (OSError, ValueError, RuntimeError) as exc:
        print(f'Error: {exc}', file=sys.stderr)
        sys.exit(1)

Open source as plain text · Download source and sample files

How it works

1. Show repository root, current branch, HEAD, and concise working-tree state.
2. Arguments are explicit and expected input errors produce a message with a nonzero exit code.
3. Results reflect your selected local data or the specific endpoint you choose; the example illustrates the result shape.

Make it your own

Adapt the task

Change status --short to --porcelain=v1 if another tool will parse the report.

Adjust presentation

Edit final print statements or json.dumps indentation to adjust the report layout. Keep input validation and exclusive-create file modes intact.

Change one setting at a time, run it again on sample data, and compare the output. The customization guide walks through this process.

If something goes wrong

Reference & next steps

• Git git-status documentation ↗

These official references explain the underlying tools. The Scriptage example and guide are original instructional content. See verification notes for what has been checked and the limits of those checks.

Copies a template for your own notes. It does not send anything.