1.1 --- a/README.txt Sat Apr 30 21:23:30 2005 +0000
1.2 +++ b/README.txt Sat Apr 30 21:47:58 2005 +0000
1.3 @@ -15,6 +15,19 @@
1.4
1.5 python tools/demo.py
1.6
1.7 +An introductory guide to creating applications can be found in the docs
1.8 +directory - see docs/index.html for the start page.
1.9 +
1.10 +Contact, Copyright and Licence Information
1.11 +------------------------------------------
1.12 +
1.13 +The current Web page for WebStack at the time of release is:
1.14 +
1.15 +http://www.boddie.org.uk/python/WebStack.html
1.16 +
1.17 +Copyright and licence information can be found in the docs directory - see
1.18 +docs/LICENCE.txt and docs/LICENCE-PyServlet.txt for more information.
1.19 +
1.20 Framework Support
1.21 -----------------
1.22
1.23 @@ -49,6 +62,8 @@
1.24 Standardised deployment for some frameworks (see docs/deploying.html).
1.25 Introductory documentation in XHTML format.
1.26 Added server name and port methods to the transaction.
1.27 +Added a simple demonstration application, incorporating many of the examples
1.28 +and launched under a single script.
1.29
1.30 New in WebStack 0.8 (Changes since WebStack 0.7)
1.31 ------------------------------------------------
1.32 @@ -71,8 +86,8 @@
1.33 Added a method to discover the chosen response stream encoding.
1.34 Fixed field/parameter retrieval so that path and body fields are distinct,
1.35 regardless of the framework employed.
1.36 -Added a method to get a combination of path and body fields (suggested by Jacob
1.37 -Smullyan).
1.38 +Added a method to get a combination of path and body fields (suggested by
1.39 +Jacob Smullyan).
1.40 Introduced Zope 2 support.
1.41 Improved Jython/Java Servlet API support (although a special PyServlet class
1.42 must now be used, and certain libraries must be deployed with applications).
1.43 @@ -90,8 +105,8 @@
1.44 New in WebStack 0.5 (Changes since WebStack 0.4)
1.45 ------------------------------------------------
1.46
1.47 -Changed request body fields/parameters so that they are now represented using
1.48 -Unicode objects rather than plain strings.
1.49 +Changed request body fields/parameters so that they are now represented
1.50 +using Unicode objects rather than plain strings.
1.51 Introduced better support for Unicode in response streams.
1.52
1.53 New in WebStack 0.4 (Changes since WebStack 0.3)
1.54 @@ -99,8 +114,8 @@
1.55
1.56 Added application definition of user identity, permitting alternative
1.57 authentication mechanisms.
1.58 -Improved BaseHTTPRequestHandler and mod_python reliability around fields from
1.59 -request bodies.
1.60 +Improved BaseHTTPRequestHandler and mod_python reliability around fields
1.61 +from request bodies.
1.62 Provided stream and environment parameterisation in the CGI adapter.
1.63 Added LoginRedirect and Login examples.
1.64 Added get_path_without_query and fixed get_path behaviour.
1.65 @@ -128,28 +143,30 @@
1.66 Things to consider for future releases: improved cookie support, redirects,
1.67 access to shared resources and much better documentation.
1.68
1.69 -Field access needs testing, especially for anything using the cgi.FieldStorage
1.70 -class, and the way file uploads are exposed should be reviewed (currently the
1.71 -meta-data is not exposed). The acquisition of fields from specific sources
1.72 -should be tested with different request methods - some frameworks provide path
1.73 -fields in the body fields dictionary, others (eg. Zope) change the fields
1.74 -exposed depending on request method.
1.75 +Field access needs testing, especially for anything using the
1.76 +cgi.FieldStorage class, and the way file uploads are exposed should be
1.77 +reviewed (currently the meta-data is not exposed). The acquisition of fields
1.78 +from specific sources should be tested with different request methods - some
1.79 +frameworks provide path fields in the body fields dictionary, others (eg.
1.80 +Zope) change the fields exposed depending on request method.
1.81
1.82 -Interpretation of path field encodings needs to be verified. Currently, stray
1.83 -path fields are handled (eg. in WebStack.Helpers.Request) as being ISO-8859-1,
1.84 -but it might be the case that some such fields might be submitted as UTF-8.
1.85 +Interpretation of path field encodings needs to be verified. Currently,
1.86 +stray path fields are handled (eg. in WebStack.Helpers.Request) as being
1.87 +ISO-8859-1, but it might be the case that some such fields might be
1.88 +submitted as UTF-8.
1.89
1.90 Cookie objects need defining strictly, especially since the standard library
1.91 -Cookie object behaves differently to mod_python (and possibly Webware) Cookie
1.92 -objects. Moreover, the set_cookie_value method needs to provide access to the
1.93 -usual cookie parameters as supported by the frameworks. The standard library
1.94 -Cookie module has issues with Unicode cookie names (and possibly values) -
1.95 -this is worked around, but it would be best to resolve this comprehensively.
1.96 +Cookie object behaves differently to mod_python (and possibly Webware)
1.97 +Cookie objects. Moreover, the set_cookie_value method needs to provide
1.98 +access to the usual cookie parameters as supported by the frameworks. The
1.99 +standard library Cookie module has issues with Unicode cookie names (and
1.100 +possibly values) - this is worked around, but it would be best to resolve
1.101 +this comprehensively.
1.102
1.103 -UTF-16 (and possibly other encodings) causes problems with HTML form data sent
1.104 -in POST requests using the application/x-www-form-urlencoded content type.
1.105 -This should be reviewed at a later date when proper standardisation has taken
1.106 -place.
1.107 +UTF-16 (and possibly other encodings) causes problems with HTML form data
1.108 +sent in POST requests using the application/x-www-form-urlencoded content
1.109 +type. This should be reviewed at a later date when proper standardisation
1.110 +has taken place.
1.111
1.112 Session support, especially through WebStack.Helpers.Session, should be
1.113 reviewed and be made compatible with non-cookie mechanisms.
1.114 @@ -164,8 +181,8 @@
1.115 introduced into WebStack, thus making response output more efficient (and
1.116 probably also for other frameworks, too).
1.117
1.118 -The algorithm employed in the WebStack.Helpers.Auth.get_token function should
1.119 -be reviewed and improved for better security.
1.120 +The algorithm employed in the WebStack.Helpers.Auth.get_token function
1.121 +should be reviewed and improved for better security.
1.122
1.123 Investigate proper support for HEAD, OPTIONS and other request methods.
1.124
1.125 @@ -194,9 +211,9 @@
1.126 Generating the API Documentation
1.127 --------------------------------
1.128
1.129 -In order to prepare the API documentation, it is necessary to generate some Web
1.130 -pages from the Python source code. For this, the epydoc application must be
1.131 -available on your system. Then, inside the WebStack directory, run the
1.132 +In order to prepare the API documentation, it is necessary to generate some
1.133 +Web pages from the Python source code. For this, the epydoc application must
1.134 +be available on your system. Then, inside the WebStack directory, run the
1.135 apidocs.sh tool script as follows:
1.136
1.137 ./tools/apidocs.sh