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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
============
Installation
============
For the most part, the installation process for this tutorial
duplicates the steps described in :ref:`installing_chapter` and
:ref:`project_narr`, however it also explains how to install
additional libraries for tutorial purposes.
Preparation
========================
Please take the following steps to prepare for the tutorial. The
steps to prepare for the tutorial are slightly different depending on
whether you're using UNIX or Windows.
Preparation, UNIX
-----------------
#. If you don't already have a Python 2.6 interpreter installed on
your system, obtain, install, or find `Python 2.6
<http://python.org/download/releases/2.6.6/>`_ for your system.
#. Make sure the Python development headers are installed on your system. If
you've installed Python from source, these will already be installed. If
you're using a system Python, you may have to install a ``python-dev``
package (e.g. ``apt-get python-dev``). The headers are not required for
Pyramid itself, just for dependencies of the tutorial.
#. Install the latest `setuptools` into the Python you
obtained/installed/found in the step above: download `ez_setup.py
<http://peak.telecommunity.com/dist/ez_setup.py>`_ and run it using
the ``python`` interpreter of your Python 2.6 installation:
.. code-block:: text
$ /path/to/my/Python-2.6/bin/python ez_setup.py
#. Use that Python's `bin/easy_install` to install `virtualenv`:
.. code-block:: text
$ /path/to/my/Python-2.6/bin/easy_install virtualenv
#. Use that Python's virtualenv to make a workspace:
.. code-block:: text
$ path/to/my/Python-2.6/bin/virtualenv --no-site-packages \
pyramidtut
#. Switch to the ``pyramidtut`` directory:
.. code-block:: text
$ cd pyramidtut
#. (Optional) Consider using ``source bin/activate`` to make your
shell environment wired to use the virtualenv.
#. Use ``easy_install`` to get :app:`Pyramid` and its direct
dependencies installed:
.. code-block:: text
$ bin/easy_install pyramid
#. Use ``easy_install`` to install ``docutils``, ``repoze.tm2``,
``repoze.zodbconn``, ``nose`` and ``coverage``:
.. code-block:: text
$ bin/easy_install docutils repoze.tm2 repoze.zodbconn \
nose coverage
Preparation, Windows
--------------------
#. Install, or find `Python 2.6
<http://python.org/download/releases/2.6.6/>`_ for your system.
#. Install the latest `setuptools` into the Python you
obtained/installed/found in the step above: download `ez_setup.py
<http://peak.telecommunity.com/dist/ez_setup.py>`_ and run it using
the ``python`` interpreter of your Python 2.6 installation using a
command prompt:
.. code-block:: text
c:\> c:\Python26\python ez_setup.py
#. Use that Python's `bin/easy_install` to install `virtualenv`:
.. code-block:: text
c:\> c:\Python26\Scripts\easy_install virtualenv
#. Use that Python's virtualenv to make a workspace:
.. code-block:: text
c:\> c:\Python26\Scripts\virtualenv --no-site-packages pyramidtut
#. Switch to the ``pyramidtut`` directory:
.. code-block:: text
c:\> cd pyramidtut
#. (Optional) Consider using ``bin\activate.bat`` to make your shell
environment wired to use the virtualenv.
#. Use ``easy_install`` to get :app:`Pyramid` and its direct
dependencies installed:
.. code-block:: text
c:\pyramidtut> Scripts\easy_install pyramid
#. Use ``easy_install`` to install ``docutils``, ``repoze.tm2``,
``repoze.zodbconn``, ``nose`` and ``coverage``:
.. code-block:: text
c:\pyramidtut> Scripts\easy_install docutils repoze.tm2 \
repoze.zodbconn nose coverage
.. _making_a_project:
Making a Project
================
Your next step is to create a project. :app:`Pyramid` supplies a
variety of scaffolds to generate sample projects. For this tutorial,
we will use the :term:`ZODB` -oriented scaffold named ``pyramid_zodb``.
The below instructions assume your current working directory is the
"virtualenv" named "pyramidtut".
On UNIX:
.. code-block:: text
$ bin/paster create -t pyramid_zodb tutorial
On Windows:
.. code-block:: text
c:\pyramidtut> Scripts\paster create -t pyramid_zodb tutorial
.. note:: If you are using Windows, the ``pyramid_zodb`` Paster scaffold
doesn't currently deal gracefully with installation into a location
that contains spaces in the path. If you experience startup
problems, try putting both the virtualenv and the project into
directories that do not contain spaces in their paths.
Installing the Project in "Development Mode"
============================================
In order to do development on the project easily, you must "register"
the project as a development egg in your workspace using the
``setup.py develop`` command. In order to do so, cd to the "tutorial"
directory you created in :ref:`making_a_project`, and run the
"setup.py develop" command using virtualenv Python interpreter.
On UNIX:
.. code-block:: text
$ cd tutorial
$ ../bin/python setup.py develop
On Windows:
.. code-block:: text
C:\pyramidtut> cd tutorial
C:\pyramidtut\tutorial> ..\Scripts\python setup.py develop
.. _running_tests:
Running the Tests
=================
After you've installed the project in development mode, you may run
the tests for the project.
On UNIX:
.. code-block:: text
$ ../bin/python setup.py test -q
On Windows:
.. code-block:: text
c:\pyramidtut\tutorial> ..\Scripts\python setup.py test -q
Starting the Application
========================
Start the application.
On UNIX:
.. code-block:: text
$ ../bin/paster serve development.ini --reload
On Windows:
.. code-block:: text
c:\pyramidtut\tutorial> ..\Scripts\paster serve development.ini --reload
Exposing Test Coverage Information
==================================
You can run the ``nosetests`` command to see test coverage
information. This runs the tests in the same way that ``setup.py
test`` does but provides additional "coverage" information, exposing
which lines of your project are "covered" (or not covered) by the
tests.
On UNIX:
.. code-block:: text
$ ../bin/nosetests --cover-package=tutorial --cover-erase --with-coverage
On Windows:
.. code-block:: text
c:\pyramidtut\tutorial> ..\Scripts\nosetests --cover-package=tutorial \
--cover-erase --with-coverage
Looks like the code in the ``pyramid_zodb`` scaffold for ZODB projects is
missing some test coverage, particularly in the file named
``models.py``.
Visit the Application in a Browser
==================================
In a browser, visit `http://localhost:6543/ <http://localhost:6543>`_.
You will see the generated application's default page.
Decisions the ``pyramid_zodb`` Scaffold Has Made For You
========================================================
Creating a project using the ``pyramid_zodb`` scaffold makes the following
assumptions:
- you are willing to use :term:`ZODB` as persistent storage
- you are willing to use :term:`traversal` to map URLs to code.
- you want to use imperative code plus a :term:`scan` to perform
configuration.
.. note::
:app:`Pyramid` supports any persistent storage mechanism (e.g. a SQL
database or filesystem files, etc). :app:`Pyramid` also supports an
additional mechanism to map URLs to code (:term:`URL dispatch`). However,
for the purposes of this tutorial, we'll only be using traversal and ZODB.
|
