summaryrefslogtreecommitdiff
path: root/docs/tutorials/wiki
diff options
context:
space:
mode:
authorStephen Martin <lockwood@opperline.com>2018-09-09 17:05:27 -0700
committerStephen Martin <lockwood@opperline.com>2018-09-09 17:05:27 -0700
commit6b6d0e4c2b4e56523bd41aefd9d462858e03f443 (patch)
tree51aa7bdc1dec89a6109f469934379726ea9fb835 /docs/tutorials/wiki
parent60ab8c81c0e0cda731792cf1ecd540e2d450cc1d (diff)
downloadpyramid-6b6d0e4c2b4e56523bd41aefd9d462858e03f443.tar.gz
pyramid-6b6d0e4c2b4e56523bd41aefd9d462858e03f443.tar.bz2
pyramid-6b6d0e4c2b4e56523bd41aefd9d462858e03f443.zip
merging cookiecutters
Diffstat (limited to 'docs/tutorials/wiki')
-rw-r--r--docs/tutorials/wiki/basiclayout.rst7
-rw-r--r--docs/tutorials/wiki/definingviews.rst2
-rw-r--r--docs/tutorials/wiki/installation.rst35
-rw-r--r--docs/tutorials/wiki/tests.rst11
4 files changed, 32 insertions, 23 deletions
diff --git a/docs/tutorials/wiki/basiclayout.rst b/docs/tutorials/wiki/basiclayout.rst
index a0b365a23..d435e0767 100644
--- a/docs/tutorials/wiki/basiclayout.rst
+++ b/docs/tutorials/wiki/basiclayout.rst
@@ -4,9 +4,10 @@
Basic Layout
============
-The starter files generated by the ``zodb`` cookiecutter are very basic, but
-they provide a good orientation for the high-level patterns common to most
-:term:`traversal`-based (and :term:`ZODB`-based) :app:`Pyramid` projects.
+The starter files generated by the ``zodb`` backend cookiecutter are very
+basic, but they provide a good orientation for the high-level patterns common
+to most :term:`traversal`-based (and :term:`ZODB`-based) :app:`Pyramid`
+projects.
Application configuration with ``__init__.py``
diff --git a/docs/tutorials/wiki/definingviews.rst b/docs/tutorials/wiki/definingviews.rst
index e4183b8f2..91b90e911 100644
--- a/docs/tutorials/wiki/definingviews.rst
+++ b/docs/tutorials/wiki/definingviews.rst
@@ -99,7 +99,7 @@ like the following:
We added some imports and created a regular expression to find "WikiWords".
We got rid of the ``my_view`` view function and its decorator that was added
-when we originally rendered the ``zodb`` cookiecutter. It was only an example and
+when we originally rendered the ``zodb`` backend cookiecutter. It was only an example and
isn't relevant to our application.
Then we added four :term:`view callable` functions to our ``views.py``
diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst
index 7f914267f..c7047664a 100644
--- a/docs/tutorials/wiki/installation.rst
+++ b/docs/tutorials/wiki/installation.rst
@@ -31,7 +31,7 @@ On Unix
.. code-block:: bash
cd ~
- cookiecutter gh:Pylons/pyramid-cookiecutter-zodb --checkout master
+ cookiecutter gh:Pylons/pyramid-cookiecutter-theonecc --checkout master
On Windows
^^^^^^^^^^
@@ -39,7 +39,7 @@ On Windows
.. code-block:: doscon
cd \
- cookiecutter gh:Pylons/pyramid-cookiecutter-zodb --checkout master
+ cookiecutter gh:Pylons/pyramid-cookiecutter-theonecc --checkout master
On all operating systems
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -47,10 +47,20 @@ If prompted for the first item, accept the default ``yes`` by hitting return.
.. code-block:: text
- You've cloned ~/.cookiecutters/pyramid-cookiecutter-zodb before.
+ You've cloned ~/.cookiecutters/pyramid-cookiecutter-theone before.
Is it okay to delete and re-clone it? [yes]: yes
project_name [Pyramid Scaffold]: myproj
repo_name [myproj]: tutorial
+ Select template_language:
+ 1 - jinja2
+ 2 - chameleon
+ 3 - mako
+ Choose from 1, 2, 3 [1]: 1
+ Select backend:
+ 1 - none
+ 2 - sqlalchemy
+ 3 - zodb
+ Choose from 1, 2, 3 [1]: 3
Change directory into your newly created project
------------------------------------------------
@@ -275,10 +285,11 @@ Our package doesn't quite have 100% test coverage.
Test and coverage cookiecutter defaults
---------------------------------------
-Cookiecutters include configuration defaults for ``py.test`` and test coverage.
-These configuration files are ``pytest.ini`` and ``.coveragerc``, located at
-the root of your package. Without these defaults, we would need to specify the
-path to the module on which we want to run tests and coverage.
+The Pyramid cookiecutter includes configuration defaults for ``py.test`` and
+test coverage. These configuration files are ``pytest.ini`` and
+``.coveragerc``, located at the root of your package. Without these defaults,
+we would need to specify the path to the module on which we want to run tests
+and coverage.
On Unix
^^^^^^^
@@ -354,10 +365,10 @@ page. You can read more about the purpose of the icon at
application while you develop.
-Decisions the ``zodb`` cookiecutter has made for you
-----------------------------------------------------
+Decisions the ``zodb`` backend cookiecutter has made for you
+------------------------------------------------------------
-Creating a project using the ``zodb`` cookiecutter makes the following
+Creating a project using the ``zodb`` backend cookiecutter makes the following
assumptions:
- You are willing to use :term:`ZODB` for persistent storage.
@@ -367,10 +378,6 @@ assumptions:
- You want to use pyramid_zodbconn_, pyramid_tm_, and the transaction_ packages
to manage connections and transactions with :term:`ZODB`.
-- You want to use pyramid_chameleon_ to render your templates. Different
- templating engines can be used, but we had to choose one to make this
- tutorial. See :ref:`available_template_system_bindings` for some options.
-
.. note::
:app:`Pyramid` supports any persistent storage mechanism (e.g., an SQL
diff --git a/docs/tutorials/wiki/tests.rst b/docs/tutorials/wiki/tests.rst
index c3a1ca79a..81b020594 100644
--- a/docs/tutorials/wiki/tests.rst
+++ b/docs/tutorials/wiki/tests.rst
@@ -16,16 +16,17 @@ We write tests for the ``model`` classes and the ``appmaker``. Changing
we'll write a test class for the ``appmaker``.
To do so, we'll retain the ``tutorial.tests.ViewTests`` class that was
-generated as part of the ``zodb`` cookiecutter. We'll add three test classes: one
-for the ``Page`` model named ``PageModelTests``, one for the ``Wiki`` model
-named ``WikiModelTests``, and one for the appmaker named ``AppmakerTests``.
+generated as part of the ``zodb`` backend cookiecutter. We'll add three test
+classes: one for the ``Page`` model named ``PageModelTests``, one for the
+``Wiki`` model named ``WikiModelTests``, and one for the appmaker named
+``AppmakerTests``.
Test the views
==============
We'll modify our ``tests.py`` file, adding tests for each view function we
-added previously. As a result, we'll delete the ``ViewTests`` class that
-the ``zodb`` cookiecutter provided, and add four other test classes:
+added previously. As a result, we'll delete the ``ViewTests`` class that the
+``zodb`` backend cookiecutter provided, and add four other test classes:
``ViewWikiTests``, ``ViewPageTests``, ``AddPageTests``, and ``EditPageTests``.
These test the ``view_wiki``, ``view_page``, ``add_page``, and ``edit_page``
views.