The Webware sprint members at PyCon were Tripp Lilley (figurehead), Ian
Bicking, George Paci and myself.
Monday Tripp, Ian and I mostly talked about what we wanted to do. We
identified documentation, components, a short-term user manager with a few
features, a long-term user manager with more features, and spec'ing out a
CMS (Content Management System). We decided to work on documentation
because that's the key to getting the other things done.
Tuesday we sat down to work, and George joined us. Tripp was being
network sysadmin for the sprint, as well as coordinating the registration
booth, so he was only able to spend part time on the sprint. He wants to
do a UML diagram of Webware's classes, but that's still at an early stage.
Ian added docstrings to several WebKit modules, which helped the rest of
us immensely. He also wrote a prototype for a component version of
Page.py. Components are a way to plug features like user authentication
into the servlet without requiring the servlet to inherit them, which is
George worked on adding unittests.
I worked on documenting Webware's architecture in words. I'm writing a
new version of "Anatomy of a Transaction" (the original is on the wiki at
which is more in depth. I've also started a class hierarchy page to
complement the auto-generated one install.py creates -- this one looks at
the classes from the perspective of the AppServer. Both articles exist as
unfinished text files in my CVS sandbox, but will eventually be added in
some format to the Webware documentation. You can see what exists at:
Click "Browse CVS Repository"
Click anatomy.txt and class_hierarchy.txt and click "View" on each
I can't work more on this till mid April.
I also talked with Twisted's documentor. They have a system called
Twisted Lore that uses XHTML-like files as source and produces HTML files
with TOCs and footnotes, PDF and LaTeX files. I'm looking forward to the
Twisted Lore talk at the conference and also the ReST talk, to consider
them for possible use in the Cheetah documentation. We could also
consider it for Webware at some future date. I have a couple reservations
about it though:
(1) I haven't seen how the styles look in a graphical browser or printout,
(2) Twisted Lore currently depends on a homegrown XML parser in Twisted,
which I'm reluctant to depend on.
-- Mike Orr <mso@...>