{
    "info": {
        "author": "Raphael Pierzina",
        "author_email": "raphael@hackebrot.de",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3 :: Only",
            "Programming Language :: Python :: Implementation :: CPython"
        ],
        "description": "========\r\nCibopath\r\n========\r\n\r\n|pypi| |pyversions| |license| |travis-ci|\r\n\r\nSearch `Cookiecutter`_ templates on GitHub with Python 3.5.\r\n\r\n    A Cibopath can take a bite from anything and get a psychic sensation of\r\n    what has happened to that object. The only thing it does not work on is\r\n    beets.\r\n\r\n    -- `Wikipedia: Chew Comic Book Series`_\r\n\r\n.. |pypi| image:: https://img.shields.io/pypi/v/cibopath.svg\r\n   :target: https://pypi.python.org/pypi/cibopath\r\n   :alt: PyPI Package\r\n\r\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/cibopath.svg\r\n   :target: https://pypi.python.org/pypi/cibopath/\r\n   :alt: PyPI Python Versions\r\n\r\n.. |license| image:: https://img.shields.io/pypi/l/cibopath.svg\r\n   :target: https://pypi.python.org/pypi/cibopath\r\n   :alt: PyPI Package License\r\n\r\n.. |travis-ci| image:: https://travis-ci.org/hackebrot/cibopath.svg?branch=master\r\n    :target: https://travis-ci.org/hackebrot/cibopath\r\n    :alt: See Build Status on Travis CI\r\n\r\n\r\nUsage\r\n=====\r\n\r\n.. code-block:: text\r\n\r\n    Usage: cibopath [OPTIONS] COMMAND [ARGS]...\r\n\r\n      Cibopath - Search Cookiecutters on GitHub.\r\n\r\n    Options:\r\n      -v, --verbose           Print debug information\r\n      -c, --config-file PATH  Config file to hold settings\r\n      -V, --version           Show the version and exit.\r\n      --help                  Show this message and exit.\r\n\r\n    Commands:\r\n      config\r\n      info\r\n      search\r\n      update\r\n\r\nUser Config\r\n-----------\r\n\r\nFirst you need to `create a GitHub access token`_ for Cibopath, so it can\r\nauthenticate with the `GitHub API v3`_. `GitHub's rate limiting`_ won't allow\r\nmore than 60 unauthenticated requests per hour. So yeah, you definitely want to\r\nhave a token set up as there are more than 60 featured `Cookiecutter\r\ntemplates`_.\r\n\r\nThe Cibopath access token does **NOT** require any `scopes`_. Please stick to\r\nthe defaults when creating the token (**Read-only access to public\r\nrepositories**).\r\n\r\nNow use the CLI to store your credentials in your home directory (default\r\n``~/.cibopathrc``).\r\n\r\n.. code-block:: bash\r\n\r\n    $ cibopath config github.username <your-username>\r\n    $ cibopath config github.token <your-access-token>\r\n\r\nFeel free to view the contents of the config file via:\r\n\r\n.. code-block:: bash\r\n\r\n    $ cibopath -v config --list\r\n\r\n\r\nFetch Template Information\r\n--------------------------\r\n\r\nWith GitHub authentication in place, you now want to fetch information about\r\navailable Cookiecutter templates. Cibopath dumps the data as a JSON file to\r\ndisk. You can specify the target location either via user config or CLI.\r\n\r\nSave the dump-file location to settings:\r\n\r\n.. code-block:: bash\r\n\r\n    $ cibopath config templates.file ~/.cibopath/templates.json\r\n    $ cibopath -v update\r\n\r\nOr specify it on the CLI:\r\n\r\n.. code-block:: bash\r\n\r\n    $ cibopath -v update --dump-file ~/.cibopath/templates.json\r\n\r\nPlease note that, albeit not required, the ``-v`` or ``--verbose`` flags are\r\nvery useful if you want to see what Cibopath is doing under the hood.\r\n\r\nSearch Keywords in Templates\r\n----------------------------\r\n\r\nOnce you've gathered information about Cookiecutter templates, you can use\r\nCibopath to search for keywords in the templates' **README** files.\r\n\r\nLet's say you would like to know which ones support *django* and *docker*.\r\n\r\n.. code-block:: bash\r\n\r\n    $ cibopath search django docker\r\n\r\nIf you didn't save the ``templates.file`` earlier, you need to explicitly pass\r\nit to the CLI:\r\n\r\n.. code-block:: bash\r\n\r\n    $ cibopath search django docker --load-file ~/.cibopath/templates.json\r\n\r\nCibopath will show you a list of matching templates in alphabetical order along\r\nwith their corresponding GitHub repository URL. If you feel like one of these\r\ntemplates meets your requirements for a new project, go ahead and pass the URL\r\nto `Cookiecutter`_ to get started.\r\n\r\n.. code-block:: bash\r\n\r\n    cookiecutter-django................. https://github.com/pydanny/cookiecutter-django\r\n    django-docker-bootstrap............. https://github.com/legios89/django-docker-bootstrap\r\n\r\n\r\nDisplay Template Information\r\n----------------------------\r\n\r\nCibopath also provides you with additional information about a given template:\r\n\r\n.. code-block:: bash\r\n\r\n    $ cibopath info cookiecutter-pytest-plugin\r\n\r\nInfo includes **Name**, **Author**, **Repository** as well as the **Context**,\r\nwhich will be used by `Cookiecutter`_ to generate the project.\r\n\r\n.. code-block:: text\r\n\r\n    Name: cookiecutter-pytest-plugin\r\n    Author: pytest-dev\r\n    Repository: https://github.com/pytest-dev/cookiecutter-pytest-plugin\r\n    Context: {\r\n        \"docs_tool\": [\r\n            \"mkdocs\",\r\n            \"sphinx\",\r\n            \"none\"\r\n        ],\r\n        \"email\": \"raphael@hackebrot.de\",\r\n        \"full_name\": \"Raphael Pierzina\",\r\n        \"github_username\": \"hackebrot\",\r\n        \"license\": [\r\n            \"MIT\",\r\n            \"BSD-3\",\r\n            \"GNU GPL v3.0\",\r\n            \"Apache Software License 2.0\"\r\n        ],\r\n        \"module_name\": \"{{ cookiecutter.plugin_name|lower|replace('-', '_') }}\",\r\n        \"plugin_name\": \"foobar\",\r\n        \"pytest_version\": \"2.8.1\",\r\n        \"short_description\": \"A simple plugin to use with Pytest\",\r\n        \"version\": \"0.1.0\",\r\n        \"year\": \"2015\"\r\n    }\r\n\r\n\r\nLicense\r\n=======\r\n\r\nDistributed under the terms of the `BSD 3-Clause License`_, Cibopath is free\r\nand open source software\r\n\r\nCode of Conduct\r\n===============\r\n\r\nEveryone interacting in the Cibopath project's codebases, issue trackers, chat\r\nrooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.\r\n\r\n.. _`BSD 3-Clause License`: LICENSE\r\n.. _`Cookiecutter templates`: https://github.com/audreyr/cookiecutter#available-cookiecutters\r\n.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter\r\n.. _`GitHub API v3`: https://developer.github.com/v3/\r\n.. _`GitHub's rate limiting`: https://developer.github.com/v3/#rate-limiting\r\n.. _`PyPA Code of Conduct`: https://www.pypa.io/en/latest/code-of-conduct/\r\n.. _`Wikipedia: Chew Comic Book Series`: https://en.wikipedia.org/wiki/Chew_%28comics%29#Cibopath\r\n.. _`create a GitHub access token`: https://help.github.com/articles/creating-an-access-token-for-command-line-use/\r\n.. _`scopes`: https://developer.github.com/v3/oauth/#scopes",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/hackebrot/cibopath",
        "keywords": "cookiecutter,web scraping,asyncio,command-line",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "cibopath",
        "package_url": "https://pypi.org/project/cibopath/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/cibopath/",
        "project_urls": {
            "Homepage": "https://github.com/hackebrot/cibopath"
        },
        "release_url": "https://pypi.org/project/cibopath/0.1.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Search Cookiecutters on GitHub.",
        "version": "0.1.0"
    },
    "last_serial": 1994606,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "46d81dcef906ef7a179c100e16c3f53b",
                    "sha256": "b715399e67b81b2c7fcf55096a7d1f3b8306822b7f004a10f5bde1c83b901cbb"
                },
                "downloads": -1,
                "filename": "cibopath-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "46d81dcef906ef7a179c100e16c3f53b",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 13433,
                "upload_time": "2016-03-07T22:44:41",
                "url": "https://files.pythonhosted.org/packages/5e/4e/b9c85f37adf6cb43c4ee6a0812c09dc4673e53ea38a89c08ff28749faa10/cibopath-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ba8b69762c222d9482b69dd6941e0cbf",
                    "sha256": "c51c23563950da3da6670fc10c42eba5b9af9d86206b29f254a1ba2a0648eb5f"
                },
                "downloads": -1,
                "filename": "cibopath-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ba8b69762c222d9482b69dd6941e0cbf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8556,
                "upload_time": "2016-03-07T22:44:48",
                "url": "https://files.pythonhosted.org/packages/81/37/9b70b4de5ccf2a30c42d234c11ddcf4e89647bd8e8e3934d6da24ccfe72a/cibopath-0.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "46d81dcef906ef7a179c100e16c3f53b",
                "sha256": "b715399e67b81b2c7fcf55096a7d1f3b8306822b7f004a10f5bde1c83b901cbb"
            },
            "downloads": -1,
            "filename": "cibopath-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "46d81dcef906ef7a179c100e16c3f53b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 13433,
            "upload_time": "2016-03-07T22:44:41",
            "url": "https://files.pythonhosted.org/packages/5e/4e/b9c85f37adf6cb43c4ee6a0812c09dc4673e53ea38a89c08ff28749faa10/cibopath-0.1.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ba8b69762c222d9482b69dd6941e0cbf",
                "sha256": "c51c23563950da3da6670fc10c42eba5b9af9d86206b29f254a1ba2a0648eb5f"
            },
            "downloads": -1,
            "filename": "cibopath-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ba8b69762c222d9482b69dd6941e0cbf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8556,
            "upload_time": "2016-03-07T22:44:48",
            "url": "https://files.pythonhosted.org/packages/81/37/9b70b4de5ccf2a30c42d234c11ddcf4e89647bd8e8e3934d6da24ccfe72a/cibopath-0.1.0.tar.gz"
        }
    ]
}