2. 程式人生 > 實用技巧 >Cookiecutter: 更好的專案模板工具：（1）簡介及可用資源彙總

Cookiecutter: 更好的專案模板工具：（1）簡介及可用資源彙總

阿新 • • 發佈：2020-12-23

https://www.cnblogs.com/taceywong/p/10506032.html

原文件地址：https://cookiecutter.readthedocs.io/en/latest/

本系列只介紹cookiecutter的基礎使用，而且會刪除與功能使用無關的部分。深度使用及瞭解更多詳情請請參考原文件。

關於Cookiecutter的中文譯名，我不知道別人怎麼翻譯的，我將其翻譯為餅乾製造機。本系列中將不對其作翻譯，直接使用英文原名。

Cookiecutter簡介

Cookiecutter 是一個通過專案模板建立專案的命令列工具。比如，通過Python Package模板來建立Python package專案。（通過Python程式碼呼叫Cookiecutter的API可以擴充套件為自動化建立服務和帶有Web UI的服務程式）

功能特點

  • 跨平臺：官方支援Windows、Mac和Linux
  • 可以在Python 2.7, 3.4, 3.5, 3.6, and PyPy.環境中正常使用（此處指的是Cookiecutter的執行環境，而不是你專案的執行環境。使用Cookiecutter不需要你懂得編寫Python程式碼）
  • 專案模板可以是任何程式語言或標記格式：Python, JavaScript, Ruby, CoffeeScript, RST, Markdown, CSS, HTML等任何你能叫出名字的。你也可以在同一個專案模板中使用多種語言。
  • 命令列的簡單使用：
# 從cookiecutter-pypackage.git模板建立專案
# 你將會被提示輸入相應的值。
# 然後Cookiecutter將基於你的輸入在當前工作目錄中建立Python包
$ cookiecutter https://github.com/audreyr/cookiecutter-pypackage
# 為了簡潔起見，repos在GitHub上可以只使用“gh”字首
$ cookiecutter gh:audreyr/cookiecutter-pypackage
  • 在命令列中使用本地模板：
# 從本地在當前目錄建立專案
# cookiecutter-pypackage/ template
$ cookiecutter cookiecutter-pypackage/
  • 目錄名和檔名可以模板化。例如：{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}/{{cookiecutter.repo_name}}.py
  • 支援無限層級的目錄巢狀。
  • 檔案和目錄名稱100%使用Jinja2完成模板化。
  • 只需在·cookiecutter.json·檔案中定義模板變數即可。 例如：
{
    "full_name": "Tacey Wong",
    "email": "[email protected]",
    "project_name": "Complexity",
    "repo_name": "complexity",
    "project_short_description": "令人耳目一新的簡單的靜態網站生成器.",
    "release_date": "2019-03-10",
    "year": "2019",
    "version": "0.0.1"
}
  • 沒有你用·--no-input·來禁止，系統會提示你輸入：
    • cookiecutter.json中鍵/key對應的值/value。
    • cookiecutter.json中的預設值
    • 提示符按順序顯示
  • 跨平臺支援~/.cookiecutterrc檔案：
default_context:
    full_name: "Tacey Wong"
    email: "[email protected]"
    github_username: "taceywong"
cookiecutters_dir: "~/.cookiecutters/"
  • 克隆的Cookiecutter專案模板會預設放置在~/.cookiecutters/目錄下，如果特殊指定，會放置在cookiecutters_dir對應的目錄下：
# 克隆cookiecutter-pypackage
$ cookiecutter gh:audreyr/cookiecutter-pypackage
# 現在你可以根據名字使用對應的模板
$ cookiecutter cookiecutter-pypackage
  • 您可以使用你本地模板、遠端Git repos
  • 預設上下文:指定在生成專案時要用作預設值的鍵/值對
  • 用命令列引數注入額外的上下文：
$ cookiecutter --no-input gh:msabramo/cookiecutter-supervisor program_name=foobar startsecs=10
  • 直接訪問Cookiecutter API允許注入額外的上下文。
  • 預生成和後生成掛鉤/hook:在生成專案之前或之後執行的Python或shell指令碼。
  • 本地專案的路徑可以指定為絕對路徑或相對路徑。
  • 專案始終生成到當前目錄。

可用的Cookiecutter模板

現在在已經有很多開源的Cookiecutter 專案模板可供選擇。

特定的Cookiecutter模板

這些模板由cookiecutter官方團隊進行維護：

Cookiecutter模板分類

