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
|
============
Installation
============
This tutorial assumes that Python and virtualenv are already installed
and working in your system. If you need help setting this up, you should
refer to the chapters on :ref:`installing_chapter`.
Preparation
===========
Please take the following steps to prepare for the tutorial. The
steps are slightly different depending on whether you're using UNIX or
Windows.
Preparation, UNIX
-----------------
#. Install SQLite3 and its development packages if you don't already
have them installed. Usually this is via your system's package
manager. For example, on a Debian Linux system, do ``sudo apt-get
install libsqlite3-dev``.
#. Use your 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
#. Use ``easy_install`` to get :app:`Pyramid` and its direct
dependencies installed:
.. code-block:: text
$ bin/easy_install pyramid
#. Use ``easy_install`` to install various packages from PyPI.
.. code-block:: text
$ bin/easy_install docutils nose coverage zope.sqlalchemy \
SQLAlchemy repoze.tm2
Preparation, Windows
--------------------
#. Use your 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
#. 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 various packages from PyPI.
.. code-block:: text
c:\pyramidtut> Scripts\easy_install -i docutils \
nose coverage zope.sqlalchemy SQLAlchemy repoze.tm2
.. _sql_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. We will use the
``pyramid_routesalchemy`` scaffold, which generates an application
that uses :term:`SQLAlchemy` and :term:`URL dispatch`.
The below instructions assume your current working directory is the
"virtualenv" named "pyramidtut".
On UNIX:
.. code-block:: text
$ bin/paster create -t pyramid_routesalchemy tutorial
On Windows:
.. code-block:: text
c:\pyramidtut> Scripts\paster create -t pyramid_routesalchemy tutorial
.. note:: If you are using Windows, the ``pyramid_routesalchemy``
scaffold may not 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:`sql_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
.. _sql_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.
To get this functionality working, we'll need to install a couple of
other packages into our ``virtualenv``: ``nose`` and ``coverage``:
On UNIX:
.. code-block:: text
$ ../bin/easy_install nose coverage
On Windows:
.. code-block:: text
c:\pyramidtut\tutorial> ..\Scripts\easy_install nose coverage
Once ``nose`` and ``coverage`` are installed, we can actually run the
coverage 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 our package's ``models`` module doesn't quite have 100%
test coverage.
Visit the Application in a Browser
==================================
In a browser, visit ``http://localhost:6543/``. You will see the
generated application's default page.
Decisions the ``pyramid_routesalchemy`` Scaffold Has Made For You
=================================================================
Creating a project using the ``pyramid_routesalchemy`` scaffold makes
the following assumptions:
- you are willing to use :term:`SQLAlchemy` as a database access tool
- you are willing to use :term:`url dispatch` to map URLs to code.
- you want to configure your application *imperatively* (no
:term:`declarative configuration` such as ZCML).
.. note::
:app:`Pyramid` supports any persistent storage mechanism (e.g. object
database or filesystem files, etc). It also supports an additional
mechanism to map URLs to code (:term:`traversal`). However, for the
purposes of this tutorial, we'll only be using url dispatch and
SQLAlchemy.
|
