Cookiecutter: 更好的项目模板工具:(2)安装及基础使用

安装

通过python包管理工具
命令行输入

 $pip install  cookiecutter

或者

# mac os经常会禁止用户全局安装python包
$pip install --user cookiecutter

如果使用的是anaconda,想使用conda安装,可以

$conda config --add channels conda-forge
$conda install cookiecutter

特别提醒:要保证Python在你的系统PATH路径下,同时保证bin目录在你的系统PATH路径下。特别提醒,anaconda安装的Python,其安装的python执行文件默认不在系统路径下,一般在·$ANACONDA/bin·,请将其放置在系统路径下。

通过系统的包管理

ubuntu

$sudo apt install cookiecutter

mac os

$brew install cookiecutter

Cookiecutter模板基础使用

Cookiecutter模板的形式:

  • 模板文件夹
  • 模板文件夹的zip压缩文件
  • 模板文件夹的git地址
  • 模板文件夹的zip压缩文件url地址
  • 模板文件夹在cookiecutter目录下

针对具体形式分别使用相同的命令形式:

# 模板文件夹
$ cookiecutter /path/to/template
# 模板文件夹zip压缩包文件
$ cookiecutter /path/to/template.zip
# 模板文件夹的git地址
$ cookiecutter git地址
$ cookiecutter https://github.com/audreyr/cookiecutter-pypackage.git --checkout develop
# 模板文件夹zip压缩文件URL
$  cookiecutter  https://example.com/path/to/template.zip
# 模板文件夹在cookiecutter目录(缺省会~/.cookiecutters/目录下)
$ cookiecutter    模板名字

特别针对有密码的zip文件,cookiecutter回给出提示符让你输入密码,如果想跳过密码输入,可以设置COOKIECUTTER_REPO_PASSWORD环境变量,在zip文件需要密码的时候会自动填入该环境变量的值。

整体需要注意的:

  • 无论何时你根据一个模板生成了一个项目,生成的项目都会在你的当前路径下
  • 克隆的cookiecutters默认存储在?/.cookiecutters/目录中

创建Cookiecutter模板

Cookiecutter功能原理是获取模板的源目录树并将其复制到新项目中,将在模板用{{}}标记中找到的所有名称替换为cookiecutter.json文件中找到的名称。

替换的名称可以是文件名、目录名和文件中的字符串。

使用Cookiecutter,你可以轻松地从一个标准表单引导一个新项目,这意味着在开始一个新项目时,你可以跳过所有常见的错误,拜托琐碎操作带来的时间消耗以快速开始有真正意义的工作。

以下以一个简单的“Hello World”来介绍Cookiecuter的创建过程:

首先,在您的计算机上创建一个目录。这个目录的名称将是您的Cookiecutter模板的名称,但是它并不限制任何其他内容——例如,生成的项目不需要使用模板名称。我们将项目名称设为HelloWorld

$ mkdir HelloWorld
$ cd HelloWorld

我们在此目录中创建要复制到生成项目中的目录树。我们想要为此目录生成一个名称,所以我们将目录名称放在模板标签中:

$ mkdir {{ cookircutter.directory_name }}
$ cd {{ cookircutter.directory_name }}

模板标记中的任何内容都可以放在名称空间中。cookiecutter.directory_name将被从cookiecutter.json文件中查找,因为该项目是由Cookiecutter生成的。

现 我们在将要被复制的目录树中。对于这个最简单的Cookiecutter模板,我们打算只包含一个文件。同样,我们希望从cookiecutter.json中查找文件名,因此我们将其命名为:

$ touch {{cookiecutter.file_name}}.py

(touch会创建一个空文本文件;你可以在编辑器中打开它)。 现在编辑文件,使其包含:

print("Hello, {{cookiecutter.greeting_recipient}}!")

最后,我们来创建cookiecutter.json文件,以便Cookiecutter可以查找我们所需要模板项。

{
    "directory_name": "Hello",
    "file_name": "Howdy",
    "greeting_recipient": "Tacey"
}

现在我们可以运行Cookiecutter并从模板创建一个新项目。切换到要创建新项目的目录。然后运行Cookiecutter并将模板所在的目录传给它。

$ cookiecutter /the/path/of/HelloWorld
directory_name [Hello]:
file_name [Howdy]:
greeting_recipient [Tacey]:

Cookiecutter告诉我们每个项目的默认名称是什么,并为我们提供了用新名称替换该名称的选项。在这种情况下我只是简单的按回车接受所有的默认值~

现在我们生成了一个名为Hello的目录,其中包含一个文件how .py。当我们运行它:

$ python Howdy.py
Hello, Tacey!

Wow!这就完事儿了~

本章结语

到了这里,如果你在开始新项目时发现自己在重复工作,你就已经会知道如何使用cookiecutter消除这种无谓的重复了。对于一些常见的项目,不妨尝试选择使用Cookiecutter: 更好的项目模板工具:(1)简介及可用资源汇总中的某个模板~~~~~

原文地址:https://www.cnblogs.com/taceywong/p/10508130.html

时间: 2024-08-29 04:24:16

