/usr/share/doc/python-cookiecutter-doc/html/readme.html is in python-cookiecutter-doc 0.6.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Cookiecutter — cookiecutter 0.6.4 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.6.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="cookiecutter 0.6.4 documentation" href="index.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Cookiecutter: Better Project Templates" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Cookiecutter: Better Project Templates"
accesskey="P">previous</a> |</li>
<li><a href="index.html">cookiecutter 0.6.4 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="cookiecutter">
<h1>Cookiecutter<a class="headerlink" href="#cookiecutter" title="Permalink to this headline">¶</a></h1>
<a class="reference external image-reference" href="http://badge.fury.io/py/cookiecutter"><img alt="https://badge.fury.io/py/cookiecutter.png" src="https://badge.fury.io/py/cookiecutter.png" /></a>
<a class="reference external image-reference" href="https://travis-ci.org/audreyr/cookiecutter"><img alt="https://travis-ci.org/audreyr/cookiecutter.png?branch=master" src="https://travis-ci.org/audreyr/cookiecutter.png?branch=master" /></a>
<a class="reference external image-reference" href="https://crate.io/packages/cookiecutter?version=latest"><img alt="https://pypip.in/d/cookiecutter/badge.png" src="https://pypip.in/d/cookiecutter/badge.png" /></a>
<a class="reference external image-reference" href="https://coveralls.io/r/audreyr/cookiecutter?branch=master"><img alt="https://coveralls.io/repos/audreyr/cookiecutter/badge.png?branch=master" src="https://coveralls.io/repos/audreyr/cookiecutter/badge.png?branch=master" /></a>
<p>A command-line utility that creates projects from project templates, e.g.
creating a Python package project from a Python package project template.</p>
<ul class="simple">
<li>Documentation: <a class="reference external" href="http://cookiecutter.rtfd.org">http://cookiecutter.rtfd.org</a></li>
<li>GitHub: <a class="reference external" href="https://github.com/audreyr/cookiecutter">https://github.com/audreyr/cookiecutter</a></li>
<li>Free software: BSD license</li>
<li>PyPI: <a class="reference external" href="https://pypi.python.org/pypi/cookiecutter">https://pypi.python.org/pypi/cookiecutter</a></li>
</ul>
<img alt="https://raw.github.com/audreyr/cookiecutter/aa309b73bdc974788ba265d843a65bb94c2e608e/cookiecutter_medium.png" src="https://raw.github.com/audreyr/cookiecutter/aa309b73bdc974788ba265d843a65bb94c2e608e/cookiecutter_medium.png" />
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
<p>Did someone say features? Cookiecutter’s got more features than you can shake
a stick at!</p>
<ul>
<li><p class="first">Works with Python 2.6, 2.7, 3.3, and PyPy.</p>
</li>
<li><p class="first">Simple command line usage:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span class="c"># Create project from the cookiecutter-pypackage.git repo template</span>
<span class="c"># You'll be prompted to enter values.</span>
<span class="c"># Then it'll create your Python package based on those values.</span>
<span class="nv">$ </span>cookiecutter https://github.com/audreyr/cookiecutter-pypackage.git
</pre></div>
</div>
</div></blockquote>
</li>
<li><p class="first">Can also use it at the command line with a local template:</p>
<blockquote>
<div><div class="highlight-bash"><div class="highlight"><pre><span class="c"># Create project from the local cookiecutter-pypackage/ template</span>
<span class="nv">$ </span>cookiecutter cookiecutter-pypackage/
</pre></div>
</div>
</div></blockquote>
</li>
<li><p class="first">Or use it from Python:</p>
<blockquote>
<div><div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">cookiecutter.main</span> <span class="kn">import</span> <span class="n">cookiecutter</span>
<span class="c"># Create project from the cookiecutter-pypackage/ template</span>
<span class="n">cookiecutter</span><span class="p">(</span><span class="s">'cookiecutter-pypackage/'</span><span class="p">)</span>
<span class="c"># Create project from the cookiecutter-pypackage.git repo template</span>
<span class="n">cookiecutter</span><span class="p">(</span><span class="s">'https://github.com/audreyr/cookiecutter-pypackage.git'</span><span class="p">)</span>
</pre></div>
</div>
</div></blockquote>
</li>
<li><p class="first">Directory names and filenames can be templated. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{{</span><span class="n">cookiecutter</span><span class="o">.</span><span class="n">repo_name</span><span class="p">}}</span><span class="o">/</span><span class="p">{{</span><span class="n">cookiecutter</span><span class="o">.</span><span class="n">repo_name</span><span class="p">}}</span><span class="o">/</span><span class="p">{{</span><span class="n">cookiecutter</span><span class="o">.</span><span class="n">repo_name</span><span class="p">}}</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
</li>
<li><p class="first">Supports unlimited levels of directory nesting.</p>
</li>
<li><p class="first">All templating is done with Jinja2.</p>
</li>
<li><p class="first">Project templates can be in any programming language or markup format:
Python, JavaScript, Ruby, CoffeeScript, RST, Markdown, CSS, HTML, you name
it. You can use multiple languages in the same project template.</p>
</li>
<li><p class="first">Simply define your template variables in a <cite>cookiecutter.json</cite> file. For example:</p>
<blockquote>
<div><div class="highlight-json"><div class="highlight"><pre><span class="p">{</span>
<span class="nt">"full_name"</span><span class="p">:</span> <span class="s2">"Audrey Roy"</span><span class="p">,</span>
<span class="nt">"email"</span><span class="p">:</span> <span class="s2">"audreyr@gmail.com"</span><span class="p">,</span>
<span class="nt">"project_name"</span><span class="p">:</span> <span class="s2">"Complexity"</span><span class="p">,</span>
<span class="nt">"repo_name"</span><span class="p">:</span> <span class="s2">"complexity"</span><span class="p">,</span>
<span class="nt">"project_short_description"</span><span class="p">:</span> <span class="s2">"A refreshingly simple HTML-based static site generator."</span><span class="p">,</span>
<span class="nt">"release_date"</span><span class="p">:</span> <span class="s2">"2013-07-10"</span><span class="p">,</span>
<span class="nt">"year"</span><span class="p">:</span> <span class="s2">"2013"</span><span class="p">,</span>
<span class="nt">"version"</span><span class="p">:</span> <span class="s2">"0.1.1"</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
</li>
<li><p class="first">If generating a project from a git repo template, you are prompted for input:</p>
<ul class="simple">
<li>Prompts are the keys in <cite>cookiecutter.json</cite>.</li>
<li>Default responses are the values in <cite>cookiecutter.json</cite>.</li>
<li>Prompts are shown in order (thanks to those handy OrderedDicts!)</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="available-templates">
<h2>Available Templates<a class="headerlink" href="#available-templates" title="Permalink to this headline">¶</a></h2>
<p>Here is a list of the working Cookiecutter project templates that exist:</p>
<ul class="simple">
<li><a class="reference external" href="https://github.com/audreyr/cookiecutter-pypackage">cookiecutter-pypackage</a>: <a class="reference external" href="https://github.com/audreyr/">@audreyr</a>‘s ultimate Python package project
template.</li>
<li><a class="reference external" href="https://github.com/audreyr/cookiecutter-jquery">cookiecutter-jquery</a>: A jQuery plugin project template based on jQuery
Boilerplate.</li>
<li><a class="reference external" href="https://github.com/sloria/cookiecutter-flask">cookiecutter-flask</a> : A Flask template with Bootstrap 3, starter templates, and working user registration.</li>
<li><a class="reference external" href="https://github.com/pydanny/cookiecutter-django">cookiecutter-django</a>: A Django project template with Bootstrap 3, customizable users app, starter templates, and working user registration.</li>
<li><a class="reference external" href="https://github.com/pydanny/cookiecutter-djangopackage">cookiecutter-djangopackage</a>: A template designed to create reusable third-party PyPI friendly Django apps. Documentation is written in tutorial format.</li>
<li><a class="reference external" href="https://github.com/vincentbernat/bootstrap.c">bootstrap.c</a>: A template for simple projects written in C with autotools.</li>
</ul>
<p>Make your own, then submit a pull request adding yours to this list!</p>
</div>
<div class="section" id="similar-projects">
<h2>Similar projects<a class="headerlink" href="#similar-projects" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference external" href="http://pythonpaste.org/script/#paster-create">Paste</a> has a create option that creates a skeleton project.</li>
<li><a class="reference external" href="https://github.com/novagile/diecutter">Diecutter</a>: an API service that will give you back a configuration file from
a template and variables.</li>
<li><a class="reference external" href="https://docs.djangoproject.com/en/1.5/ref/django-admin/#django-admin-startproject">Django</a>‘s <cite>startproject</cite> and <cite>startapp</cite> commands can take in a <cite>–template</cite>
option.</li>
<li><a class="reference external" href="https://github.com/fcurella/python-packager">python-packager</a>: Creates Python packages from its own template, with
configurable options.</li>
<li><a class="reference external" href="https://github.com/yeoman/generator">Yeoman</a> has a Rails-inspired generator system that provides scaffolding
for apps.</li>
<li><a class="reference external" href="http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/scaffolding.html">Pyramid</a>‘s <cite>pcreate</cite> command for creating Pyramid projects from scaffold templates.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Cookiecutter</a><ul>
<li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#available-templates">Available Templates</a></li>
<li><a class="reference internal" href="#similar-projects">Similar projects</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Cookiecutter: Better Project Templates</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="installation.html"
title="next chapter">Installation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/readme.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Cookiecutter: Better Project Templates"
>previous</a> |</li>
<li><a href="index.html">cookiecutter 0.6.4 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Audrey Roy.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
|