Skip to main content

A utility for interacting with data from git repositories as Pandas dataframes

Project description

![license](https://img.shields.io/pypi/l/Django.svg) [![Coverage Status](https://coveralls.io/repos/wdm0006/git-pandas/badge.svg?branch=master&service=github)](https://coveralls.io/github/wdm0006/git-pandas?branch=master) ![travis status](https://travis-ci.org/wdm0006/git-pandas.svg?branch=master) [![PyPI version](https://badge.fury.io/py/git-pandas.svg)](https://badge.fury.io/py/git-pandas) ![downloads](https://img.shields.io/pypi/dm/git-pandas.svg)

![Cumulative Blame](https://raw.githubusercontent.com/wdm0006/git-pandas/master/examples/img/githubblame.png)

A simple set of wrappers around gitpython for creating pandas dataframes out of git data. The project is centered around two primary objects:

  • Repository

  • ProjectDirectory

A Repository object contains a single git repo, and is used to interact with it. A ProjectDirectory references a directory in your filesystem which may have in it multiple git repositories. The subdirectories are all walked to find any child repos, and any analysis is aggregated up from all of those into a single output (pandas dataframe).

This is a pre-v1.0.0 project (just barely), so the interfaces and functionality may change.

Current functionality includes:

  • Commit history with extension and directory filtering

  • Edited files history with extension and directory filtering

  • Blame with extension and directory filtering

  • Branches

  • Tags

  • ProjectDirectory-level general information table

  • Approximate bus factor

  • Cumulative Blame as a time series

  • Github.com profile analysis via GitHubProfile object

  • Plotting helpers in utilities module

  • Punchcard dataframe and plotting utility

  • Filewise blame

  • File owner approximation

Please see examples for more detailed usage. The image above is generated using the repository object’s cumulative blame function on stravalib.

Installation

Git-pandas supports python 2.7+ and 3.3+. To install use:

pip install git-pandas

Documentation

Docs can be found here: [http://wdm0006.github.io/git-pandas/](http://wdm0006.github.io/git-pandas/)

Contributing

We are looking for contributors, so if you are interested, please review our contributor guidelines in CONTRIBUTING.md, which includes some proposed starter issues, or if you have an idea of your own, send us a pull request.

License

This is BSD licensed (see LICENSE.md)

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

git-pandas-1.0.0.tar.gz (16.8 kB view details)

Uploaded Source

File details

Details for the file git-pandas-1.0.0.tar.gz.

File metadata

  • Download URL: git-pandas-1.0.0.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for git-pandas-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8f22a4bc49ef8ab77e03232dc4526a098d2fccf853c741a96ca72252c0abb2f0
MD5 643296523169d889fe1a0171009e54b3
BLAKE2b-256 7678d7e0857e4c97f54e75ea29a064a8a051993e751db809db0fd28f028a1e70

See more details on using hashes here.

Supported by

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