Metadata-Version: 1.1
Name: cibopath
Version: 0.1.0
Summary: Search Cookiecutters on GitHub.
Home-page: https://github.com/hackebrot/cibopath
Author: Raphael Pierzina
Author-email: raphael@hackebrot.de
License: BSD
Description: ========
        Cibopath
        ========
        
        |pypi| |pyversions| |license| |travis-ci|
        
        Search `Cookiecutter`_ templates on GitHub with Python 3.5.
        
            A Cibopath can take a bite from anything and get a psychic sensation of
            what has happened to that object. The only thing it does not work on is
            beets.
        
            -- `Wikipedia: Chew Comic Book Series`_
        
        .. |pypi| image:: https://img.shields.io/pypi/v/cibopath.svg
           :target: https://pypi.python.org/pypi/cibopath
           :alt: PyPI Package
        
        .. |pyversions| image:: https://img.shields.io/pypi/pyversions/cibopath.svg
           :target: https://pypi.python.org/pypi/cibopath/
           :alt: PyPI Python Versions
        
        .. |license| image:: https://img.shields.io/pypi/l/cibopath.svg
           :target: https://pypi.python.org/pypi/cibopath
           :alt: PyPI Package License
        
        .. |travis-ci| image:: https://travis-ci.org/hackebrot/cibopath.svg?branch=master
            :target: https://travis-ci.org/hackebrot/cibopath
            :alt: See Build Status on Travis CI
        
        
        Usage
        =====
        
        .. code-block:: text
        
            Usage: cibopath [OPTIONS] COMMAND [ARGS]...
        
              Cibopath - Search Cookiecutters on GitHub.
        
            Options:
              -v, --verbose           Print debug information
              -c, --config-file PATH  Config file to hold settings
              -V, --version           Show the version and exit.
              --help                  Show this message and exit.
        
            Commands:
              config
              info
              search
              update
        
        Config
        ------
        
        First you need to `create a GitHub access token`_ for Cibopath, so it can
        authenticate with the `GitHub API v3`_. `GitHub's rate limiting`_ won't allow
        more than 60 unauthenticated requests per hour. So yeah, you definitely want to
        have a token set up as there are more than 60 featured `Cookiecutter
        templates`_.
        
        The Cibopath access token does **NOT** require any `scopes`_. Please stick to
        the defaults when creating the token (**Read-only access to public
        repositories**).
        
        Now use the CLI to store your credentials in your home directory (default
        ``~/.cibopathrc``).
        
        .. code-block:: bash
        
            $ cibopath config github.username <your-username>
            $ cibopath config github.token <your-access-token>
        
        Feel free to view the contents of the config file via:
        
        .. code-block:: bash
        
            $ cibopath -v config --list
        
        
        Update
        ------
        
        With GitHub authentication in place, you now want to fetch information about
        available Cookiecutter templates. Cibopath dumps the data as a JSON file to
        disk. You can specify the target location either via user config or CLI.
        
        Save the dump-file location to settings:
        
        .. code-block:: bash
        
            $ cibopath config templates.file ~/.cibopath/templates.json
            $ cibopath -v update
        
        Or specify it on the CLI:
        
        .. code-block:: bash
        
            $ cibopath -v update --dump-file ~/.cibopath/templates.json
        
        Please note that, albeit not required, the ``-v`` or ``--verbose`` flags are
        very useful if you want to see what Cibopath is doing under the hood.
        
        Search
        ------
        
        Once you've gathered information about Cookiecutter templates, you can use
        Cibopath to search for keywords in the templates' **README** files.
        
        Let's say you would like to know which ones support *django* and *docker*.
        
        .. code-block:: bash
        
            $ cibopath search django docker
        
        If you didn't save the ``templates.file`` earlier, you need to explicitly pass
        it to the CLI:
        
        .. code-block:: bash
        
            $ cibopath search django docker --load-file ~/.cibopath/templates.json
        
        Cibopath will show you a list of matching templates in alphabetical order along
        with their corresponding GitHub repository URL. If you feel like one of these
        templates meets your requirements for a new project, go ahead and pass the URL
        to `Cookiecutter`_ to get started.
        
        .. code-block:: bash
        
            cookiecutter-django................. https://github.com/pydanny/cookiecutter-django
            django-docker-bootstrap............. https://github.com/legios89/django-docker-bootstrap
        
        
        Info
        ----
        
        Cibopath also provides you with additional information about a given template:
        
        .. code-block:: bash
        
            $ cibopath info cookiecutter-pytest-plugin
        
        Info includes **Name**, **Author**, **Repository** as well as the **Context**,
        which will be used by `Cookiecutter`_ to generate the project.
        
        .. code-block:: text
        
            Name: cookiecutter-pytest-plugin
            Author: pytest-dev
            Repository: https://github.com/pytest-dev/cookiecutter-pytest-plugin
            Context: {
                "docs_tool": [
                    "mkdocs",
                    "sphinx",
                    "none"
                ],
                "email": "raphael@hackebrot.de",
                "full_name": "Raphael Pierzina",
                "github_username": "hackebrot",
                "license": [
                    "MIT",
                    "BSD-3",
                    "GNU GPL v3.0",
                    "Apache Software License 2.0"
                ],
                "module_name": "{{ cookiecutter.plugin_name|lower|replace('-', '_') }}",
                "plugin_name": "foobar",
                "pytest_version": "2.8.1",
                "short_description": "A simple plugin to use with Pytest",
                "version": "0.1.0",
                "year": "2015"
            }
        
        
        License
        =======
        
        Distributed under the terms of the `BSD 3-Clause License`_, Cibopath is free
        and open source software
        
        Code of Conduct
        ===============
        
        Everyone interacting in the Cibopath project's codebases, issue trackers, chat
        rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.
        
        .. _`BSD 3-Clause License`: LICENSE
        .. _`Cookiecutter templates`: https://github.com/audreyr/cookiecutter#available-cookiecutters
        .. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
        .. _`GitHub API v3`: https://developer.github.com/v3/
        .. _`GitHub's rate limiting`: https://developer.github.com/v3/#rate-limiting
        .. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/
        .. _`Wikipedia: Chew Comic Book Series`: https://en.wikipedia.org/wiki/Chew_%28comics%29#Cibopath
        .. _`create a GitHub access token`: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
        .. _`scopes`: https://developer.github.com/v3/oauth/#scopes
        
Keywords: cookiecutter,web scraping,asyncio,command-line
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
