Skip to content

A wrapper around gitpython to produce pandas dataframes for analysis

License

Notifications You must be signed in to change notification settings

Cophy08/git-pandas

 
 

Repository files navigation

Git-Pandas

license Coverage Status travis status PyPI version downloads

Cumulative Blame

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/

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)

About

A wrapper around gitpython to produce pandas dataframes for analysis

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.4%
  • Shell 0.6%