summaryrefslogtreecommitdiff
path: root/docs/narr/cookiecutters.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/narr/cookiecutters.rst')
-rw-r--r--docs/narr/cookiecutters.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/narr/cookiecutters.rst b/docs/narr/cookiecutters.rst
new file mode 100644
index 000000000..bb4c61616
--- /dev/null
+++ b/docs/narr/cookiecutters.rst
@@ -0,0 +1,20 @@
+.. _cookiecutters:
+
+Pyramid cookiecutters
+=====================
+
+.. versionadded:: 1.8
+
+A :term:`cookiecutter` is a command-line utility that creates projects from :ref:`cookiecutters <cookiecutter:readme>` (project templates), e.g., creating a Python package project from a Python package project template.
+
+Pyramid cookiecutters have replaced the now deprecated Pyramid scaffolds, and should be used going forward. Pyramid cookiecutters released under the Pylons Project include:
+
+* `pyramid-cookiecutter-alchemy <https://github.com/Pylons/pyramid-cookiecutter-alchemy>`_
+* `pyramid-cookiecutter-starter <https://github.com/Pylons/pyramid-cookiecutter-starter>`_
+* `pyramid-cookiecutter-zodb <https://github.com/Pylons/pyramid-cookiecutter-zodb>`_
+
+Development of cookiecutters is documented under `Learn the Basics of Cookiecutter by Creating a Cookiecutter <https://cookiecutter.readthedocs.io/en/latest/first_steps.html>`_.
+
+.. seealso:: See also `Cookiecutter Features <https://cookiecutter.readthedocs.io/en/latest/readme.html#features>`_.
+
+.. seealso:: See also :term:`scaffold`.