Skip to content
This repository
tag: 1.0b1
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 264 lines (163 sloc) 7.127 kb

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.

System Message: ERROR/3 (<string>, line 5); backlink

Unknown interpreted text role "ref".

System Message: ERROR/3 (<string>, line 5); backlink

Unknown interpreted text role "ref".

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. 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
    
  3. Use that Python's bin/easy_install to install virtualenv:

    $ /path/to/my/Python-2.6/bin/easy_install virtualenv
    
  4. Use that Python's virtualenv to make a workspace:

    $ path/to/my/Python-2.6/bin/virtualenv --no-site-packages \
              pyramidtut
    
  5. Switch to the pyramidtut directory:

    $ cd pyramidtut
    
  6. (Optional) Consider using source bin/activate to make your shell environment wired to use the virtualenv.

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

    System Message: ERROR/3 (<string>, line 55); backlink

    Unknown interpreted text role "app".

    $ bin/easy_install pyramid
    
  8. Use easy_install to install docutils, repoze.tm, repoze.zodbconn, nose and coverage:

    $ bin/easy_install docutils repoze.tm repoze.zodbconn \
              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:

    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 :app:`Pyramid` and its direct dependencies installed:

    System Message: ERROR/3 (<string>, line 107); backlink

    Unknown interpreted text role "app".

    c:\pyramidtut> Scripts\easy_install pyramid
    
  8. Use easy_install to install docutils, repoze.tm, repoze.zodbconn, nose and coverage:

    c:\pyramidtut> Scripts\easy_install docutils repoze.tm \
          repoze.zodbconn nose coverage
    

Making a Project

Your next step is to create a project. :app:`Pyramid` supplies a variety of templates to generate sample projects. For this tutorial, we will use the :term:`ZODB` -oriented template named pyramid_zodb.

System Message: ERROR/3 (<string>, line 127); backlink

Unknown interpreted text role "app".

System Message: ERROR/3 (<string>, line 127); backlink

Unknown interpreted text role "term".

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

On UNIX:

$ bin/paster create -t pyramid_zodb tutorial

On Windows:

c:\pyramidtut> Scripts\paster create -t pyramid_zodb tutorial

Note

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

System Message: ERROR/3 (<string>, line 155); backlink

Unknown interpreted text role "ref".

On UNIX:

$ cd tutorial
$ ../bin/python setup.py develop

On Windows:

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

Running 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

Starting the Application

Start the application.

On UNIX:

$ ../bin/paster serve development.ini --reload

On Windows:

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:

$ ../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 pyramid_zodb template 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/. You will see the generated application's default page.

Decisions the pyramid_zodb Template Has Made For You

Creating a project using the pyramid_zodb template makes the following assumptions:

  • you are willing to use :term:`ZODB` as persistent storage

    System Message: ERROR/3 (<string>, line 250); backlink

    Unknown interpreted text role "term".

  • you are willing to use :term:`traversal` to map URLs to code.

    System Message: ERROR/3 (<string>, line 252); backlink

    Unknown interpreted text role "term".

  • you want to use imperative code plus a :term:`scan` to perform configuration.

    System Message: ERROR/3 (<string>, line 254); backlink

    Unknown interpreted text role "term".

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.

System Message: ERROR/3 (<string>, line 259); backlink

Unknown interpreted text role "app".

System Message: ERROR/3 (<string>, line 259); backlink

Unknown interpreted text role "app".

System Message: ERROR/3 (<string>, line 259); backlink

Unknown interpreted text role "term".
Something went wrong with that request. Please try again.