Edit me on GitHub

Installation

Preparation

Follow the steps in Installing Pyramid, but name the virtualenv directory pyramidtut.

Preparation, UNIX

  1. Switch to the pyramidtut directory:

    $ cd pyramidtut
    
  2. Install tutorial dependencies:

    $ bin/easy_install docutils pyramid_tm pyramid_zodbconn \
              pyramid_debugtoolbar nose coverage
    

Preparation, Windows

  1. Switch to the pyramidtut directory:

    c:\> cd pyramidtut
    
  2. Install tutorial dependencies:

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

Make a Project

Your next step is to create a project. For this tutorial, we will use the scaffold named zodb, which generates an application that uses ZODB and traversal. Pyramid supplies a variety of scaffolds to generate sample projects.

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

Note

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

Note

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.

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

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:

c:\pyramidtut\tutorial> ..\Scripts\python setup.py test -q

Expose 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:

$ ../bin/nosetests --cover-package=tutorial --cover-erase --with-coverage

On Windows:

c:\pyramidtut\tutorial> ..\Scripts\nosetests --cover-package=tutorial ^
     --cover-erase --with-coverage

Looks like the code in the zodb scaffold for ZODB projects is missing some test coverage, particularly in the file named models.py.

Start the Application

Start the application.

On UNIX:

$ ../bin/pserve development.ini --reload

On Windows:

c:\pyramidtut\tutorial> ..\Scripts\pserve development.ini --reload

Note

Your OS firewall, if any, may pop up a dialog asking for authorization to allow python to accept incoming network connections.

Visit the Application in a Browser

In a browser, visit http://localhost:6543/. You will see the generated application’s default page.

One thing you’ll notice is the “debug toolbar” icon on right hand side of the page. You can read more about the purpose of the icon at The Debug Toolbar. It allows you to get information about your application while you develop.

Decisions the zodb Scaffold Has Made For You

Creating a project using the zodb scaffold makes the following assumptions:

  • you are willing to use ZODB as persistent storage
  • you are willing to use traversal to map URLs to code.

Note

Pyramid supports any persistent storage mechanism (e.g. a SQL database or filesystem files, etc). Pyramid also supports an additional mechanism to map URLs to code (URL dispatch). However, for the purposes of this tutorial, we’ll only be using traversal and ZODB.