Skip to main content

Tool built with python to summarize git diff into an Excel file.

Project description

Tool built with python to summarize git diff.

Motivation

This tool can put diffs into Excel.

Installation

This tool is installed with pip:

$ pip install pgdf

Usage

Go to the Git repository directory, then:

$ pgdf 09c03f56 93496ef3
$ pgdf 09c03f56 93496ef3 dir/path file/path
$ pgdf origin/main feature/something

It generates an Excel file that contains summary of the differences.

Excel Format

The output excel file contains two sheets, Summary and Diff.

Summary

The summary sheet contains the summary of the differences. It is same as the result of git diff --stats for the specified commits.

Diff

The diff sheet contains the differences of the markdown files. It is something like git diff for the specified commits, but it also contains line numbers and commit short logs as follows.

Diff 29485862 4959956a

diff –git a/file_a.txt b/file_a.txt

index 29485862..4959956a 100644

— a/file_a.txt

+++ b/file_a.txt

@@ -1,3 +1,3 @@

33

33

text 1

34

34

text 2

29485862

User 1

2024-01-01 …

old comment

35

- old text 3

4959956a

User 2

2024-01-01 …

new comment

35

+ new text 3

36

36

text 4

37

37

text 5

PyPI package

https://pypi.org/project/pgdf/

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

pgdf-0.0.1.0.tar.gz (9.5 kB view hashes)

Uploaded Source

Supported by

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