Metadata-Version: 2.1
Name: repository-miner
Version: 0.9.5
Summary: A tool to mine IaC-based repositories.
Home-page: https://github.com/radon-h2020/radon-repository-miner
Author: Stefano Dalla Palma
Author-email: stefano.dallapalma0@gmail.com
Maintainer: Stefano Dalla Palma
License: UNKNOWN
Download-URL: https://github.com/radon-h2020/radon-repository-miner/archive/0.9.5.tar.gz
Description: ![Build](https://github.com/radon-h2020/radon-repository-miner/workflows/Build/badge.svg)
        ![Documentation](https://github.com/radon-h2020/radon-repository-miner/workflows/Documentation/badge.svg)
        ![lgtm](https://img.shields.io/lgtm/grade/python/github/radon-h2020/radon-repository-miner)
        ![pypi-version](https://img.shields.io/pypi/v/repository-miner)
        ![pypi-status](https://img.shields.io/pypi/status/repository-miner)
        ![release-date](https://img.shields.io/github/release-date/radon-h2020/radon-repository-miner)
        ![python-version](https://img.shields.io/pypi/pyversions/repository-miner)
        
        # radon-repository-miner
        A Python package for mining Infrastructure-as-Code software repositories.
        
        # How to install
        
        From [PyPI](https://pypi.org/project/repository-miner/):
        
        ```pip install repository-miner```
        
        From source code:
        
        ```text
        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
        
        ```text
        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](CHANGELOG.md) for information about the release history.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown
