36.3. INSTALLATION

36.3 Installation

For the most part, the installation process for this tutorial duplicates the steps described in Installing Pyramid and Creating a Pyramid Project, however it also explains how to install additional libraries for tutorial purposes.

36.3.1 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

1.If you don’t already have a Python 2.6 interpreter installed on your system, obtain, install, or find Python 2.6 for your system.

2.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.

3.Install the latest setuptools into the Python you obtained/installed/found in the step above: download ez_setup.py and run it using the python interpreter of your Python 2.6 installation:

$/path/to/my/Python-2.6/bin/python ez_setup.py

4.Use that Python’s bin/easy_install to install virtualenv:

$/path/to/my/Python-2.6/bin/easy_install virtualenv

5.Use that Python’s virtualenv to make a workspace:

$ path/to/my/Python-2.6/bin/virtualenv --no-site-packages \ pyramidtut

6. Switch to the pyramidtut directory:

393

36. ZODB + TRAVERSAL WIKI TUTORIAL

$cd pyramidtut

7.(Optional) Consider using source bin/activate to make your shell environment wired to use the virtualenv.

8.Use easy_install to get Pyramid and its direct dependencies installed:

$bin/easy_install pyramid

9.Use easy_install to install docutils, pyramid_tm, pyramid_zodbconn, pyramid_debugtoolbar, nose and coverage:

$ bin/easy_install docutils pyramid_tm pyramid_zodbconn \ pyramid_debugtoolbar nose coverage

Preparation, Windows

1.Install, or find Python 2.6 for your system.

2.Install the latest setuptools into the Python you obtained/installed/found in the step above: download ez_setup.py and run it using the python interpreter of your Python 2.6 installation using a command prompt:

c:\> c:\Python26\python ez_setup.py

3. Use that Python’s bin/easy_install to install virtualenv:

c:\> c:\Python26\Scripts\easy_install virtualenv

4. Use that Python’s virtualenv to make a workspace:

c:\> c:\Python26\Scripts\virtualenv --no-site-packages pyramidtut

5. Switch to the pyramidtut directory:

394

36.3. INSTALLATION

c:\> cd pyramidtut

6.(Optional) Consider using bin\activate.bat to make your shell environment wired to use the virtualenv.

7.Use easy_install to get Pyramid and its direct dependencies installed:

c:\pyramidtut> Scripts\easy_install pyramid

8.Use easy_install to install docutils, pyramid_tm, pyramid_zodbconn, pyramid_debugtoolbar, nose and coverage:

c:\pyramidtut> Scripts\easy_install docutils pyramid_tm \ pyramid_zodbconn pyramid_debugtoolbar nose coverage

36.3.2 Make a Project

Your next step is to create a project. Pyramid supplies a variety of scaffolds to generate sample projects. For this tutorial, we will use the ZODB -oriented scaffold named zodb.

The below instructions assume your current working directory is the “virtualenv” named “pyramidtut”.

On UNIX:

$ bin/pcreate -s zodb tutorial

On Windows:

c:\pyramidtut> Scripts\pcreate -s zodb tutorial

latex-note.png

You don’t have to call it tutorial – the code uses relative paths for imports and finding templates and static resources.

395

36. ZODB + TRAVERSAL WIKI TUTORIAL

latex-note.png

If you are using Windows, the zodb 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.

36.3.3 Install 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 Make a Project, and run the “setup.py develop” command using virtualenv Python interpreter.

On UNIX:

$ cd tutorial

$ ../bin/python setup.py develop

On Windows:

C:\pyramidtut> cd tutorial

C:\pyramidtut\tutorial> ..\Scripts\python setup.py develop

36.3.4 Run the Tests

After you’ve installed the project in development mode, you may run the tests for the project.

On UNIX:

$ ../bin/python setup.py test -q

On Windows:

396