= amplee =
[[PageOutline]]

== What is it? ==

amplee is a Python implementation of the Atom Publishing Protocol (!AtomPub), as specified in [http://tools.ietf.org/html/rfc5023 RFC 5023].

== What is the status of amplee? ==

 * '''Latest stable version:''' 0.6.1
 * Previous stable version was 0.5.2

== Contact ==

To discuss about amplee you should register to the [http://groups.google.com/group/atom-protocol-python Atom Protocol Python group].

I can also be contacted on IRC:
 * Network: OFTC
 * Server: irc.oftc.net
 * Channel: #cherrypy

You can create a ticket by login as user ''guest'' with the password ''defuze''.
There is also a mailing-list for tickets related to amplee: http://groups.google.com/group/amplee-tickets.

== Requirements ==

amplee needs the following packages:

 * [http://uche.ogbuji.net/tech/4suite/amara/ amara] (>=1.2.0): {{{easy_install -U amara}}}
 * [http://zesty.ca/python/uuid.py uuid] (built-in Python 2.5 module)

To fully appreciate amplee you may also require one or more of the following:
 * [http://code.google.com/p/boto/ boto] for Amazon S3 storage support
 * [http://www.zope.org/Wikis/ZODB/FrontPage ZODB] if you want ZODB storage support (tested against 3.6)
 * [http://pysvn.tigris.org/ pysvn] if you want Subversion storage support (tested against 1.5)
 * [http://projects.amor.org/dejavu/ dejavu] ORM if you want database storage support
 * [http://pypi.python.org/pypi/python-memcached python-memcached] for memcached support

== Installation ==

amplee is setuptools aware and can be installed via the following command:

 {{{easy_install -U amplee}}}


Alternatively you can also grab a copy from 

 * Subversion: https://svn.defuze.org/oss/amplee/
 * Tarball: http://www.defuze.org/oss/amplee/

== Documentation ==

 * amplee 0.5.x: API documentation generated by epydoc [http://www.defuze.org/oss/amplee/api-0.5.0/ here].
 * amplee 0.6.0: API documentation generated by epydoc [http://www.defuze.org/oss/amplee/api-0.6.0/ here].
 * amplee 0.6.1: API documentation generated by epydoc [http://www.defuze.org/oss/amplee/api-0.6.1/ here].
 * [wiki:amplee/Tutorial Tutorials for 0.5.x and 0.6.x]

== Demo ==

None available for now. Sorry folks. But the source code contains a simple example.

== Future ==

These following pages are set up to discuss the future of amplee:

 * [wiki:amplee/discussion/0.6 0.6]
 * [wiki:amplee/discussion/0.7 0.7]

== See also ==

 * [wiki:AmpleeLoader Loading an !AtomPub store from a config file]
 * [wiki:amplee/ConfigRelaxNGSchema amplee 0.6.x configuration Relax NG schema]