Skip to main content

Parser for git log --raw

Project description

glrp - git log raw parser

A parser for parsing the output of git log, specifically with the --format=raw option. This is the intended git command to use:

git log -p --format=raw --show-signature --stat

Simply pipe the output:

git log -p --format=raw --show-signature --stat | glrp --pretty

The CLI outputs one JSON object per commit. Each JSON object is on one line, they are separated by newlines. This format is sometimes referred to as JSONL or JSON lines format. With --pretty, each JSON object is indented to be more readable and printed across multiple lines. (But then it is no longer JSONL, strictly speaking).

Why?

The above command provides a lot of useful information about each git commit, which we can analyze, including:

  • Commit message
  • Diff
  • Author name and email
  • Committer name and email
  • Timestamps
  • GPG signature

On its own, git log does not output its information in a format which is easy for other programs to use. So, this tool parses the output and turns it into JSON which is more easy to analyze and check.

Installation

pipx install glrp

Usage

Using it is simple. Run it inside a git repo:

glrp .

Or you can pipe git log output to it:

git log -p --format=raw --show-signature --stat | glrp --output-dir=./out/

Or perhaps a bit more realistic:

git clone https://github.com/cfengine/core
(cd core && git log -p --format=raw --show-signature --stat HEAD~500..HEAD 2>/dev/null) | glrp

(Clone CFEngine core, start subshell which enters the subdirectory and runs git log for the past 500 commits).

Specifying input

By default, glrp parses standard input, and outputs to stdout. To take input from somewhere else, supply a filename:

glrp some_file.jsonl

The file, some_file.jsonl is opened and read, its content is used instead of standard input. You can also specify the path to a folder:

glrp some_dir/

The glrp tool will run the git log command (git log -p --format=raw --show-signature --stat) inside that folder. Output from the git command will be parsed instead of standard input.

Specifying output

You can use shell redirection to print to file instead of standard output:

glrp . > output.jsonl

Compare

If you want to compare the stats for 2 branches, use the --compare flag:

glrp . --compare main,feature...main

(This assumes that feature is based on main).

Alternately, you can compare commit ranges:

glrp . --compare main~5,main...main~5

This generates a .before.json and .after.json file, which can be used to compare those 2 ranges.

You can also specify a date for the comparison:

glrp . --compare 2025-07-01

As above, this will call git log twice, but instead of specifying the ref / range, it will use the --since and --until flags. It also supports relative dates, same as those git flags;

glrp . --compare 5d

Combine

You can combine summary files using the --combine flag:

glrp --combine .before.json,.after.json > combined.json

This is useful for example after generating summaries for different repos. You can use it to create a global summary of all commits in all repos of an organization.

Trusted GPG fingerprints

The summarize functionality can be used to classify different kinds of signed commits. Use the --trusted flag to give a path to a folder containing trusted gpg key fingerprints.

glrp --summarize . --trusted ~/.password-store/.pub-keys/

Important notes

Note: This tool is meant specifically as a parser for the command shown above, not as a generic parser for all the different things git log can output.

Warning: The output of --show-signature varies depending on which keys you have imported / trusted in your installation of GPG. Make sure you import the correct GPG keys beforehand, and don't expect output to be identical across different machines with different GPG states.

Warning: Consider this a best-effort, "lossy" parsing. Commits may contain non utf-8 characters, to avoid "crashing", we skip these, replacing them with question marks. Thus, the parsing is lossy, don't expect all the information to be there. This tool can be used for searching / analyzing commits, but don't use it as some kind of backup tool where you expect to have the ability to "reconstruct" the commits and repo entirely.

Details

For details on how the parsing works, try running with --debug and look at the resulting ./debug/ folder. Also, see the comments in the source code; ./glrp/internal_parser.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

glrp-0.3.2.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

glrp-0.3.2-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file glrp-0.3.2.tar.gz.

File metadata

  • Download URL: glrp-0.3.2.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for glrp-0.3.2.tar.gz
Algorithm Hash digest
SHA256 276014002c0313023ae732d998b1b51f669fe70641dd957debe60a392fa08fef
MD5 a338ed3c0e8f2e2576dca34d798bb8c5
BLAKE2b-256 6d3df82ebd247598dad9cb507314c2a3c8c57db01cf5009b0a34e2a7a936ff74

See more details on using hashes here.

Provenance

The following attestation bundles were made for glrp-0.3.2.tar.gz:

Publisher: python-publish.yml on olehermanse/glrp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file glrp-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: glrp-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 17.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for glrp-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cba2dd2f79d32a1aec1606634031af59b573121fed8fdf26bf7fec91ec666336
MD5 70ecfb9d5ad450393045a028cb843ab2
BLAKE2b-256 7ddf3035a45c4d20349658a29b6b9f4cbe5f11c94b94453ac57fb99bdabb5b75

See more details on using hashes here.

Provenance

The following attestation bundles were made for glrp-0.3.2-py3-none-any.whl:

Publisher: python-publish.yml on olehermanse/glrp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page