This is a quick guide to getting Pyramid set up, it should be good enough for most use cases. If you run into some problem and need more detailed help or if you are using a different platform, please consult our detailed installation guide.
You will need Python version 2.6 or better (or Python 3.2) to run Pyramid. Get Python now.
Pyramid is known to run on all popular Unix-like systems such as Linux, MacOS X, and FreeBSD as well as on Windows platforms. It is also known to run on Google’s App Engine and Jython.
It is best practice to install Pyramid into a “virtual” Python environment in order to obtain isolation from any “system” packages you’ve got installed in your Python version. This can be done by using the virtualenv package. Using a virtualenv will also prevent Pyramid from globally installing versions of packages that are not compatible with your system Python.
To install virtualenv you will need setuptools. Once you’ve got setuptools installed, you should install the virtualenv package using the easy_install command.
$ easy_install virtualenv
After you’ve got your env virtualenv installed, you may install Pyramid itself using the following commands from within the virtualenv (env) directory:
$ bin/easy_install pyramid
This command will take longer than the previous ones to complete, as it downloads and installs a number of dependencies.
When you easy_install Pyramid, various Zope libraries, various Chameleon libraries, WebOb, Paste, PasteScript, and PasteDeploy libraries are installed.
Additionally, as chronicled in project_narr, PasteScript (aka paster) templates will be registered that make it easy to start a new Pyramid project.