paulb@350 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
paulb@327 | 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
paulb@327 | 3 | <head> |
paulb@327 | 4 | <title>Creating Web Applications with WebStack</title> |
paulb@350 | 5 | <meta name="generator" |
paulb@350 | 6 | content="amaya 8.1a, see http://www.w3.org/Amaya/" /> |
paulb@328 | 7 | <link href="styles.css" rel="stylesheet" type="text/css" /> |
paulb@327 | 8 | </head> |
paulb@327 | 9 | <body> |
paulb@327 | 10 | <h1>Creating Web Applications with WebStack</h1> |
paulb@354 | 11 | <p>This introductory guide describes the process of making a Web |
paulb@350 | 12 | application |
paulb@327 | 13 | using the WebStack framework.</p> |
paulb@327 | 14 | <h2>Setting Up</h2> |
paulb@327 | 15 | <p>First of all, let us assume that the WebStack distribution has been |
paulb@327 | 16 | unpacked and now sits in the <code>WebStack-0.9</code> directory.</p> |
paulb@350 | 17 | <p>Before we begin, we must make sure that the WebStack package is |
paulb@350 | 18 | available |
paulb@327 | 19 | to Python. The easiest way to do this is to change into the |
paulb@327 | 20 | <code>WebStack-0.9</code> directory and to run the <code>setup.py</code> |
paulb@327 | 21 | script provided with the version of Python you are going to be using |
paulb@327 | 22 | (possibly as a privileged user like <code>root</code>):</p> |
paulb@328 | 23 | <pre>cd WebStack-0.9<br />python setup.py install</pre> |
paulb@350 | 24 | <p>If you don't want to install WebStack in this way, or if you can't |
paulb@350 | 25 | do so |
paulb@350 | 26 | because you don't have <code>root</code> privileges, you can just make |
paulb@350 | 27 | sure |
paulb@350 | 28 | that the <code>WebStack-0.9</code> directory sits on your |
paulb@327 | 29 | <code>PYTHONPATH</code>.</p> |
paulb@356 | 30 | <h2>Viewing the API Documentation</h2> |
paulb@356 | 31 | <p>The API documentation for use in conjunction with this |
paulb@356 | 32 | guide can be found inside the <a href="../apidocs/index.html"><code>apidocs</code></a> |
paulb@356 | 33 | directory within the <code>WebStack-0.9</code> directory. Of course, |
paulb@356 | 34 | it is always possible to view WebStack's API documentation |
paulb@356 | 35 | within Python by importing modules (such as <a |
paulb@356 | 36 | href="../apidocs/public/WebStack.Generic-module.html"><code>WebStack.Generic</code></a>) |
paulb@354 | 37 | and using Python's built-in <code>help</code> function.</p> |
paulb@327 | 38 | <h2>About WebStack Applications</h2> |
paulb@327 | 39 | <ul> |
paulb@327 | 40 | <li><a href="anatomy.html">Anatomy of a WebStack Application</a></li> |
paulb@328 | 41 | <li><a href="securing.html">Securing a WebStack Application</a></li> |
paulb@328 | 42 | <li><a href="deploying.html">Deploying a WebStack Application</a></li> |
paulb@354 | 43 | <li><a href="integrating.html">Integrating with Other Systems</a></li> |
paulb@366 | 44 | <li>Technical note: <a href="features.html">Support for WebStack |
paulb@366 | 45 | Features in Server Environments</a></li> |
paulb@327 | 46 | </ul> |
paulb@327 | 47 | </body> |
paulb@327 | 48 | </html> |