PyDriller is a Python framework that helps developers on mining software repositories. With PyDriller you can easily extract information from any Git repository, such as commits, developers, modifications, diffs, and source codes, and quickly export to CSV files.
Very few! Just:
- Python3
- Git
The list of dependencies are listed in ./requirements.txt, however the installer takes care of installing them for you.
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.
If you like to clone from source, you can do it with very simple steps.
It is suggested to make use of virtualenv
:
> virtualenv -p python3 venv
> source venv/bin/activate
Clone the repo:
> git clone https://github.com/ishepard/pydriller.git
install the requirements:
> cd pydriller
> pip install -r requirements
> unzip test-repos.zip
and run the tests using pytest:
> pytest
For information on how to use PyDriller, refer to the ufficial documentation:
- http://pydriller.readthedocs.io
- a video on Youtube: https://www.youtube.com/watch?v=7Oui4bP9eN8
or have a look at our example folder.
For now, cite the repository.
This software is licensed under the Apache 2.0 License.