git-dump-diff
*************

Git diff tool that shows a tree of changed files followed by their
full content.

[image: PyPI Version][image][image: Supported Python
versions][image][image: Build Status][image][image: Documentation
Status][image][image: llms.txt - documentation for LLMs][image][image:
MIT][image][image: Coverage][image]

"git-dump-diff" is a verbose Git diagnostic tool. It shows a directory
tree of changed files and the full content of added or updated files.

Unlike a standard diff that shows only line changes, this tool lets
you see the entire file context. It is ideal for code reviews and
auditing feature branches.


Features
========

* **Visual Tree**: Shows affected files in a clear directory
  structure.

* **Full Content**: Displays the complete final state of new or
  modified files.

* **Binary Safe**: Detects and skips binary files to keep your
  terminal clean.

* **Pager Support**: Works with "less" automatically for easy
  scrolling.

* **No Dependencies**: Uses only standard Python libraries.


Prerequisites
=============

Python 3.10+


Installation
============


uv tool (recommended)
---------------------

   uv tool install git-dump-diff


pipx
----

   pipx install git-dump-diff


Usage
=====

Once installed, use the standard Git range syntax ("base..target").


Compare branches
----------------

   git dump-diff main..feature-branch


Compare commits
---------------

   git dump-diff HEAD~3..HEAD


Options
-------

* "--version": Show current version.

* "--help": Show help message.


How it works
============

Git recognizes any executable in your "PATH" starting with "git-" as a
subcommand. This package installs a "git-dump-diff" entry point,
making it available as "git dump-diff".


Tests
=====

Run the tests with pytest:

   pytest


Writing documentation
=====================

Keep the following hierarchy.

   =====
   title
   =====

   header
   ======

   sub-header
   ----------

   sub-sub-header
   ~~~~~~~~~~~~~~

   sub-sub-sub-header
   ^^^^^^^^^^^^^^^^^^

   sub-sub-sub-sub-header
   ++++++++++++++++++++++

   sub-sub-sub-sub-sub-header
   **************************


License
=======

MIT


Support
=======

For issues, visit GitHub.


Author
======

Artur Barseghyan <artur.barseghyan@gmail.com>


Project documentation
=====================

Contents:


Table of Contents
^^^^^^^^^^^^^^^^^

* git-dump-diff

  * Features

  * Prerequisites

  * Installation

    * uv tool (recommended)

    * pipx

  * Usage

    * Compare branches

    * Compare commits

    * Options

  * How it works

  * Tests

  * Writing documentation

  * License

  * Support

  * Author

  * Project documentation

* Security Policy

  * Reporting a Vulnerability

  * Supported Versions

* Contributor guidelines

  * Developer prerequisites

  * Code standards

  * Requirements

  * Virtual environment

  * Documentation

  * Testing

  * Releasing

  * Pull requests

  * GitHub Actions

  * Questions

  * Issues

* Contributor Covenant Code of Conduct

  * Our Pledge

  * Our Standards

  * Enforcement Responsibilities

  * Scope

  * Enforcement

  * Enforcement Guidelines

  * Attribution

* Release history and notes

  * 0.1.1

  * 0.1

* Package

* Indices and tables