Permalink
Browse files

prepare release

  • Loading branch information...
1 parent 03c95b6 commit 9387c46cfce6ac5522199ec222ce34b0b17993b9 @rnixx rnixx committed Oct 7, 2012
Showing with 20 additions and 12 deletions.
  1. +3 −3 HISTORY.rst
  2. +1 −1 LICENSE.rst
  3. +15 −7 README.rst
  4. +1 −1 setup.py
View
@@ -2,7 +2,7 @@
History
=======
-1.0-beta
---------
+1.0
+---
-- make it work [jensens, rnix, et al]
+- make it work [rnix, jensens, et al]
View
@@ -2,7 +2,7 @@
License
=======
-Copyright (c) 2012, BlueDynamics Alliance, Austria, Germany, Switzerland
+Copyright (c) 2008-2012, BlueDynamics Alliance, Austria, Germany, Switzerland
All rights reserved.
Redistribution and use in source and binary forms, with or without
View
@@ -15,6 +15,7 @@ Souper can be used used in any python application using the ZODB, such as
Using Souper
============
+
Providing a Locator
-------------------
@@ -47,7 +48,8 @@ by name::
>>> soup = get_soup('mysoup', context)
>>> soup
<souper.soup.Soup object at 0x...>
-
+
+
Providing a Catalog Factory
---------------------------
@@ -121,6 +123,7 @@ searching::
>>> record['homeaddress'].attrs['town'] = 'Innsbruck'
>>> record['homeaddress'].attrs['country'] = 'Austria'
+
Access data
-----------
@@ -135,6 +138,7 @@ All records can be accessed using utilizing the container BTree::
>>> soup.data.keys()[0] == record_id
True
+
Query data
----------
@@ -169,14 +173,16 @@ generator returning light weight objects. Records are fetched on call::
Here the size is passed as first value of the geneartor too if ``with_size=True``
is passed.
+
Delete a record
---------------
To remove a record from the soup python ``del`` is used like one would do on
any dict::
>>> del soup[record_id]
-
+
+
Reindex
-------
@@ -189,8 +195,8 @@ Sometimes one may want to reindex all data. Then ``reindex`` has to be
called without parameters. It may take a while::
>>> soup.reindex()
-
-
+
+
Rebuild catalog
---------------
@@ -199,7 +205,7 @@ a rebuild of the catalog i needed. It replaces the current catalog with a new
one created by the catalog factory and reindexes all data. It may take while::
>>> soup.rebuild()
-
+
Reset (or clear) the soup
-------------------------
@@ -211,6 +217,7 @@ To remove all data from the soup and empty and rebuild the catalog call
>>> soup.clear()
+
Installation Notes
==================
@@ -219,6 +226,7 @@ there was no release (will be done soon). Please check
`pypi <http://pypi.python.org>`_ if it is there, otherwise please fetch
`node.ext.zodb from github <https://github.com/bluedynamics/node.ext.zodb>`_
+
Source Code
===========
@@ -231,6 +239,6 @@ We'd be happy to see many forks and pull-requests to make souper even better.
Contributors
============
-- Jens W. Klein <jk@kleinundpartner.at>
-- Robert Niederreiter <office@squarewave.com>
+- Robert Niederreiter <rnix [at] squarewave [dot] at>
+- Jens W. Klein <jk [at] kleinundpartner [dot] at>
View
@@ -1,7 +1,7 @@
from setuptools import setup, find_packages
import os
-version = '1.0-beta1'
+version = '1.0'
shortdesc = \
'Souper - Generic Indexed Storage based on ZODB'
longdesc = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()

0 comments on commit 9387c46

Please sign in to comment.