项目模板之 Cookiecutter

平常看到的每个 OpenStack 项目都有比较类似的项目结构，如 Nova 的项目结构：

$ tree -L 1 nova
nova
├── api-guide
├── api-ref
├── babel.cfg*
├── bindep.txt
├── contrib
├── CONTRIBUTING.rst*
├── devstack
├── doc*
├── etc
├── HACKING.rst*
├── LICENSE*
├── MAINTAINERS
├── nova
├── nova.egg-info
├── plugins
├── README.rst*
├── releasenotes
├── requirements.txt*
├── run_tests.sh
├── setup.cfg*
├── setup.py*
├── test-requirements.txt*
├── tests-py3.txt
├── tools
└── tox.ini*

11 directories, 14 files

要生成类似这样的项目，我们可以使用 Python 的 Cookiecutter 包。Github 介绍其为一个用于生成项目（不局限于 Python 项目）模板的命令行工具。下边我们来看下怎么用该工具来生成 OpenStack 项目模板。

以下步骤摘录自《OpenStack 设计与实现》一书。

$ sudo pip install cookiecutter
$ cookiecutter https://git.openstack.org/openstack-dev/cookiecutter.git
module_name [replace with the name of the python module]: abc
repo_group [openstack]: stackforge
repo_name [replace with the name for the git repo]: abc
launchpad_project [replace with the name of the project on launchpad]: abc
project_short_description [OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package.]: "test project for openstack"
Initialized empty Git repository in /home/xiehongfeng100/test/cookiecutter-test/abc/.git/
[master (root-commit) 5197032] Initial Cookiecutter Commit.
 31 files changed, 915 insertions(+)
 create mode 100644 .coveragerc
 create mode 100644 .gitignore
 create mode 100644 .gitreview
 ......
 create mode 100644 tox.ini
$ tree -L 1 abc
abc
├── abc
├── babel.cfg
├── CONTRIBUTING.rst
├── doc
├── HACKING.rst
├── LICENSE
├── README.rst
├── releasenotes
├── requirements.txt
├── setup.cfg
├── setup.py
├── test-requirements.txt
└── tox.ini

3 directories, 10 files
$ cd abc
$ git status
# On branch master
nothing to commit, working directory clean

对生成文件的解释可见下图：
图片来源：《OpenStack 设计与实现》