A tool to mine IaC-based repositories.
Project description
radon-repository-miner
A Python package for mining Infrastructure-as-Code software repositories.
How to install
From PyPI:
pip install repository-miner
From source code:
git clone https://github.com/radon-h2020/radon-repository-miner.git
cd radon-repository-miner
pip install -r requirements.txt
pip install .
Important: to properly use the FixingCommitCategorized, install the spaCy statistical model en_core_web_sm
:
python -m spacy download en_core_web_sm
How to test
pip install pytest
unzip test_data.zip -d .
pytest
How to build Docker container
docker build --tag repo-miner:latest .
How to run Docker container
First create or define a directory to mount inside the Docker container to access the results once generated.
For the sake of the example let's use /tmp/repo-miner
.
Mine
Using the github
argument:
docker run -v /tmp/repo-miner:/app -e GITHUB_ACCESS_TOKEN=$GITHUB_ACCESS_TOKEN repo-miner:latest repo-miner mine failure-prone-files github ansible adriagalin/ansible.motd . --verbose
Using the gitlab
argument:
docker run -v /tmp/repo-miner:/app -e GITLAB_ACCESS_TOKEN=$GITLAB_ACCESS_TOKEN repo-miner:latest repo-miner mine failure-prone-files gitlab ansible adriagalin/ansible.motd . --verbose
Extract metrics
docker run -v /tmp/repo-miner:/app repo-miner:latest repo-miner extract-metrics https://github.com/<owner>/<repository>.git ./failure-prone-files.json ansible all release . --verbose
CHANGELOG
See the CHANGELOG for information about the release history.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for repository_miner-0.9.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 909ca45a084f57f7fd28c2f9586ef174302c243450641123a9138a7fac514205 |
|
MD5 | cee69f605b5f3e73ea93225482d8f2d5 |
|
BLAKE2b-256 | 6ed66af3485ad8c5ad3d2c90f8a330441936d7c0f1b9d23ed1478bbd31754c46 |