***********
 FrontPage 
***********


NOTE: Due to rampant spammer edits, this wiki is no longer open to public editing.  Email me your user name and login ID if you want to get access.  (If your name isn't shown in the upper right corner of this page, you can click on ">>UserPreferences<<" to sign up (with a valid e-mail address) and log in.  However, to actually edit anything, I'll need to grant permission to your login first.) 


====================
Introduction to PEAK
====================



peak-at-a-glance.png 


===============
Getting Started
===============



When beginning to learn PEAK, the best order in which to explore the modules is: >>binding<<, >>config<<, and >>naming<<.  These core modules provide the component-oriented framework upon which most other PEAK modules are built, and they will be used extensively within any application built with PEAK. 

The next layer to explore should probably be the runtime modules: >>running<<, >>commands<<, and >>logs<<.  Combined with the previous core modules, the runtime modules provide most of the machinery needed for building PEAK applications. 

The >>storage<< module provides numerous storage management features, including high level relational database connectivity, a general transaction framework with ACID assurance and two-phase commit, and a >>DataManager<< framework for high level object persistence to multiple storage media. 

The >>model<< module provides a framework for implementing the >>DomainModel<< pattern, which is based on high level "business objects" isolated from storage concerns. 

The >>events<< module provides an "event-driven" programming framework that supports ultralight "microthreads" implemented via generators.  It can stand alone or can be used atop Twisted for a more intuitive approach to asynchronous programming. 

Further modules to explore include the >>util<<, >>metamodels<<, and >>security<< modules.  The >>web<<, >>net<<, and >>query<< modules are under development. 

Additional notes in >>GettingStartedWithPeak<<. 


=========
Tutorials
=========



The >>IntroToPeak<< tutorial is currently the best way to get started with PEAK.  It demonstrates the use of many of PEAK's features by building a small application step-by-step. 

Other tutorials include: 
 * 
 >>PeakDatabaseApplications<< 
 *  * 
 >>ComposingHierarchies<< 
 *  * 
 >>TwistedPeak<< example 
 *  * 
 Using >>ZopePageTemplates<< with peak.web 
 *  * 
 >>PeakFromBasics<< - a new tutorial (currently barely started!) which will develop an application from scratch 
 *  * 
 >>PeakWebHowTo<< - introduction to `peak.web´ functionality  * 


========
Concepts
========


 * 
 >>WritingInterfaces<< 
 *  * 
 >>WritingComponents<< 
 *  * 
 >>WritingAdaptors<<  * 


============================
Latest Project Docs from CVS
============================


 * 
 [WWW]README.txt [http://cvs.eby-sarna.com/*checkout*/PEAK/README.txt?rev=HEAD] 
 *  * 
 [WWW]FEATURES.txt [http://cvs.eby-sarna.com/*checkout*/PEAK/FEATURES.txt?rev=HEAD] 
 *  * 
 [WWW]STATUS.txt [http://cvs.eby-sarna.com/*checkout*/PEAK/STATUS.txt?rev=HEAD] 
 *  * 
 [WWW]CHANGES.txt [http://cvs.eby-sarna.com/*checkout*/PEAK/CHANGES.txt?rev=HEAD] 
 *  * 
 [WWW]TODO.txt [http://cvs.eby-sarna.com/*checkout*/PEAK/TODO.txt?rev=HEAD]  * 


=============
Miscellaneous
=============



(To be categorized: >>AddingPsycopgSupport<<, >>DistributePeakApplications<<, >>MiscNotes<<, >>Glossary<<, >>CookBook<<, >>MailingListHighlights<<, >>IrcHighlights<<) 


==============
Using the Wiki
==============



You can edit any page by pressing the link at the bottom of the page.  Capitalized words joined together form a >>WikiName<<, which hyperlinks to another page.  The highlighted title searches for all pages that link to the current page.  Pages which do not yet exist are linked with a question mark: just follow the link and you can add a definition. 

To learn more about what a >>WikiWikiWeb<< is, read about [MoinMoin]WhyWikiWorks [http://purl.net/wiki/moin/WhyWikiWorks] and the [MoinMoin]WikiNature [http://purl.net/wiki/moin/WikiNature]. Also, consult the [MoinMoin]WikiWikiWebFaq [http://purl.net/wiki/moin/WikiWikiWebFaq]. 

-------------------------------------------------------------------------------
 

Interesting starting points: 
 * 
 >>RecentChanges<<: see where people are currently working 
 *  * 
 >>HelpForBeginners<<: to get you going 
 *  * 
 >>WikiSandBox<<: feel free to change this page and experiment with editing 
 *  * 
 >>FindPage<<: search or browse the database in various ways  * 


---%<-------------------------------------------------------------------------
 
---%<-------------------------------------------------------------------------