WebStack

Annotated docs/index.html

656:100da1109ca3
2007-09-08 paulb [project @ 2007-09-08 17:04:24 by paulb] Added missing copyright file.
paulb@654 1
<?xml version="1.0" encoding="iso-8859-1"?>
paulb@350 2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
paulb@410 3
<html xmlns="http://www.w3.org/1999/xhtml"><head>
paulb@654 4
  <title>Creating Web Applications with WebStack</title>
paulb@410 5
  <link href="styles.css" rel="stylesheet" type="text/css" /></head>
paulb@327 6
<body>
paulb@327 7
<h1>Creating Web Applications with WebStack</h1>
paulb@354 8
<p>This introductory guide describes the process of making a Web
paulb@350 9
application
paulb@327 10
using the WebStack framework.</p>
paulb@327 11
<h2>Setting Up</h2>
paulb@327 12
<p>First of all, let us assume that the WebStack distribution has been
paulb@649 13
unpacked and now sits in the <code>WebStack-1.2.5</code> directory.</p>
paulb@350 14
<p>Before we begin, we must make sure that the WebStack package is
paulb@350 15
available
paulb@327 16
to Python. The easiest way to do this is to change into the
paulb@649 17
<code>WebStack-1.2.5</code> directory and to run the <code>setup.py</code>
paulb@327 18
script provided with the version of Python you are going to be using
paulb@327 19
(possibly as a privileged user like <code>root</code>):</p>
paulb@649 20
<pre>cd WebStack-1.2.5<br />python setup.py install</pre>
paulb@350 21
<p>If you don't want to install WebStack in this way, or if you can't
paulb@350 22
do so
paulb@350 23
because you don't have <code>root</code> privileges, you can just make
paulb@350 24
sure
paulb@649 25
that the <code>WebStack-1.2.5</code> directory sits on your
paulb@327 26
<code>PYTHONPATH</code>.</p>
paulb@582 27
<h2>Supported Frameworks</h2><p>With the help of Python's built-in
paulb@582 28
standard library, WebStack can run without any additional software, but
paulb@582 29
you may wish to investigate the other supported frameworks in order to
paulb@582 30
run WebStack applications in other environments.</p><ul><li><a href="supported-frameworks.html">Supported Frameworks</a></li></ul><h2>Viewing the API Documentation</h2>
paulb@356 31
<p>The API documentation for use in conjunction with this
paulb@654 32
guide can be found inside the <a href="../apidocs/index.html"><code>apidocs</code></a>
paulb@649 33
directory within the <code>WebStack-1.2.5</code> directory. Of course,
paulb@356 34
it is always possible to view WebStack's API documentation
paulb@654 35
within Python by importing modules (such as <a href="../apidocs/public/WebStack.Generic-module.html"><code>WebStack.Generic</code></a>)
paulb@654 36
and using Python's built-in <code>help</code> function.</p>
paulb@327 37
<h2>About WebStack Applications</h2>
paulb@327 38
<ul>
paulb@488 39
  <li><a href="anatomy.html">Anatomy of a WebStack Application</a></li><li><a href="developing.html">Developing a WebStack Application</a></li></ul>
paulb@608 40
</body></html>