=============================================
Python Co-routine based Application Framework
=============================================

PyCAF is a framework for building highly concurrent network servers in Python.
Its goals are:

 - provide the building blocks for creating concurrent network servers and
   client using non-blocking I/O

 - lightweeght tasklets and message passing as oppopsed to threads as the
   concurrency model

 - provide a suite of tools for building TCP network servers in general

 - allow one to run web applications, such as those built with Pylons or Django,
   to work without threads

 - provide tools to create distributed multi-processing applications

Other related projects:

 - concurrence
 - cogen
 - circuits

Documentation
=============

Documentation is available in the `docs/source` folder.  You can generate
HTML documentation from .rst files using Sphinx, like this:

  $ sphinx-build -a source ./html

This will put the output html files in the folder `html`.