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