git-status-checker

Yet another git status checker, in python. Because none of the bash-based ones were working on my Windows box with git-bash...

Most of this was thankfully created by @scholer. I've repurposed it a bit and beautified it.

Installation

pip install git+https://github.com/sdhutchins/git-status-checker.git will place git-status-checker in a python executables folder that should be in your path.

You can also install this by cloning this repository and installing it using pip install . in the top level directory of the repository.

What it does

• Finds git repositories given a list of base directories
• Checks if any of the repositories have uncommitted changes or need to be updated with origin, i.e. if it has changes that have not been pushed, or if origin has changes that have not been pulled.

Usage

1. Produce a list of places (base-dirs) where you have git repositories and save it to a file. It might look something like below...

   ~/Dev/src-repos
   ~/Documents/Projects
   ~/Documents/Personal_stuff/My_project_A
   

2. Run git_status_checker -f <file-with-list-of-basedirs>.

The script will walk each base-dir, searching for git repositories, then print the status for all repositories with outstanding commits or that can be pushed or fetched to/from origin.

git-status-checker help message

$ git-status-checker -h
usage: git-status-checker [-h] [--verbose] [--testing] [--loglevel LOGLEVEL]
                          [--recursive] [--no-recursive] [--followlinks]
                          [--no-followlinks] [--ignore-untracked]
                          [--check-fetch] [--wait] [--config CONFIG]
                          [--dirfile DIRFILE [DIRFILE ...]]
                          [--ignorefile IGNOREFILE]
                          [basedir [basedir ...]]

Git status checker script.

positional arguments:
  basedir               One or more base directories to scan. A directory can
                        be either (a) a git repository, or (b) a directory
                        containing one or more git repositories. Basically it
                        just scans recursively, considering all directories
                        with a '.git' subfolder a git repository.

optional arguments:
  -h, --help            show this help message and exit
  --verbose, -v         Increase verbosity.
  --testing             Run app in simple test mode.
  --loglevel LOGLEVEL   Set logging output threshold level.
  --recursive           Scan the given basedirs recursively. This is the
                        default.
  --no-recursive        Disable recursive scanning. Any 'basedir' must be a
                        git repository.
  --followlinks         Follow symbolic links when walking/scanning the
                        basedirs.
  --no-followlinks
  --ignore-untracked    Ignore untracked files.
  --check-fetch         Check if origin has changes that can be fetched. This
                        is disabled by default, since it requires making a lot
                        of remote requests which could be expensive.
  --wait                If changes are found, wait for input before
                        continuing. This is typically used to prevent the
                        command prompt from closing when executing as e.g. a
                        scheduled task.
  --config CONFIG, -c CONFIG
                        Instead of providing command line arguments at the
                        command line, you can write arguments in a yaml file
                        (as a dictionary).
  --dirfile DIRFILE [DIRFILE ...], -f DIRFILE [DIRFILE ...]
                        Instead of listing basedirs on the command line, you
                        can list them in a file.
  --ignorefile IGNOREFILE
                        File with directories to ignore (glob patterns). Note:
                        Basedirs are NEVER ignored by glob patterns in
                        ignorefile.

Other usage options

The script provides for a range of choices based on how you use it:

• You can provide base-dirs directly at the command line
• You can use multiple base-dirs-files.
• You can provide a --config file with command line args (if you don't want to specify them on the command line).
• You can use --no-recursive command line argument to disable recursive walking (it is then assumed that all "basedirs" are git repositories).
• If --ignorefile is not given but the current directory contains a file ".git_checker_ignore", this is used as ignorefile. (Similar to how git automatically ignores files in .gitignore).

Notes:

The way I've set my stuf up is that I have a .git_checker_ignore in my main "repository" folder, ~/Dev/src-repos/, which lists all non-git repositories/folders. (I have more git repositories than non-git folders, so this is easiest for me). I then simply run: python <path to git_status_checker.py> --ignore-untracked ~/Dev/src-repos

Oh, and yes, you can use ~ and * to specify files, even on Windows.