Kamaelia Documentation

Documentation is a core asset in Kamaelia. As of Jan 2024, this is now being significantly updated.

While this is done you are invited to look at the Component Reference for an indication of the scope of components, and the Cookbook for small examples.

Quick Overview

The About page is an overview of the project from a relatively high level.

Books

Two major pieces of Kamaelia documentation are booksized PDFs:

• The Kamaelia Europython tutorial. This is an 84 page book teaching you the ideas behind Kamaelia, building your own core, building components and systems. This is probably the best place to start right now.

  • Pragmatic Concurrency is an overview of this tutorial that also includes the slides to browse through.

• A newer >400 page API reference book, whose documentation autogenerated & extracted from the codebase - covering both Axon and Kamaelia. (This is new as of Jan 2024 and a bit rough around the edges!)

Cookbook

This section contains a number of recipes showing how to build a variety of different types of Kamaelia systems. Sections include:

• Linking components together
• Building Network systems, clients, servers, IM, etc
• Building Digital TV systems
• Building Multimedia systems
• Using Kamaelia components & subsystems in non-kamaelia systems.

More recipes always welcome.

API References

• Full component Reference
• Full reference for Axon - the core of Kamaelia

Tutorials

• Dive into Kamaelia tutorials from a variety of perspectives
• See the presentations given publicly

Kamaelia based systems

There's quite a few Kamaelia systems as example applications in the repository on github. Some sample apps:

Kamaelia Grey

Spam reduction through greylisting. Kamaelia Grey is a SMTP proxy for your inbound email, rejecting email likely to be spam. Mail likely to not be spam is forwarded to your normal mail server.

Batch Transcoder

This watches directories for new images and videos to transcode to formats suitable for the web. You can think of it as the backend needed for a youtube/flickr type site. PDF support is likely to be added soon.

Whiteboard

A collaborative whiteboard. 2 or more machines share a display you can write on - either can be a server. Whiteboards are paginated, and therefore can also be used for remote presentations. Really cool with a tablet.

Macro

Records and transcodes digital TV for later viewing (ie timeshifting). It can do this for as many channels at once as you have CPU power and tuners available for it.

---