社群驅動的各類Cookiecutter模板（非Cookiecutter官方維護）

Python

Python-Django

Python-Pyramid

  • pyramid-cookiecutter-alchemy:Cookiecutter (專案模板)，使用SQLite建立Pyramid專案，SQLAlchemy用於ORM，URL排程用於路由，Jinja2用於模板。
  • pyramid-cookiecutter-starter: 使用URL排程進行路由分配，使用Jinjab 2、Chameleon或Mako模板建立Pyramid入門專案的Cookiecutter (專案模板)。
  • pyramid-cookiecutter-zodb:Cookiecutter（專案模板），用於建立Pyramid專案，使用ZODB進行持久儲存，遍歷路由，使用Chameleon進行模板化。
  • substanced-cookiecutter: 用於建立Substance D初始專案的cookiecutter（專案模板）。 Substance D是基於Pyramid實現的。
  • cookiecutter-pyramid-talk-python-starter: 一個自以為是的Cookiecutter模板，用於建立PyramidWeb應用程式，從開發鏈的下游開始。這個cookiecutter模板將建立一個新的Pyramid Web應用程式，其中包含電子郵件，sqlalchemy，rollbar以及更多的整合。

**Cookiecutter (meta) **

用於生成Cookiecutter專案模板的元模板。

Ansible

Git

C

C++

C#

Common Lisp

Elm

Golang

Java

JS

Kotlin

LaTeX/XeTeX

PHP

Sublime Text

Berkshelf-Vagrant

HTML

Data Science

  • widget-cookiecutter: 用於建立自定義Jupyter小部件專案的cookiecutter模板。
  • cookiecutter-data-science:為在Python中進行和共享資料科學工作的邏輯的、合理標準化的、靈活的專案結構。此處提供了的完整文件 。
  • cookiecutter-r-data-analysis: 組織基於R的工作流->doc(通過pandoc)->pdf報告(通過latex)的模板
  • cookiecutter-docker-science: Cookiecutter template for data scientists working in Docker containers.為使用Docker容器工作的資料科學家準備的Cookiecutter模板。

Reproducible Science

  • cookiecutter-reproducible-science: 用於開始一個可重複和透明的科學專案，包括資料，模型，分析和報告的cookiecutter模板 (比如你的科學論文)。與上面資料科學Cookiecutter模板的哲學非常一致

資料驅動的Journalism

  • cookiecutter-data-driven-journalism: 通過持續組織資料日誌專案和一些預先填充的檔案來促進資料日誌的透明度的Cookiecutter模板(包括 .gitignore, README, AUTHORS)

持續交付

雲工具

Tornado

其他

與Cookiecutter類似的專案

    • Paste具有建立骨架專案的建立選項。
    • Diecutter: 一個提供模板和變數的配置檔案的API服務。
    • Django的tartproject和startapp命令可以使用-template選項。
    • python-packager:使用自己的模板建立Python包，並提供可配置的選項。
    • Yeoman有一個受Rails啟發的生成器系統，為應用程式提供腳手架。
    • Pyramid的pcreate命令，用於從腳手架模板建立Pyramid 專案。
    • mr.bob是一個檔案系統模板渲染器，用於棄用paster和templer等工具
    • grunt-init曾經被內建到Grunt中，現在是一個獨立的腳手架工具，可以自動建立專案。
    • scaffolt使用Handlebars 的JSON生成器。
    • init-skeleton克隆或複製儲存庫，執行npm安裝和bower安裝，並刪除.git目錄。
    • Cog由Ned Batchelder開發的基於python的程式碼生成工具包
    • Skaffold基於python和json配置的django / MVC生成器，帶有一些附加元件和整合。

相關推薦

Cookiecutter: 更好的專案模板工具：（1）簡介及可用資源彙總

https://www.cnblogs.com/taceywong/p/10506032.html 原文件地址：https://cookiecutter.readthedocs.io/en/latest/

Spring Security 在前後端分離專案中的實踐（1）

1 概述 如今，前後端分離（開發）已經非常常見了。由於任務需要，要在基於 Spring Boot 的 Web 專案中整合 Spring Security 完成使用者模組的登入和認證等功能，但是在網上查閱的（中文）資料中，對前後端完全分離如

自動化運維工具SaltStack（1）

目錄1. SaltStack介紹1.1 自動化運維工具1.2 saltstack的特點1.3 saltstack服務架構2. SaltStack四大功能與四大執行方式3. SaltStack元件介紹4. SaltStack安裝與最小化配置4.1 在控制機上安裝saltstack主控端軟體4.2

