Need help with pydriller?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

ishepard
435 Stars 79 Forks Apache License 2.0 636 Commits 6 Opened issues

Description

Python Framework to analyse Git repositories

Services available

!
?

Need anything else?

Contributors list

# 111,512
Shell
softwar...
Git
R
439 commits
# 21,017
Git
python-...
python3
ml
49 commits
# 82,009
Java
Shell
test-fr...
twisted
16 commits
# 136,405
softwar...
Python
Git
python3
16 commits
# 58,651
casperj...
phantom...
Rust
Telegra...
6 commits
# 60,865
gae
Angular
TypeScr...
GitHub
4 commits
# 527,479
Java
Shell
softwar...
Git
3 commits
# 521,037
Python
softwar...
Git
python-...
3 commits
# 560,041
Python
softwar...
Git
python-...
2 commits
# 568,923
Python
softwar...
Git
python-...
2 commits
# 121,639
Groovy
jwt-aut...
jwt-tok...
Git
2 commits
# 621,984
Python
softwar...
Git
python-...
1 commit
# 11,594
cython
Shell
python-...
python-...
1 commit
# 632,694
Python
softwar...
Git
python-...
1 commit

Build Status Documentation Status codecov Downloads Language grade: Python

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.

Alt Text

Table of contents

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 pydriller and the requirements:

> python setup.py install

to run the tests (using pytest):

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

TUTORIAL

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

How to contribute

Fork the project and follow the instructions on how to get started with source code. I tend to not accept a Pull Request without tests, so:

  • unzip the
    test-repos.zip
    zip file
  • inside you will find many "small repositories" that I manually created to test PyDriller. Choose the one you prefer the most, and test your feature (check the tests I have already written, you'll find inspiration there)
  • if you do not find a repository that is suitable to test your feature, create a new one. Be careful: if you create a new one, do not forget to upload a new zip file
    test-repos.zip
    that includes your new repository, otherwise the tests will fail.

License

This software is licensed under the Apache 2.0 License.

This project has received funding from the European Unions’ Horizon 2020 research and innovation programme under the Marie Sklodowska-Curie grant agreement No. 642954.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.