]> gitweb.michael.orlitzky.com - dead/census-tools.git/blob - www/maps/docs/README
Added the start-server helper script, and a README file explaining the Pylons app.
[dead/census-tools.git] / www / maps / docs / README
1 i. About
2
3 The 'maps' directory contains a Pylons[1] project. Pylons is a
4 framework for developing web applications in Python. To "run" the
5 application, you need to host the maps project on a web
6 server. Fortunately, there is a lightweight Python web server provided
7 for you that can do this (at least locally.
8
9 The command to start the server is,
10
11 paster serve --reload development.ini
12
13 which tells the "paster" command that it should load the environment
14 contained in the development.ini file. The --reload argument simply
15 tells the application to reload automatically if any of its files are
16 changed.
17
18 A helper script, start-server will run this command for you. By
19 default, the web server process will run in the foreground. You can
20 tell it to run in the background by ending the command with a '&',
21 e.g.,
22
23 ./start-server &
24
25 Paster will default to running on http://127.0.0.1:5000, which you can
26 visit in your browser.
27
28
29 [1] http://pylonshq.com/
30
31
32 ii. Installation
33
34 Pylons is supplied by most major Linux distributions, but
35 unfortunately, we require version 0.9.7 or greater. If your
36 distribution has a previous version, you can get away with using
37 easy_install to install version 0.9.7. For example, on Ubuntu 9.04,
38
39 sudo apt-get install python-setuptools
40 sudo easy_install Pylons==0.9.7
41
42 Here, the first command installs python-setuptools, the package that
43 contains the easy_install utility.