summaryrefslogtreecommitdiff
path: root/docs/quick_tutorial
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/quick_tutorial
parent60ab8c81c0e0cda731792cf1ecd540e2d450cc1d (diff)
downloadpyramid-6b6d0e4c2b4e56523bd41aefd9d462858e03f443.tar.gz
pyramid-6b6d0e4c2b4e56523bd41aefd9d462858e03f443.tar.bz2
pyramid-6b6d0e4c2b4e56523bd41aefd9d462858e03f443.zip
merging cookiecutters
Diffstat (limited to 'docs/quick_tutorial')
-rw-r--r--docs/quick_tutorial/cookiecutters.rst24
-rw-r--r--docs/quick_tutorial/databases.rst2
2 files changed, 21 insertions, 5 deletions
diff --git a/docs/quick_tutorial/cookiecutters.rst b/docs/quick_tutorial/cookiecutters.rst
index 045808884..dee301a12 100644
--- a/docs/quick_tutorial/cookiecutters.rst
+++ b/docs/quick_tutorial/cookiecutters.rst
@@ -24,17 +24,17 @@ Steps
$VENV/bin/pip install cookiecutter
-#. Let's use the cookiecutter ``pyramid-cookiecutter-starter`` to create a starter :app:`Pyramid` project in the current directory, entering values at the prompts as shown below for the following command.
+#. Let's use the cookiecutter ``pyramid-cookiecutter-theonecc`` to create a starter :app:`Pyramid` project in the current directory, entering values at the prompts as shown below for the following command.
.. code-block:: bash
- $VENV/bin/cookiecutter gh:Pylons/pyramid-cookiecutter-starter --checkout master
+ $VENV/bin/cookiecutter gh:Pylons/pyramid-cookiecutter-theonecc --checkout master
If prompted for the first item, accept the default ``yes`` by hitting return.
.. code-block:: text
- You've cloned ~/.cookiecutters/pyramid-cookiecutter-starter before.
+ You've cloned ~/.cookiecutters/pyramid-cookiecutter-theonecc before.
Is it okay to delete and re-clone it? [yes]: yes
project_name [Pyramid Scaffold]: cc_starter
repo_name [cc_starter]: cc_starter
@@ -43,6 +43,11 @@ Steps
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]: 1
#. We then run through the following commands.
@@ -57,6 +62,17 @@ Steps
# ...and into which we install our project.
env/bin/pip install -e .
+ **Note:** If you selected ``sqlalchemy`` in the preceding step, continue. Otherwise, skip to the next step.
+
+ .. code-block:: bash
+
+ # Generate your first revision.
+ env/bin/alembic -c development.ini revision --autogenerate -m "init"
+ # Upgrade to that revision.
+ env/bin/alembic -c development.ini upgrade head
+ # Load default data.
+ env/bin/initialize_cc_starter_db development.ini
+
#. Start up the application by pointing :app:`Pyramid`'s ``pserve`` command at the
project's (generated) configuration file:
@@ -79,7 +95,7 @@ Analysis
========
Rather than starting from scratch, a cookiecutter can make it easy to get a Python
-project containing a working :app:`Pyramid` application. The Pylons Project provides `several cookiecutters <https://github.com/Pylons?q=pyramid-cookiecutter>`_.
+project containing a working :app:`Pyramid` application.
``pserve`` is :app:`Pyramid`'s application runner, separating operational details from
your code. When you install :app:`Pyramid`, a small command program called ``pserve``
diff --git a/docs/quick_tutorial/databases.rst b/docs/quick_tutorial/databases.rst
index 7d10f2470..7d28f4ba2 100644
--- a/docs/quick_tutorial/databases.rst
+++ b/docs/quick_tutorial/databases.rst
@@ -21,7 +21,7 @@ storage and retrieval for the wiki pages in the previous step.
.. note::
- The ``pyramid-cookiecutter-alchemy`` cookiecutter is really helpful for getting an SQLAlchemy
+ The Pyramid cookiecutter is really helpful for getting an SQLAlchemy
project going, including generation of the console script. Since we want to
see all the decisions, we will forgo convenience in this tutorial, and wire
it up ourselves.