https://github.com/christimperley/bughunter
A data mining tool for studying bugs in C programs
https://github.com/christimperley/bughunter
Last synced: over 1 year ago
JSON representation
A data mining tool for studying bugs in C programs
- Host: GitHub
- URL: https://github.com/christimperley/bughunter
- Owner: ChrisTimperley
- License: mit
- Created: 2016-05-17T10:56:37.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-30T18:50:52.000Z (about 9 years ago)
- Last Synced: 2025-01-03T19:21:03.806Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 131 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BugHunter
A simple, but capable Python script for efficiently mining Git repositories
for C-related bugs. Computes a list of all the identified bugs within the
repository, tagged with relevant meta-data, together with a directory
structure of the modified source code files, in their pre-processed form,
and the AST differences between the two versions.
Installation
============
```
python3 setup.py install
```
Usage
============
To start using BugHunter, just install the package via easy_install, using the
instructions given below, and then import the `bughunter` module into your code.
```
import bughunter
bh = BugHunter()
repo = bh.repository("https://github.com/php/php-src")
for fix in repo.fixes():
print(fix)
```
Requirements
============
At a minimum, BugHunter requires Python 3 and the `gitpython` package to operate
correctly. This package may be installed using `pip`, by executing the following
command: `pip install gitpython`. In order to pre-process files correctly, and
to generate ASTs, BugHunter also requires Docker to be installed on the machine,
and that the user is a member of the `docker` usergroup.