Metadata-Version: 2.1
Name: repository-miner
Version: 0.2.0
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-reposiotry-miner/archive/0.2.0.tar.gz
Description: # radon-repository-miner
        A Python package for mining Infrastructure-as-Code software repositories.
        
        ## How to install
        
        The package can be downloaded from [PyPI](https://pypi.org/project/repository-miner/) as follows:
        
        ```pip install repository-miner```
        
        Alternatively, it can be installed from the source code with:
        
        ```
        pip install -r requirements.txt
        pip install .
        ```
        
        ## Command-line usage
        
        ```
        usage: repository-miner [-h] [-v] [--branch BRANCH] [--verbose]
                                    path_to_repo owner name dest
        
        A Python library to mine Infrastructure-as-Code based software repositories.
        
        positional arguments:
          path_to_repo     the local path to the git repository
          owner            the repository owner
          name             the repository name
          dest             destination folder for the reports
        
        optional arguments:
          -h, --help       show this help message and exit
          -v, --version    show program's version number and exit
          --branch BRANCH  the repository branch to mine (default: master)
          --verbose        show log
        ```
        
        **Important!** The package requires a personal access token to access the GraphQL APIs. See how to get one [here](https://github.com/settings/tokens).
        Once generated, paste the token in the input field when asked. For example:
        
        ```
        repository-miner path/to/the/cloned/repository radon-h2020 radon-repository-miner .
        
        Github access token: <paste your token here>
        ```  
        
        You may want to avoid the previous step. If so, add ```GITHUB_ACCESS_TOKEN=<paste here your token>``` to the environment variables.
        
        
        ### Output
        Running the tool from command-line generates an HTML report accessible at *\<dest\>/report.html*.
        
        
        ## Current release
        ## [0.2.0]
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
