diffhouse 0.2.0

Metadata extraction tool for git repositories.

diffhouse

diffhouse is a git metadata extraction tool for Python that retrieves high-quality repository information such as commit history, branches, diffs and more.

Requirements

Git 2.19 or greater.

Quick start

1. Install diffhouse with pip:

pip install diffhouse

2. Import the Repo class in Python:

from diffhouse import Repo

3. Create a Repo instance with the git repository URL as an argument. Set blobs to True to load file-level diffs as well.

Note that blobs=True greatly increases processing time, as it requires a complete clone of the repository.

r = Repo(url='https://github.com/user/name.git', blobs=True)

4. Access data through the following pandas DataFrames:

Table	Description
Repo.commits	Commit history.
Repo.branches	Branch names.
Repo.tags	Tag names.
Repo.diffs	File-level changes. Available if blobs is True.

For a full list of metadata tables and columns, see the documentation.