Package amplee :: Package atompub
[hide private]
[frames] | no frames]

Source Code for Package amplee.atompub

 1  # -*- coding: utf-8 -*- 
 2   
 3  __doc__ = """ 
 4   
 5  APP is defined as: 
 6   
 7  ''' 
 8  The Atom Publishing Protocol is an application-level protocol for 
 9  publishing and editing Web resources using HTTP [RFC2616] and XML 1.0. 
10  The protocol supports the creation of arbitrary web resources and 
11  provides facilities for: 
12   
13   * Collections: Sets of resources, which can be retrieved in whole or in part. 
14   * Service: Discovering and describing Collections. 
15   * Editing: Creating, updating and deleting resources. 
16  ''' 
17   
18  The amplee.atompub package contains an implementation 
19  of the different entities of the Atom Publishing Protocol. 
20   
21  The way to use this package is to: 
22   
23  - create a storage for member resources 
24  [optionally also create a storage for media resources] 
25  - create a store and pass the created storage(s) 
26  - create a service instance and pass the created store 
27  - create one or more workspace using the service instance 
28  - create one or more collections per workspace 
29   
30  Then create members, attach them to their collections 
31  and finally commit the modification into the storage 
32  via the store instance. 
33  """ 
34   
35  __all__ = ['member', 'collection', 'store', 
36             'service', 'workspace'] 
37