病态识别库 0.1.0

用户配置

首先您需要为病态识别库创建一个GitHub访问令牌，以便它可以与GitHub API v3进行认证。GitHub的速率限制不允许每小时超过60次未认证的请求。因此，您确实需要设置令牌，因为有超过60个特色Cookiecutter模板。

病态识别库访问令牌不需要任何范围。请创建令牌时坚持默认设置（只读访问公共仓库）。

现在使用CLI将您的凭据存储在您的家目录中（默认 ~/.cibopathrc）。

$ cibopath config github.username <your-username>
$ cibopath config github.token <your-access-token>

您可以通过以下方式查看配置文件的内容：

$ cibopath -v config --list

获取模板信息

在GitHub认证就绪后，您现在想要获取有关可用Cookiecutter模板的信息。病态识别库将数据作为JSON文件存储到磁盘上。您可以通过用户配置或CLI指定目标位置。

将转储文件位置保存到设置中

$ cibopath config templates.file ~/.cibopath/templates.json
$ cibopath -v update

或者在命令行中指定它

$ cibopath -v update --dump-file ~/.cibopath/templates.json

请注意，尽管不是必需的，但如果你想查看Cibopath底层做了什么，使用-v或--verbose标志是非常有用的。

在模板中搜索关键词

一旦你收集了关于Cookiecutter模板的信息，你就可以使用Cibopath在模板的README文件中搜索关键词。

假设你想知道哪些支持django和docker。

$ cibopath search django docker

如果你之前没有保存templates.file，你需要明确地将其传递给命令行界面

$ cibopath search django docker --load-file ~/.cibopath/templates.json

Cibopath将以字母顺序显示匹配的模板列表以及它们相应的GitHub仓库URL。如果你觉得这些模板中的任何一个符合你新项目的需求，就可以将其URL传递给Cookiecutter以开始。

cookiecutter-django................. https://github.com/pydanny/cookiecutter-django
django-docker-bootstrap............. https://github.com/legios89/django-docker-bootstrap

显示模板信息

Cibopath还为你提供了有关给定模板的附加信息

$ cibopath info cookiecutter-pytest-plugin

信息包括名称、作者、仓库以及将用于Cookiecutter生成项目的上下文。

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"
}