Skip to main content

Metadata extraction tool for git repositories.

Project description

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.20 and Python 3.10 or greater required.

Quick start

  1. Install diffhouse with pip:
pip install diffhouse
  1. Import the Repo class in Python:
from diffhouse import Repo
  1. 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)
  1. 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 objects and table columns, see the documentation.

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

diffhouse-0.2.6.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

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

diffhouse-0.2.6-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file diffhouse-0.2.6.tar.gz.

File metadata

  • Download URL: diffhouse-0.2.6.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for diffhouse-0.2.6.tar.gz
Algorithm Hash digest
SHA256 bdf5e59f548d19cb5140064a8d7e670e356602363b90824b68e37cc6afb04920
MD5 24bd22792eb2461fa9f151e2565cfa06
BLAKE2b-256 dc1af83e647c175a673c997a5f1b00bd969a427c25d19834220705f7ffc1979f

See more details on using hashes here.

File details

Details for the file diffhouse-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: diffhouse-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for diffhouse-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 52133344d97d4c2c58abcfdd6ab1a5cb68e1525469cf73f34084cc85d301cb87
MD5 3bc933eebc9b7ba31d18e83d6fa172ff
BLAKE2b-256 d6d8d53fe4650039471aad4782688c9dadce48bce4b1cd8695a0e71e466cee19

See more details on using hashes here.

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