如何快速生成项目-cookiecutter

Posted 2022-08-13 xzqpy

PyCharm并不自带这个功能 （Wizard）

生成新项目的向导（Wizard）

于是出现了cookiecutter 这是一个项目生成器

安装cookiecutter

pip install cookiecutter

寻找一个合适的cookiecutter项目

挑选后  则可直接执行cookiecutter生成项目。

在  https://github.com/audreyr/cookiecutter/tree/db14e06a1dcc0187beeafde72685c3acef93eb68#a-pantry-full-of-cookiecutters
cookiecutter https://github.com/audreyr/cookiecutter-pypackage.git

Git拉取

这可以换成任何一个可以用git clone来下载的链接，包括各种私有Git托管平台。

如果是GitHub，还可以用以下的等效形式：

cookiecutter gh:audreyr/cookiecutter-pypackage

使用过模板的项目，默认都已经被下载到~/.cookiecutter目录下。

如果需要再次使用，而又无需更新，可以直接用项目名。

配置文件

默认情况下，~/.cookiecutterrc就是配置文件。 它实际上是一个YAML文件。 以下是孤的配置文件示例。

default_context: #设置生成项目时，一些提示信息的默认参数。
  full_name: "Yan QiDong"   #下载位置
  email: "[e-mail]"  #
  github_username: "yanqd0"
cookiecutters_dir: "~/.cookiecutters/"
abbreviations:
    pp: https://github.com/audreyr/cookiecutter-pypackage.git
    gh: https://github.com/0.git

如果对~/.cookiecutterrc这个配置文件的名称和位置不满意， 可以通过环境变量COOKIECUTTER_CONFIG， 或者在命令行指定参数--config-file来指定新的配置文件。