paulb@68 | 1 | Introduction
|
paulb@68 | 2 | ------------
|
paulb@68 | 3 |
|
paulb@301 | 4 | WebStack is a package which provides a common API for Python Web
|
paulb@301 | 5 | applications, regardless of the underlying server or framework environment.
|
paulb@301 | 6 | It should be possible with WebStack to design and implement an application,
|
paulb@301 | 7 | to choose a deployment environment, and then to be able to deploy the
|
paulb@301 | 8 | application in a different environment later on without having to go back
|
paulb@301 | 9 | and rewrite substantial parts of the application.
|
paulb@60 | 10 |
|
paulb@362 | 11 | Quick Start
|
paulb@362 | 12 | -----------
|
paulb@362 | 13 |
|
paulb@362 | 14 | Try running the demo:
|
paulb@362 | 15 |
|
paulb@362 | 16 | python tools/demo.py
|
paulb@362 | 17 |
|
paulb@363 | 18 | An introductory guide to creating applications can be found in the docs
|
paulb@363 | 19 | directory - see docs/index.html for the start page.
|
paulb@363 | 20 |
|
paulb@363 | 21 | Contact, Copyright and Licence Information
|
paulb@363 | 22 | ------------------------------------------
|
paulb@363 | 23 |
|
paulb@363 | 24 | The current Web page for WebStack at the time of release is:
|
paulb@363 | 25 |
|
paulb@363 | 26 | http://www.boddie.org.uk/python/WebStack.html
|
paulb@363 | 27 |
|
paulb@363 | 28 | Copyright and licence information can be found in the docs directory - see
|
paulb@413 | 29 | docs/COPYING.txt, docs/LICENCE.txt and docs/LICENCE-PyServlet.txt for more
|
paulb@413 | 30 | information.
|
paulb@363 | 31 |
|
paulb@68 | 32 | Framework Support
|
paulb@68 | 33 | -----------------
|
paulb@68 | 34 |
|
paulb@580 | 35 | See the docs/supported-frameworks.html document for more information.
|
paulb@388 | 36 |
|
paulb@631 | 37 | New in WebStack 1.2.3 (Changes since WebStack 1.2.2)
|
paulb@631 | 38 | ----------------------------------------------------
|
paulb@631 | 39 |
|
paulb@631 | 40 | * Fixed inadvertent OpenSSL dependency, noticed by John Krukoff.
|
paulb@631 | 41 |
|
paulb@619 | 42 | New in WebStack 1.2.2 (Changes since WebStack 1.2.1)
|
paulb@619 | 43 | ----------------------------------------------------
|
paulb@619 | 44 |
|
paulb@619 | 45 | * Added an EncodingSelector class for the setting of default encodings on
|
paulb@619 | 46 | transactions.
|
paulb@619 | 47 | * Added some documentation about path processing strategies.
|
paulb@625 | 48 | * Added a secure variant of the BaseHTTPServer provided in the adapter for
|
paulb@625 | 49 | BaseHTTPRequestHandler.
|
paulb@619 | 50 |
|
paulb@606 | 51 | New in WebStack 1.2.1 (Changes since WebStack 1.2)
|
paulb@606 | 52 | --------------------------------------------------
|
paulb@606 | 53 |
|
paulb@606 | 54 | * Fixed mod_python get_content_type method.
|
paulb@615 | 55 | * Fixed LoginResource form field processing; changed the field type to
|
paulb@615 | 56 | password.
|
paulb@615 | 57 | * Exposed LoginResource and LoginRedirectResource page contents as
|
paulb@615 | 58 | attributes.
|
paulb@615 | 59 | * Added documentation about extending LoginRedirectResource and using
|
paulb@615 | 60 | PathSelector to remember an application's root path.
|
paulb@615 | 61 | * Changed handle_errors to 1 throughout the examples.
|
paulb@606 | 62 |
|
paulb@542 | 63 | New in WebStack 1.2 (Changes since WebStack 1.1.2)
|
paulb@542 | 64 | --------------------------------------------------
|
paulb@542 | 65 |
|
paulb@542 | 66 | * Added support for Django.
|
paulb@542 | 67 | * Fixed documentation about the representation of file upload fields.
|
paulb@552 | 68 | * Changed mod_python, Java Servlet and Webware (> 0.8.1) deployment to use a
|
paulb@552 | 69 | deploy function instead of more complicated configuration mechanisms.
|
paulb@542 | 70 | * Improved mod_python deployment documentation and tools so that cleaner
|
paulb@542 | 71 | application paths/URLs can now be used.
|
paulb@542 | 72 | * Moved user and path_info default definitions into WebStack.Generic as
|
paulb@542 | 73 | class attributes.
|
paulb@542 | 74 | * Fixed encoding usage issues with path fields when using get_fields in a
|
paulb@542 | 75 | Zope environment.
|
paulb@550 | 76 | * Added a FileResource class to WebStack.Resources.Static.
|
paulb@565 | 77 | * Made DirectoryRepository convert filenames to Unicode in all cases.
|
paulb@568 | 78 | * Renamed the Apache and Java Servlet tools, making them scripts which are
|
paulb@568 | 79 | installed by setup.py.
|
paulb@584 | 80 | * Fixed CGI content charsets and languages support.
|
paulb@587 | 81 | * Fixed CGI cookie output.
|
paulb@587 | 82 | * Added URL overriding in the LoginRedirectResource.
|
paulb@587 | 83 | * Exposed a get_target function from WebStack.Resources.Login in order to
|
paulb@587 | 84 | better support alternative login resources.
|
paulb@592 | 85 | * Added improved error reporting for BaseHTTPRequestHandler, CGI, Django and
|
paulb@592 | 86 | WSGI.
|
paulb@597 | 87 | * Added a traverse_path method to the Transaction class.
|
paulb@597 | 88 | * Made a path_encoding alias for urlencoding in the initialisation of
|
paulb@597 | 89 | WebStack.Resources.ResourceMap objects.
|
paulb@597 | 90 | * Added a Selectors module to WebStack.Resources in order to support common
|
paulb@597 | 91 | resource selection patterns.
|
paulb@542 | 92 |
|
paulb@536 | 93 | New in WebStack 1.1.2 (Changes since WebStack 1.1.1)
|
paulb@536 | 94 | ----------------------------------------------------
|
paulb@536 | 95 |
|
paulb@536 | 96 | * Fixed missing import in WebStack.Repositories.Directory.
|
paulb@536 | 97 |
|
paulb@530 | 98 | New in WebStack 1.1.1 (Changes since WebStack 1.1)
|
paulb@530 | 99 | --------------------------------------------------
|
paulb@530 | 100 |
|
paulb@530 | 101 | * Fixed update_path to handle the root path properly.
|
paulb@530 | 102 |
|
paulb@495 | 103 | New in WebStack 1.1 (Changes since WebStack 1.0)
|
paulb@495 | 104 | ------------------------------------------------
|
paulb@492 | 105 |
|
paulb@495 | 106 | * Added a Repositories package to provide session-like support for
|
paulb@495 | 107 | different kinds of storage.
|
paulb@495 | 108 | * Added an explicit filesystem encoding to the Calendar example and adopted
|
paulb@495 | 109 | the DirectoryRepository from the Repositories package.
|
paulb@504 | 110 | * Added get_path_without_info, update_path and redirect methods to the
|
paulb@504 | 111 | Transaction class.
|
paulb@527 | 112 | * Added get_attributes (attribute support) to the Transaction class.
|
paulb@495 | 113 | * Added a values method to Helpers.Session.Wrapper.
|
paulb@528 | 114 | * Fixed get_processed_virtual_path_info (to match from right to left).
|
paulb@514 | 115 | * Improved/fixed exception handling in the adapters so that transactions are
|
paulb@514 | 116 | committed as the final act of an adapter experiencing an unhandled
|
paulb@514 | 117 | exception. This should result in session stores being closed properly.
|
paulb@517 | 118 | * Changed the Helpers.Session.SessionStore to use DirectoryRepository.
|
paulb@514 | 119 | * Made the "not found" behaviour of DirectoryResource more configurable.
|
paulb@514 | 120 | * Added documentation for MapResource and DirectoryResource.
|
paulb@492 | 121 | * Fixed the distribution names in the Ubuntu changelog.
|
paulb@492 | 122 |
|
paulb@409 | 123 | New in WebStack 1.0 (Changes since WebStack 0.10)
|
paulb@409 | 124 | -------------------------------------------------
|
paulb@409 | 125 |
|
paulb@474 | 126 | * Changed the behaviour of get_path, get_path_without_query, get_path_info,
|
paulb@474 | 127 | get_virtual_path_info, get_processed_virtual_path_info and
|
paulb@474 | 128 | get_fields_from_path to return Unicode data decoded using the optional
|
paulb@474 | 129 | encoding parameter or a common default encoding.
|
paulb@474 | 130 | * Fixed file upload values so that FileContent objects are returned for such
|
paulb@474 | 131 | fields in get_fields_from_body and get_fields.
|
paulb@474 | 132 | (Warning! Except for Twisted!)
|
paulb@474 | 133 | * Fixed the JavaServlet support so that streams and file content are
|
paulb@474 | 134 | obtained as "almost" plain strings.
|
paulb@474 | 135 | * Updated/fixed LoginResource and LoginRedirectResource to use the updated
|
paulb@474 | 136 | path API and to handle special characters properly.
|
paulb@474 | 137 | * Added convenience methods to Transaction for the decoding and encoding of
|
paulb@474 | 138 | path values (to and from Unicode objects) - see the decode_path and
|
paulb@474 | 139 | encode_path methods.
|
paulb@474 | 140 | * Added the notion of processed virtual path info - the part of the original
|
paulb@474 | 141 | path info not represented in the current virtual path info.
|
paulb@474 | 142 | * Added "pass through" behaviour to ResourceMap.MapResource (prompted by a
|
paulb@474 | 143 | patch from Scott Robinson).
|
paulb@474 | 144 | * Fixed ResourceMap.MapResource to handle non-existent resources properly
|
paulb@474 | 145 | (where the virtual path info is only one component in length).
|
paulb@474 | 146 | * Added Debian package support.
|
paulb@474 | 147 | * Added automatic session directory creation for the WebStack sessions
|
paulb@474 | 148 | implementation.
|
paulb@474 | 149 | * Added support for the repeated retrieval of sessions from the same
|
paulb@474 | 150 | WebStack session store, avoiding deadlocks.
|
paulb@474 | 151 | * Fixed the calendar example, making it perform a proper function.
|
paulb@474 | 152 | * Made the BaseHTTPRequestHandler and Twisted SimpleWithLogin applications
|
paulb@474 | 153 | include the Login application, since Konqueror (at least) does not share
|
paulb@474 | 154 | cookies across different port numbers on the same host.
|
paulb@474 | 155 | * Added the SimpleWithLogin and Login applications to the demonstration.
|
paulb@474 | 156 | * Improved the documentation, adding information on request headers, and
|
paulb@474 | 157 | describing file upload and session support limitations.
|
paulb@476 | 158 | * Improved the AOLserver-related notes for CGI and Webware, adding a patch
|
paulb@476 | 159 | for Webware in order to work around AOLserver issues.
|
paulb@409 | 160 |
|
paulb@388 | 161 | New in WebStack 0.10 (Changes since WebStack 0.9)
|
paulb@388 | 162 | -------------------------------------------------
|
paulb@388 | 163 |
|
paulb@474 | 164 | * Changes to make the tools/demo.py script work on Windows (and other)
|
paulb@474 | 165 | platforms (suggested by Jim Madsen).
|
paulb@474 | 166 | * Fixed end of header newlines for CGI (suggested by Matt Harrison).
|
paulb@474 | 167 | * Minor documentation fixes and improvements, adding information on
|
paulb@474 | 168 | AOLserver in the CGI and Webware notes.
|
paulb@474 | 169 | * Changed the mod_python server name method to use the server object rather
|
paulb@474 | 170 | than the connection object.
|
paulb@474 | 171 | * Added a parameter to the ResourceMap.MapResource class to permit automatic
|
paulb@474 | 172 | redirects into resource hierarchies when no trailing "/" was given in the
|
paulb@474 | 173 | URL; changed the updated virtual path info so that empty values may be set
|
paulb@474 | 174 | (the guarantee that "/" will always appear no longer applies).
|
paulb@474 | 175 | * Fixed virtual path info retrieval when the value is an empty string.
|
paulb@192 | 176 |
|
paulb@314 | 177 | New in WebStack 0.9 (Changes since WebStack 0.8)
|
paulb@314 | 178 | ------------------------------------------------
|
paulb@314 | 179 |
|
paulb@474 | 180 | * Standardised error handling in the adapters so that tracebacks can be
|
paulb@474 | 181 | suppressed and an internal server error condition raised.
|
paulb@474 | 182 | * Added overriding of path info in transactions.
|
paulb@474 | 183 | * Added a ResourceMap resource for dispatching to different resources
|
paulb@474 | 184 | according to path components.
|
paulb@474 | 185 | * Standardised deployment for some frameworks (see docs/deploying.html).
|
paulb@474 | 186 | * Introductory documentation in XHTML format.
|
paulb@474 | 187 | * Added server name and port methods to the transaction.
|
paulb@474 | 188 | * Added a simple demonstration application, incorporating many of the
|
paulb@474 | 189 | examples and launched under a single script.
|
paulb@474 | 190 | * Fixed mod_python native sessions.
|
paulb@474 | 191 | * Fixed Zope request stream access.
|
paulb@474 | 192 | * WebStack is now licensed under the LGPL - see docs/COPYING.txt for
|
paulb@474 | 193 | details.
|
paulb@314 | 194 |
|
paulb@300 | 195 | New in WebStack 0.8 (Changes since WebStack 0.7)
|
paulb@295 | 196 | ------------------------------------------------
|
paulb@295 | 197 |
|
paulb@474 | 198 | * Added a standard exception, EndOfResponse, which can be used to
|
paulb@474 | 199 | immediately stop the processing/production of a response; this is useful
|
paulb@474 | 200 | when resources need to issue a redirect without unnecessary content being
|
paulb@474 | 201 | generated, for example.
|
paulb@474 | 202 | * Fixed path information for Zope.
|
paulb@474 | 203 | * Added WSGI support.
|
paulb@474 | 204 | * Verified Twisted 1.3.0 support with Python 2.3.3.
|
paulb@295 | 205 |
|
paulb@300 | 206 | New in WebStack 0.7 (Changes since WebStack 0.6)
|
paulb@192 | 207 | ------------------------------------------------
|
paulb@192 | 208 |
|
paulb@474 | 209 | * Fixed path information semantics.
|
paulb@474 | 210 | * Fixed file upload semantics.
|
paulb@474 | 211 | * Fixed content type handling for Unicode output and for interpreting
|
paulb@474 | 212 | request body fields/parameters (although some improvement remains).
|
paulb@474 | 213 | * Added a method to discover the chosen response stream encoding.
|
paulb@474 | 214 | * Fixed field/parameter retrieval so that path and body fields are distinct,
|
paulb@474 | 215 | regardless of the framework employed.
|
paulb@474 | 216 | * Added a method to get a combination of path and body fields (suggested by
|
paulb@474 | 217 | Jacob Smullyan).
|
paulb@474 | 218 | * Introduced Zope 2 support.
|
paulb@474 | 219 | * Improved Jython/Java Servlet API support (although a special PyServlet
|
paulb@474 | 220 | class must now be used, and certain libraries must be deployed with
|
paulb@474 | 221 | applications).
|
paulb@474 | 222 | * Introduced authentication/authorisation support for Jython/Java Servlet
|
paulb@474 | 223 | API.
|
paulb@474 | 224 | * Session support has been added (except for Webware 0.8.1).
|
paulb@474 | 225 | * Alternative cookie support for mod_python has been added.
|
paulb@474 | 226 | * Cookie support now supports encoded Unicode sequences for names and
|
paulb@474 | 227 | values.
|
paulb@68 | 228 |
|
paulb@300 | 229 | New in WebStack 0.6 (Changes since WebStack 0.5)
|
paulb@178 | 230 | ------------------------------------------------
|
paulb@178 | 231 |
|
paulb@474 | 232 | * Introduced Jython/Java Servlet API support.
|
paulb@474 | 233 | * Minor fixes to example applications and to BaseHTTPRequestHandler.
|
paulb@178 | 234 |
|
paulb@300 | 235 | New in WebStack 0.5 (Changes since WebStack 0.4)
|
paulb@171 | 236 | ------------------------------------------------
|
paulb@171 | 237 |
|
paulb@474 | 238 | * Changed request body fields/parameters so that they are now represented
|
paulb@474 | 239 | using Unicode objects rather than plain strings.
|
paulb@474 | 240 | * Introduced better support for Unicode in response streams.
|
paulb@171 | 241 |
|
paulb@300 | 242 | New in WebStack 0.4 (Changes since WebStack 0.3)
|
paulb@160 | 243 | ------------------------------------------------
|
paulb@140 | 244 |
|
paulb@474 | 245 | * Added application definition of user identity, permitting alternative
|
paulb@474 | 246 | authentication mechanisms.
|
paulb@474 | 247 | * Improved BaseHTTPRequestHandler and mod_python reliability around fields
|
paulb@474 | 248 | from request bodies.
|
paulb@474 | 249 | * Provided stream and environment parameterisation in the CGI adapter.
|
paulb@474 | 250 | * Added LoginRedirect and Login examples.
|
paulb@474 | 251 | * Added get_path_without_query and fixed get_path behaviour.
|
paulb@140 | 252 |
|
paulb@300 | 253 | New in WebStack 0.3 (Changes since WebStack 0.2)
|
paulb@160 | 254 | ------------------------------------------------
|
paulb@120 | 255 |
|
paulb@474 | 256 | * Added better header support for Webware (suggested by Ian Bicking).
|
paulb@474 | 257 | * Introduced CGI and Java Servlet support (the latter is currently
|
paulb@474 | 258 | broken/unfinished).
|
paulb@474 | 259 | * Introduced support for cookies.
|
paulb@120 | 260 |
|
paulb@68 | 261 | Future Work
|
paulb@68 | 262 | -----------
|
paulb@68 | 263 |
|
paulb@308 | 264 | (Essential)
|
paulb@308 | 265 |
|
paulb@460 | 266 | Twisted 1.3.0 does not provide file upload metadata, and Twisted Web 0.5.0
|
paulb@460 | 267 | also seems to be missing this functionality. It isn't obvious whether Twisted
|
paulb@460 | 268 | Web2 will just copy its predecessors and provide a similarly limited API.
|
paulb@460 | 269 | Perhaps the Twisted support needs to resemble the CGI support much more when
|
paulb@460 | 270 | handling fields.
|
paulb@460 | 271 |
|
paulb@308 | 272 | JythonServlet libraries need to be configured using sys.add_package when
|
paulb@308 | 273 | these do not feature in the compiled-in list. Adding such configuration to
|
paulb@308 | 274 | the handler may be most appropriate (since the web.xml file can be too
|
paulb@308 | 275 | arcane), but this needs testing.
|
paulb@308 | 276 |
|
paulb@580 | 277 | The algorithm employed in the WebStack.Helpers.Auth.get_token function
|
paulb@580 | 278 | should be reviewed and improved for better security.
|
paulb@580 | 279 |
|
paulb@308 | 280 | (Important)
|
paulb@308 | 281 |
|
paulb@363 | 282 | Field access needs testing, especially for anything using the
|
paulb@363 | 283 | cgi.FieldStorage class, and the way file uploads are exposed should be
|
paulb@363 | 284 | reviewed (currently the meta-data is not exposed). The acquisition of fields
|
paulb@363 | 285 | from specific sources should be tested with different request methods - some
|
paulb@363 | 286 | frameworks provide path fields in the body fields dictionary, others (eg.
|
paulb@363 | 287 | Zope) change the fields exposed depending on request method.
|
paulb@248 | 288 |
|
paulb@363 | 289 | Interpretation of path field encodings needs to be verified. Currently,
|
paulb@363 | 290 | stray path fields are handled (eg. in WebStack.Helpers.Request) as being
|
paulb@363 | 291 | ISO-8859-1, but it might be the case that some such fields might be
|
paulb@438 | 292 | submitted as UTF-8. The decode_path method on Transaction does do much of the
|
paulb@460 | 293 | work that is likely to be required, however. Still, a good policy for decoding
|
paulb@460 | 294 | path fields, reducing the number of times one might specify the encoding in
|
paulb@460 | 295 | various method calls, may be important.
|
paulb@438 | 296 |
|
paulb@438 | 297 | An interesting test of encodings is to introduce things like the following to
|
paulb@438 | 298 | the path info and query string sections of the URL: %25F0?%E6=%F8&%25F0=%F8
|
paulb@438 | 299 | This should produce the following decoded result: %F0?æ=ø&%F0=ø
|
paulb@438 | 300 | (The above needs to be read in ISO-8859-1 or ISO-8859-15.)
|
paulb@102 | 301 |
|
paulb@102 | 302 | Cookie objects need defining strictly, especially since the standard library
|
paulb@363 | 303 | Cookie object behaves differently to mod_python (and possibly Webware)
|
paulb@363 | 304 | Cookie objects. Moreover, the set_cookie_value method needs to provide
|
paulb@363 | 305 | access to the usual cookie parameters as supported by the frameworks. The
|
paulb@363 | 306 | standard library Cookie module has issues with Unicode cookie names (and
|
paulb@363 | 307 | possibly values) - this is worked around, but it would be best to resolve
|
paulb@363 | 308 | this comprehensively.
|
paulb@90 | 309 |
|
paulb@363 | 310 | UTF-16 (and possibly other encodings) causes problems with HTML form data
|
paulb@363 | 311 | sent in POST requests using the application/x-www-form-urlencoded content
|
paulb@363 | 312 | type. This should be reviewed at a later date when proper standardisation
|
paulb@363 | 313 | has taken place.
|
paulb@218 | 314 |
|
paulb@239 | 315 | Session support, especially through WebStack.Helpers.Session, should be
|
paulb@248 | 316 | reviewed and be made compatible with non-cookie mechanisms.
|
paulb@248 | 317 |
|
paulb@514 | 318 | Locking in the session support and in DirectoryRepository should be improved.
|
paulb@514 | 319 |
|
paulb@248 | 320 | HeaderValue objects should be employed more extensively. Thus, the header
|
paulb@469 | 321 | access methods may need to change their behaviour slightly. The get_headers
|
paulb@469 | 322 | method should potentially return a list for each item in the dictionary.
|
paulb@248 | 323 |
|
paulb@304 | 324 | WSGI support could demand that a special "end of headers" method be
|
paulb@304 | 325 | introduced into WebStack, thus making response output more efficient (and
|
paulb@304 | 326 | probably also for other frameworks, too).
|
paulb@304 | 327 |
|
paulb@336 | 328 | Investigate proper support for HEAD, OPTIONS and other request methods.
|
paulb@336 | 329 |
|
paulb@438 | 330 | Consider packages for different operating systems (other than Debian).
|
paulb@365 | 331 |
|
paulb@542 | 332 | Investigate cStringIO usage.
|
paulb@542 | 333 |
|
paulb@355 | 334 | The location of deployed applications in the filesystem should be exposed to
|
paulb@355 | 335 | those applications. (This is actually available in the __file__ module
|
paulb@580 | 336 | variable.) A resource could be provided to record the "root" path and added to
|
paulb@617 | 337 | a resource hierarchy or site map. Note that PathSelector records the "root"
|
paulb@617 | 338 | path, although it is not automatically deployed.
|
paulb@580 | 339 |
|
paulb@580 | 340 | (Completed/rejected)
|
paulb@355 | 341 |
|
paulb@355 | 342 | Path information should be consistent across all frameworks, and the "path
|
paulb@355 | 343 | info" value should be meaningful. (This should now be correct.)
|
paulb@355 | 344 |
|
paulb@460 | 345 | Investigate the nicer functions in the cgi module, discarding the "magic"
|
paulb@460 | 346 | stuff like FieldStorage. (These nicer functions are used by projects like
|
paulb@460 | 347 | Twisted - as of 1.3.0 at least - and do not give the necessary information we
|
paulb@460 | 348 | require.)
|
paulb@460 | 349 |
|
paulb@159 | 350 | Release Procedures
|
paulb@159 | 351 | ------------------
|
paulb@159 | 352 |
|
paulb@159 | 353 | Update the WebStack/__init__.py __version__ attribute.
|
paulb@329 | 354 | Change the version number and package filename/directory in the documentation.
|
paulb@332 | 355 | Change code examples in the documentation if appropriate.
|
paulb@159 | 356 | Update the release notes (see above).
|
paulb@159 | 357 | Check the setup.py file and ensure that all package directories are mentioned.
|
paulb@417 | 358 | Check the release information in the PKG-INFO file and in the package
|
paulb@417 | 359 | changelog (and other files).
|
paulb@253 | 360 | Tag, export.
|
paulb@247 | 361 | Generate the PyServlet classes.
|
paulb@355 | 362 | Generate the API documentation.
|
paulb@384 | 363 | Remove generated .pyc files: rm `find . -name "*.pyc"`
|
paulb@253 | 364 | Archive, upload.
|
paulb@367 | 365 | Upload the introductory documentation.
|
paulb@365 | 366 | Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
|
paulb@355 | 367 |
|
paulb@355 | 368 | Generating the API Documentation
|
paulb@355 | 369 | --------------------------------
|
paulb@355 | 370 |
|
paulb@363 | 371 | In order to prepare the API documentation, it is necessary to generate some
|
paulb@363 | 372 | Web pages from the Python source code. For this, the epydoc application must
|
paulb@475 | 373 | be available on your system. Then, inside the distribution directory, run the
|
paulb@355 | 374 | apidocs.sh tool script as follows:
|
paulb@355 | 375 |
|
paulb@355 | 376 | ./tools/apidocs.sh
|
paulb@355 | 377 |
|
paulb@355 | 378 | Some warnings may be generated by the script, but the result should be a new
|
paulb@475 | 379 | apidocs directory within the distribution directory.
|
paulb@472 | 380 |
|
paulb@472 | 381 | Making Packages
|
paulb@472 | 382 | ---------------
|
paulb@472 | 383 |
|
paulb@485 | 384 | To make Debian-based packages:
|
paulb@472 | 385 |
|
paulb@485 | 386 | 1. Create new package directories under packages if necessary.
|
paulb@474 | 387 | 2. Make a symbolic link in the distribution's root directory to keep the
|
paulb@474 | 388 | Debian tools happy:
|
paulb@472 | 389 |
|
paulb@485 | 390 | ln -s packages/ubuntu-hoary/python2.4-webstack/debian/
|
paulb@472 | 391 |
|
paulb@474 | 392 | 3. Run the package builder:
|
paulb@472 | 393 |
|
paulb@474 | 394 | dpkg-buildpackage -rfakeroot
|
paulb@472 | 395 |
|
paulb@474 | 396 | 4. Locate and tidy up the packages in the parent directory of the
|
paulb@474 | 397 | distribution's root directory.
|