Cookiecutter: 更好的项目模板工具:(2)安装及基础使用的相关文章

制作VB项目打包工具与安装程序

该原因起于错误429. 当然比起自制我更推荐使用其他的功能完整的打包软件. 犹豫各种原因,导致三分钟热情被浇灭...本来想划四个部分详细讲教程的,大家看成品源码就好了,心好累. http://www.wk78.com/thread-215-1-1.html 原文地址:https://www.cnblogs.com/lingqingxue/p/11188741.html

Vue项目模板--和--webpack自动化构建工具的---项目打包压缩使用

[首先安装node.js]: 1. 从node.js官网下载并安装node,安装过程很简单. 2. npm 版本需要大于 3.0,如果低于此版本需要升级它: # 查看版本 npm -v2.3.0 #升级 npm cnpm install npm -g 3.基于node.js,利用淘宝npm镜像安装相关依赖.由于国内使用npm会很慢,这里推荐使用淘宝NPM镜像(http://npm.taobao.org/) npm install -g cnpm --registry=https://regist

20Spring_JdbcTemplatem模板工具类

JdbcTemplate 是Spring提供简化Jdbc开发模板工具类.为了更好的了解整个JdbcTemplate配置数据库连接池的过程,这篇文章不采用配置文件的方式,而是采用最基本的代码 的方式来写.后一篇文章会讲配置文件的方式. 1.Spring 对一下的持久层技术支持 2.jdbcTemplate快速入门 第一步:在项目中导入jar包 其中Spring核心包有四个,日志包有两个,测试包一个.如下 因为要用到jdbcTemplate所以还要导入以下两个jar包 spring-jdbc-3.2

项目模板eShopOnContainers

.NET Core多平台项目模板eShopOnContainers编译手记 之前写了一个功能性的文件上传asp.net core的小程序,加上点七七八八的东西,勉强能够应付了,打算学习一下微软的官方.NET CORE微服务示例https://github.com/dotnet-architecture/eShopOnContainers.这个例子很全面地展现了微服务.docker以及.net core的魅力.里面使用了很多知识点,比如单点登录.API资源授权,权限控制,用户管理等,可以作为一个应

Vue.js——60分钟webpack项目模板快速入门

概述 browserify是一个 CommonJS风格的模块管理和打包工具,上一篇我们简单地介绍了Vue.js官方基于browserify构筑的一套开发模板.webpack提供了和browserify类似的功能,在前端资源管理这方面,它提供了更加出色的功能.官方基于webpack提供了两种项目模板,分别是vue-webpack-simple模板和vue-webpack模板,今天我们将介绍官方提供的这两种项目模板,并用vue-webpack-simple模板创建一个简单的示例. 本文的Demo和源

Vue.js项目模板搭建

前言 从今年(2017年)年初起,我们团队开始引入「Vue.js」开发移动端的产品.作为团队的领头人,我的首要任务就是设计 整体的架构 .一个良好的架构必定是具备丰富的开发经验后才能搭建出来的.虽然我有多年的前端开发经验,但就「Vue.js」来说,仍然是个新手.所幸「Vue.js」有一个配套工具「Vue-CLI」,它提供了一些比较成熟的项目模板,很大程度上降低了上手的难度.然而,很多具体的问题还是要自己思考和解决的. 项目划分 我们公司的H5产品大部分是嵌套在手机客户端里面的页面.每个项目的功能

第【一】部分Netzob项目工具的安装配置by tsy

声明: 1)本报告由博客园bitpeach撰写,版权所有,免费转载,请注明出处,并请勿作商业用途. 2)若本文档内有侵权文字或图片等内容,请联系作者bitpeach删除相应部分. 3)本文档内容涉及Netzob工具的安装配置,请勿认为本文是讲述使用,Netzob的使用是不在本文讲述的,下一篇博文应该会写Netzob的使用手册. 4)仅仅作为参考用途,抛砖引玉,不作为证据证明用途,请自行取舍,核实引用.文中图片大多为本人原创,如有引用他人图片会注明的. 0目录 目录 0目录    1 [1]引言 

DotNetBar for Windows Forms 12.9.0.0_冰河之刃重打包版及制作Visual Studio C#项目模板文件详解

关于 DotNetBar for Windows Forms 12.9.0.0_冰河之刃重打包版 --------------------11.8.0.8_冰河之刃重打包版---------------------------------------------------------基于 官方原版的安装包 + http://www.cnblogs.com/tracky 提供的补丁DLL制作而成.安装之后,直接就可以用了.省心省事.不必再单独的打一次补丁包了.本安装包和补丁包一样都删除了官方自带

创建Visual studio项目模板 vstemplate关键点纪要

from:http://www.cnblogs.com/stickman/p/3454719.html 经过多次的实验,终于完美生成一个.VSIX的项目模板安装包,其中遇到不少问题与挫折,久经google/baidu/自行摸索.终于解决所有问题. 现将心得记录总结如下 关于.vstemplate 1.可以通过导出模板直接生成.vstemplate及其他项目文件,以作为 模板的母版! 建议复制一份csprj文件做.vstemplate里面引用的模板项目文件. 2.TargetFileName/Ta