Metadata-Version: 1.1
Name: Repo-Scout
Version: 1.0.0
Summary: Searches for a file in a VCS
Home-page: https://github.com/Parcks/Repo-Scout
Author: JValck
Author-email: parcks@setarit.com
License: GPLv2
Description: |Repo scout| # Repo-Scout Searches for a file in a VCS
        
        --------------
        
        Usage
        -----
        
        Within a script
        ~~~~~~~~~~~~~~~
        
        .. code:: python
        
            >>> from service.repo_scout import RepoScout
            >>> scout = RepoScout('GitHub')
            >>> scout.find('Parcks','plugins','Laravel.ppl')
            u'https://raw.githubusercontent.com/Parcks/plugins/master/debian/Laravel.ppl'
        
        From the CLI
        ~~~~~~~~~~~~
        
        Parameters
        ^^^^^^^^^^
        
        .. code:: sh
        
              -h, --help           show this help message and exit
              -p, --provider PROV  The name of the VCS provider (Default: GitHub)
              -o, --owner OWNER    The name of the owner of the repository
              -n, --name NAME      The name of the repository to search in
              -m, --method METHOD  Indicates if the file should be searched in a directory
                                   or just retrieve the first occurrence (Default: First)
              -f, --file FILE      The name of the file to find
              -d, --directory DIR  The path in the repository where the file should be
                                   searched
        
        Example
        ^^^^^^^
        
        Find first occurrence
        '''''''''''''''''''''
        
        .. code:: sh
        
            jvalck@Setarit-DTP:~/repo_scout$ python main.py -o Parcks -n plugins -f Laravel.ppl
            https://raw.githubusercontent.com/Parcks/plugins/master/debian/Laravel.ppl
        
        Find in directory
        '''''''''''''''''
        
        -  Example 1: One level deep
        
           .. code:: sh
        
               jvalck@Setarit-DTP:~/repo_scout$ rscout -o Parcks -n plugins -f Laravel.ppl -m InDirectory -d debian
               https://raw.githubusercontent.com/Parcks/plugins/master/debian/Laravel.ppl
        
        -  Example 2: two levels deep
        
           .. code:: sh
        
               jvalck@Setarit-DTP:~/repo_scout$ rscout -o Parcks -n core -f user_input.py -m InDirectory -d src/cli
               https://raw.githubusercontent.com/Parcks/core/master/src/cli/user_input.py
        
        .. |Repo scout| image:: RepoScout.png
        
        
Keywords: Parcks API Scout Find Repository
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
