Source

beaker / beaker / docs / _templates / index.html

{% extends "layout.html" %}
{% set title = 'Overview' %}
{% block body %}
  <p>Beaker is a library for caching and sessions for use with web applications
      and stand-alone Python scripts and applications. It comes with
      <a href="http://www.wsgi.org/wsgi/Middleware_and_Utilities">WSGI middleware</a>
      for easy drop-in use with <a href="http://www.python.org/dev/peps/pep-0333/">WSGI</a>
      based web applications, and caching decorators for ease of use with
      any Python based application.</p>

  <ul>
      <li><b>Lazy-Loading Sessions:</b> No performance hit for having sessions active in
          a request unless they're actually used</li>
      <li><b>Performance:</b> Utilizes a multiple-reader / single-writer locking
          system to prevent the 
          <a href="http://hype-free.blogspot.com/2008/05/avoiding-dogpile-effect.html">Dog Pile effect</a>
          when caching.
          </li>
      <li><b>Mulitple Back-ends:</b> File-based, DBM files, <a href="http://www.danga.com/memcached/">memcached</a>,
          memory, and database (via <a href="http://www.sqlalchemy.org/">SQLAlchemy</a>) back-ends available
          for sessions and caching</li>
      <li><b>Cookie-based Sessions:</b> SHA-1 signatures with optional AES encryption for client-side
          cookie-based session storage</li>
      <li><b>Flexible Caching:</b> Data can be cached per function to different back-ends, with different
          expirations, and different keys</li>
      <li><b>Extensible Back-ends:</b> Add more backends using 
          <a href="http://peak.telecommunity.com/DevCenter/setuptools#extensible-applications-and-frameworks">setuptools entrypoints</a>
           to support new back-ends.</li>
  </ul>

  <h2>News</h2>
  <ul>
      <li>Beaker 1.6.1 released on 10/20/2011.</li>
      <li>Beaker 1.6.0 released on 10/16/2011.</li>
      <li>Beaker 1.5.4 released on 6/16/2010.</li>
      <li>Beaker 1.5.3 released on 3/2/2010.</li>
      <li>Beaker 1.5.2 released on 3/1/2010.</li>
      <li>Beaker 1.5.1 released on 12/17/2009.</li>
      <li>Beaker 1.5.0 released on 11/23/2009.</li>
      <li><a href="http://groovie.org/2009/07/24/beaker-1-dot-4-released">Beaker 1.4 Released</a></li>
      <li><a href="http://groovie.org/2009/04/22/beaker-1-3-is-juicy-caching-goodness">Beaker 1.3 is juicy caching goodness</a></li>
      <li><a href="http://groovie.org/2007/12/17/beaker-0-9-cookie-stored-sessions-and-crypto">Beaker 0.9, cookie-stored sessions, and crypto</a></li>
  </ul>

  <h2>Documentation</h2>
  <table class="contentstable" align="center" style="margin-left: 30px"><tr>
    <td width="50%">
      <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br/>
         <span class="linkdescr">for a complete overview</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("search") }}">Search page</a><br/>
         <span class="linkdescr">search the documentation</span></p>
    </td><td width="50%">
      <p class="biglink"><a class="biglink" href="{{ pathto("genindex") }}">General Index</a><br/>
         <span class="linkdescr">all functions, classes, terms</span></p>
      <p class="biglink"><a class="biglink" href="{{ pathto("py-modindex") }}">Module Index</a><br/>
         <span class="linkdescr">quick access to all documented modules</span></p>
    </td></tr>
  </table>

  <p>Download <a href="http://beaker.groovie.org/Beaker.pdf">Beaker PDF documentation</a>.</p>

  <h2>Source</h2>
  <p>Beaker's Mercurial repository can be found at
    <a href="http://bitbucket.org/bbangert/beaker/"><tt>http://bitbucket.org/bbangert/beaker/</tt></a>.</p>

    <p>To check out:</p>

      <pre>hg clone http://www.bitbucket.org/bbangert/beaker</pre>

{% endblock %}