Welcome to repominer’s documentation!

RepoMiner is a Python package and CLI for mining Infrastructure-as-Code software repositories. It can be extended to support other languages (e.g., Python), though.

Installation

pip install repository-miner

Quick Usage

Python

from repominer.metrics.ansible import AnsibleMetricsExtractor
from repominer.mining.ansible import AnsibleMiner

miner = AnsibleMiner('https://github.com/owner/repository')
miner.get_fixing_commits_from_closed_issues()
miner.get_fixing_commits_from_commits_message()
miner.get_fixing_files()
failure_prone_files = miner.label()

metrics_extractor = AnsibleMetricsExtractor()
metrics_extractor.extract(failure_prone_files)
print(metrics_extractor.dataset.head())

Command-Line

usage: repo-miner [-h] [-v] {mine,extract-metrics} ...

A Python library and command-line tool to mine Infrastructure-as-Code based software repositories.

positional arguments:
  {mine,extract-metrics}
    mine                Mine fixing- and clean- files
    extract-metrics     Extract metrics from the mined files

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit

Contents:

• CLI Reference
  • Mining using Command-Line
    • Examples
  • Metrics extraction using Command-Line
    • Examples
• APIs Reference
  • Miners
    • Base Miner
    • Ansible Miner
    • Tosca Miner
  • Bug-Fixing Commits Classifiers
    • Base Classifier
    • Ansible Classifier
  • Metrics
    • Base Metrics Extractor
    • Ansible Metrics Extractor
    • Tosca Metrics Extractor
• Help Needed

Indices and tables

• Index

• Module Index

• Search Page