3dsMaxMax指令碼的入門講解之怎樣定義控制元件和工具條（1）

>>> 3DS MAX教程：指令碼 MAX Script是3D Studio MAX 4.0中的插入指令碼語言。它為使用者提供了以下功能：

akka框架：（一）簡介

轉載：https://blog.csdn.net/liubenlong007/article/details/53782966 為什麼要用akka Akka提供可擴充套件的實時事務處理。

Jumpserver高可用叢集部署：（八）MariaDB及Redis資料庫定時備份

1、編寫MariaDB及Redis資料庫備份指令碼 vi /sas/jumpserver/tools/db-backup.sh #!/bin/bash MariadbPath=/sas/db-backup/mariadb/

瘋狂Java講義_Chapter13MySQL資料庫與JDBC程式設計：（1）JDBC概念與使用方法

1.JDBC的概念 JDBC的全稱是Java Database Connectivity；​​ JDBC是Java連線資料庫的一組API，API與Java的介面部分是通用的，API與資料庫的介面部分根據資料庫的不同而不同，由廠家提供；

Golang database/sql教程：（1）訪問資料庫

在Golang中使用資料庫的基礎方式是通過Golang的標準庫database/sql，此庫提供了關係型資料庫的一般介面，需要第三方實現對應資料庫的驅動，其角色類似JDBC。

Java學習：（1）Java學習準備

1、什麼是程式？what\'s procedure? 　　一堆讓計算機完成某種操作的指令集合 2、什麼是程式語言？

I-第二章：（1）Eureka 服務註冊與發現

一、Eureka 是什麼 Eureka 是什麼？ Eureka是Netflix的一個子模組，也是核心模組之一。Eureka是一個基於REST的服務，用於定位服務，以實現雲端中間層服務發現和故障轉移。服務註冊與發現對於微服務架構來說是非常重

I-第三章：（1）Ribbon 負載均衡

一、概述 1、是什麼 Spring Cloud Ribbon是基於Netflix Ribbon實現的一套客戶端負載均衡的工具。

I-第五章：（1）Hystrix 斷路器

一、概述 1、分散式系統面臨的問題 複雜分散式體系結構中的應用程式有數十個依賴關係，每個依賴關係在某些時候將不可避免地失敗。

I-第七章：（1）SpringCloud Config分散式配置中心

一、概述 1、分散式系統面臨的---配置問題 微服務意味著要將單體應用中的業務拆分成一個個子服務，每個服務的粒度相對較小，因此係統中會出現大量的服務。由於每個服務都需要必要的配置資訊才能執行，所以一套集中式

第三章—Java NIO程式設計：（9）AIO及三種IO對比

一、Java AIO 基本介紹 JDK 7 引入了 Asynchronous I/O， 即 AIO。 在進行 I/O 程式設計中，常用到兩種模式：Reactor和 Proactor。Java 的 NIO 就是 Reactor，當有事件觸發時，伺服器端得到通知， 進行相應的處理。

第四章—Netty：（1）Netty概述

一、原生NIO存在的問題 （1） NIO 的類庫和 API 繁雜，使用麻煩：需要熟練掌握 Selector、ServerSocketChannel、SocketChannel、ByteBuffer 等。

II-第六章：（1）Hystrix斷路器

一、Hystrix斷路器概述 1、分散式系統面臨的問題 複雜分散式體系結構中的應用程式有數十個依賴關係，每個依賴關係在某些時候將不可避免地失敗。

網易雲音樂播放器專案實現步驟部分（1）

網易雲音樂播放器專案實現步驟LCW 專案後端搭建 下載專案所需要的檔案 專案原始碼NeteaseCloudMusicApi-master（後端api原始碼）

II-第八章：（1）Config分散式配置中心

一、Config 概述 1、分散式系統面臨的---配置問題 微服務意味著要將單體應用中的業務拆分成一個個子服務，每個服務的粒度相對較小，因此係統中會出現大量的服務。由於每個服務都需要必要的配置資訊才能執行，所以一套

II-第十二章：（1）SpringCloud Alibaba簡介

一、SpringCloud Alibaba 1、Spring Cloud Netflix專案進入維護模式 https://spring.io/blog/2018/12/12/spring-cloud-greenwich-rc1-available-now

DOM-（1）簡介與元素獲取方法

一、什麼是DOM 　　文件物件模型（Document Object Model ,簡稱DOM），是W3C組織推薦的處理可擴充套件標記語言的標準程式設計介面。