summaryrefslogtreecommitdiff
path: root/docs/tutorials
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2016-02-12 02:54:37 -0600
committerMichael Merickel <michael@merickel.org>2016-02-12 02:54:37 -0600
commit23c2d7b337a5873dba0ca6c146e1174136ac2187 (patch)
tree22a57b6d3cfd607cfbc2cedefc92d1d3b0a831d0 /docs/tutorials
parent4872a1e713f894b383990f62cf82c2b21f810c16 (diff)
downloadpyramid-23c2d7b337a5873dba0ca6c146e1174136ac2187.tar.gz
pyramid-23c2d7b337a5873dba0ca6c146e1174136ac2187.tar.bz2
pyramid-23c2d7b337a5873dba0ca6c146e1174136ac2187.zip
update the views/models with setup.py develop
Diffstat (limited to 'docs/tutorials')
-rw-r--r--docs/tutorials/wiki2/definingmodels.rst30
-rw-r--r--docs/tutorials/wiki2/definingviews.rst43
-rw-r--r--docs/tutorials/wiki2/design.rst10
3 files changed, 43 insertions, 40 deletions
diff --git a/docs/tutorials/wiki2/definingmodels.rst b/docs/tutorials/wiki2/definingmodels.rst
index 33e7beb4f..41f36fa26 100644
--- a/docs/tutorials/wiki2/definingmodels.rst
+++ b/docs/tutorials/wiki2/definingmodels.rst
@@ -37,6 +37,36 @@ Open ``tutorial/setup.py`` and edit it to look like the following:
Only the highlighted line needs to be added.
+Running ``setup.py develop``
+============================
+
+Since a new software dependency was added, you will need to run ``python
+setup.py develop`` again inside the root of the ``tutorial`` package to obtain
+and register the newly added dependency distribution.
+
+Make sure your current working directory is the root of the project (the
+directory in which ``setup.py`` lives) and execute the following command.
+
+On UNIX:
+
+.. code-block:: bash
+
+ $ cd tutorial
+ $ $VENV/bin/python setup.py develop
+
+On Windows:
+
+.. code-block:: text
+
+ c:\pyramidtut> cd tutorial
+ c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop
+
+Success executing this command will end with a line to the console something
+like this::
+
+ Finished processing dependencies for tutorial==0.0
+
+
Remove ``mymodel.py``
---------------------
diff --git a/docs/tutorials/wiki2/definingviews.rst b/docs/tutorials/wiki2/definingviews.rst
index 6629839f8..8bccc3fc0 100644
--- a/docs/tutorials/wiki2/definingviews.rst
+++ b/docs/tutorials/wiki2/definingviews.rst
@@ -14,13 +14,12 @@ and a user visits ``http://example.com/foo/bar``, our pattern would be matched
against ``/foo/bar`` and the ``matchdict`` would look like ``{'one':'foo',
'two':'bar'}``.
-Declaring dependencies in our ``setup.py`` file
-===============================================
+Adding the ``docutils`` dependency
+==================================
-The view code in our application will depend on a package which is not a
-dependency of the original "tutorial" application. The original "tutorial"
-application was generated by the ``pcreate`` command; it doesn't know
-about our custom application requirements.
+Remember in the previous chapter we added a new dependency on the ``bcrypt``
+package. Again, the view code in our application will depend on a package which
+is not a dependency of the original "tutorial" application.
We need to add a dependency on the ``docutils`` package to our ``tutorial``
package's ``setup.py`` file by assigning this dependency to the ``requires``
@@ -30,39 +29,13 @@ Open ``tutorial/setup.py`` and edit it to look like the following:
.. literalinclude:: src/views/setup.py
:linenos:
- :emphasize-lines: 20
+ :emphasize-lines: 13
:language: python
Only the highlighted line needs to be added.
-Running ``setup.py develop``
-============================
-
-Since a new software dependency was added, you will need to run ``python
-setup.py develop`` again inside the root of the ``tutorial`` package to obtain
-and register the newly added dependency distribution.
-
-Make sure your current working directory is the root of the project (the
-directory in which ``setup.py`` lives) and execute the following command.
-
-On UNIX:
-
-.. code-block:: bash
-
- $ cd tutorial
- $ $VENV/bin/python setup.py develop
-
-On Windows:
-
-.. code-block:: text
-
- c:\pyramidtut> cd tutorial
- c:\pyramidtut\tutorial> %VENV%\Scripts\python setup.py develop
-
-Success executing this command will end with a line to the console something
-like this::
-
- Finished processing dependencies for tutorial==0.0
+Again, as we did in the previous chapter, the dependency now needs to be
+installed so re-run the ``python setup.py develop`` command.
Adding view functions in ``views/default.py``
=============================================
diff --git a/docs/tutorials/wiki2/design.rst b/docs/tutorials/wiki2/design.rst
index de43447d3..45e2fddd0 100644
--- a/docs/tutorials/wiki2/design.rst
+++ b/docs/tutorials/wiki2/design.rst
@@ -6,7 +6,7 @@ Following is a quick overview of the design of our wiki application to help us
understand the changes that we will be making as we work through the tutorial.
Overall
--------
+=======
We choose to use :term:`reStructuredText` markup in the wiki text. Translation
from reStructuredText to HTML is provided by the widely used ``docutils``
@@ -14,7 +14,7 @@ Python module. We will add this module in the dependency list on the project
``setup.py`` file.
Models
-------
+======
We'll be using an SQLite database to hold our wiki data, and we'll be using
:term:`SQLAlchemy` to access the data in this database.
@@ -41,7 +41,7 @@ be created when the storage is initialized, and will be used as the wiki home
page.
Wiki Views
-----------
+==========
There will be three views to handle the normal operations of adding, editing,
and viewing wiki pages, plus one view for the wiki front page. Two templates
@@ -53,7 +53,7 @@ designer-friendly templating language for Python, modeled after Django's
templates.
Security
---------
+========
We'll eventually be adding security to our application. To do this, we'll
be using a very simple role-based security model. We'll assign a single
@@ -92,7 +92,7 @@ handling login and logout as well as two exception views for handling
invalid access attempts and unhandled URLs.
Summary
--------
+=======
The URL, actions, template, and permission associated to each view are listed
in the following table: