碼上快樂

相關內容    簡體    繁體

Cookiecutter: 更好的項目模板工具：（1）簡介及可用資源匯總

本文轉載自   查看原文   2019-03-10 21:30   5291    cookiecutter/ 工具配置&工具使用/ 項目模板/ Python相關

原文檔地址：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": "xinyong.wang@qq.com",
    "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: "xinyong.wang@qq.com"
    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生成器，帶有一些附加組件和集成。


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 Cookiecutter: 更好的項目模板工具：（3）高級用法 【AMAD】cookiecutter-django -- 是一個構建Django項目的腳手架工具 使用cookiecutter創建django項目 怎樣找到更好的學習資源 BitAdminCore框架應用篇：（一）使用Cookiecutter創建應用項目 資源匯總 python測試框架&&數據生成&&工具最全資源匯總 基於vue項目的js工具方法匯總 KRPANO資源分析工具模板鏈接下載 Vue.js經典開源項目匯總-前端參考資源
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM