Skip to content

Latest commit

 

History

History
96 lines (56 loc) · 3.12 KB

README.md

File metadata and controls

96 lines (56 loc) · 3.12 KB
Raw

Reviewer Recommender

This project uses Python and argparse to run different algorithms on a specified GitHub project. The algorithms are RevFinder, ChRev, TurnoverRec, and Sofia.

Prerequisites

You need to have Python and pip installed on your machine. You can download Python from here and pip is included in Python 3.8 and later versions.

Installation

  1. Clone the Github-crawler repository to your local machine:

  2. Navigate to the Github-crawler directory:

cd Github-crawler

  1. Run the crawler commands to fetch the data (see help and usage in the Github-crawler):

  2. Once the data has been fetched, set the DATA_BASE_DIR environment variable to the path of the crawled-data directory in the Github-crawler repository.

export DATA_BASE_DIR=<path-to-Github-crawler>/crawled-data

  1. Navigate back to the parent directory and clone this repository to your local machine:

  2. Navigate to the project directory:

cd reviewer-recommender
  1. Install the required packages:
pip install -r requirements.txt

Usage

To run an algorithm on a GitHub project, use the following command:

python manager.py --r_owner <owner> --r_name <repo> algo-<algorithm>

Replace <owner> with the GitHub project owner's username, <repo> with the name of the repository, and <algorithm> with the name of the algorithm you want to run. The available algorithms are revFinder, chRev, turnoverRec, and sofia.

If you want to run the project without using cache, add the --no-cache argument:

python manager.py --r_owner <owner> --r_name <repo> algo-<algorithm> --no-cache

Evaluation

To evaluate the algorithms, use the following command:

python manager.py evaluate --r_owner <owner> --r_name <repo>

Replace <owner> with the GitHub project owner's username, <repo> with the name of the repository.

Data Storage

The data fetched by the Github-crawler is stored in the crawled-data directory. This directory is located in the root of the Github-crawler repository. The data is organized by GitHub project, with each project having its own subdirectory.

The DATA_BASE_DIR environment variable should be set to the path of the crawled-data directory. This allows the algorithms in this project to access the fetched data.

Logs

During the execution of the algorithms, logs are generated to provide some information about the process.

The logs are stored in the logs directory in the root of this repository.

The logs include information such as:

  • Start and end time of each algorithm execution.
  • Steps and decisions made by the algorithms.

To view the logs, navigate to the logs directory and open the desired log file. You can use any text editor to view the contents of the log files.

Built With

Authors