[TransWarp] PEAK Tutorial

Phillip J. Eby pje at telecommunity.com
Wed Nov 13 13:36:33 EST 2002


At 06:56 PM 11/13/02 +0100, Holger Brückner wrote:

>what about a users guide and a developer guide ?!?

What information would you like to see in such?  I'm pretty much trying to 
put everything that isn't reference documentation into the tutorial.  The 
plan through 0.5 final is for the core tutorial to be on the binding, 
config, and naming packages; for later releases it may expand to cover the 
model, storage, and running packages, but they are very different from the 
first three packages, and it seemed perhaps they should be a different 
thing.  But it might be better to just treat them as Part 1 and Part 2 of 
the same book, overall.  We'll see what happens.


>i really liked what you have written so far and i'm desperade to get
>more :).

Me too.  However, the tutorial docs (and other supplementary info/articles) 
are my top priority now that the other 0.5a1 milestones are met.

The daunting thing about doing documentation for something of this scope, 
is the realization that the documenting of it is (almost) as big a job as 
the coding!  On the bright side, it isn't necessary to write unit tests for 
the documentation, and I don't have to worry as much about bugs creeping in 
when I make changes.  :)


>  currently my problem is, that i'm not as deep into python as i
>would like to be and putting everything together from source code is
>just too much. my current approach to learn about new frameworks is to
>get an example, understand what it is doing, then look how it is doing
>it. doing it the other way around is much more complicated :)

Understood.  I'd like to have some useful example applications, but until 
we finish the rest of the 0.5 release plans, there aren't many generally 
useful programs we can write that show off the framework.  The binding, 
config, and naming packages are extremely useful as *part* of an 
application, and could be used to develop sysadmin-ish scripts and tools, 
but "real" apps want a domain model and storage capabilities.

The storage package is far enough along that you can write database code 
with it, but I'd much rather showcase an application using actual 
persistence in conjunction with it.  But finishing the persistence 
mechanisms (model and storage) are next up after getting the tutorial done 
through at least chapter 2.




More information about the PEAK mailing list