Creating Web Applications with WebStack

This introductory guide describes the process of making a Web application using the WebStack framework.

Setting Up

First of all, let us assume that the WebStack distribution has been unpacked and now sits in the WebStack-0.9 directory.

Before we begin, we must make sure that the WebStack package is available to Python. The easiest way to do this is to change into the WebStack-0.9 directory and to run the setup.py script provided with the version of Python you are going to be using (possibly as a privileged user like root):

cd WebStack-0.9
python setup.py install

If you don't want to install WebStack in this way, or if you can't do so because you don't have root privileges, you can just make sure that the WebStack-0.9 directory sits on your PYTHONPATH.

Generating the API Documentation

In order to view the API documentation in conjunction with this guide, it is necessary to generate some Web pages from the Python source code. For this, the epydoc application must be available on your system. Then, change into the WebStack-0.9 directory and run the apidocs.sh tool script as follows:

cd WebStack-0.9
./tools/apidocs.sh

Some warnings may be generated by the script, but the result should be a new apidocs directory within the WebStack-0.9 directory. Of course, it is always possible to view documentation within Python by importing modules (such as WebStack.Generic) and using Python's built-in help function.

About WebStack Applications