/ Framework

Python framework that helps developers in analyzing Git repositories

Python framework that helps developers in analyzing Git repositories

PyDriller

PyDriller is a Python framework that helps developers in analyzing Git repositories. With PyDriller you can easily extract information such as commits, developers, modifications, diffs, and source codes.

PyDriller

How to cite PyDriller

@inproceedings{Spadini2018,
	address = {New York, New York, USA},
	author = {Spadini, Davide and Aniche, Maur\'{i}cio and Bacchelli, Alberto},
	booktitle = {Proceedings of the 2018 26th ACM Joint Meeting on European Software Engineering Conference and Symposium on the Foundations of Software Engineering - ESEC/FSE 2018},
	doi = {10.1145/3236024.3264598},
	isbn = {9781450355735},
	keywords = {2018,acm reference format,and alberto bacchelli,davide spadini,git,gitpython,maur\'{i}cio aniche,mining software repositories,pydriller,python},
	pages = {908--911},
	publisher = {ACM Press},
	title = {{PyDriller: Python framework for mining software repositories}},
	url = {http://dl.acm.org/citation.cfm?doid=3236024.3264598},
	year = {2018}
}

REQUIREMENTS

Very few! Just:

  • Python3
  • Git

The list of dependencies is shown in ./requirements.txt, however the installer takes care of installing them for you.

INSTALL

Installing PyDriller is easily done using pip. Assuming it is installed, just run the following from the command-line:

pip install pydriller

This will also install the necessary dependencies.

SOURCE CODE

If you like to clone from source, you can do it with very simple steps.
First, clone the repo:

> git clone https://github.com/ishepard/pydriller.git
> cd pydriller

OPTIONAL

It is suggested to make use of virtualenv:

> virtualenv -p python3 venv
> source venv/bin/activate

INSTALL THE REQUIREMENTS AND RUN THE TESTS

Install the requirements:

> pip install -r requirements.txt

to run the tests (using pytest):

> unzip test-repos.zip
> pip install -r test-requirements.txt
> pytest

TUTORIAL

For information on how to use PyDriller, refer to the official documentation:

or have a look at our example folder.

GitHub