Jean-Tiare Le Bigot avatar Jean-Tiare Le Bigot committed 71c1ad6

fix typo in doc, update README, CHANGES and enhance/fix setup.cfg

Comments (0)

Files changed (4)

 ---------
 
 - log all successful queries
+- extensive documentation
 
 Known bugs - limitations
 ------------------------
 
 - #7 Can't save models where a datetime field is nested in a dict/list
-- Can use ``datetime`` objects in ``scan`` and ``query`` filters
+- Can't use ``datetime`` objects in ``scan`` and ``query`` filters
 
 ====================
 DynamoDBMapper 1.6.1
-dynamodb-mapper -- a DynamoDB object mapper, based on boto.
+Dynamodb-mapper -- a DynamoDB object mapper, based on boto.
 
 Presentation
 ============
 
+`DynamoDB <http://aws.amazon.com/dynamodb/>`_ is a minimalistic NoSQL engine
+provided by Amazon as a part of their AWS product.
+
+**DynamoDB** allows you to stores documents composed of unicode strings or numbers
+as well as sets of unicode strings and numbers. Each tables must define a hash
+key and may define a range key. All other fields are optional.
+
+**Dynamodb-mapper** brings a tiny abstraction layer over DynamoDB to overcome some
+of the limitations with no performance compromise. It is highly inspired by the
+mature `MoongoKit project <http://namlook.github.com/mongokit>`_
+
+Requirements
+============
+
 The documentation currently assumes that you're running Boto 2.3.0 or later.
 If you're not, then the API for query and scan changes. You will have to supply
 raw condition dicts, as is done in boto itself.
 
 
     # Later on, retrieve that same object from the DB...
-    e1m1 = DoomMap.get((1, 1))
+    e1m1 = DoomMap.get(1, 1)
 
     # query all maps of episode 1
     e1_maps = DoomMap.query(hash_key=1)

docs/pages/getting_started.rst

 ::
 
     # Later on, retrieve that same object from the DB...
-    e1m1 = DoomMap.get((1, 1))
+    e1m1 = DoomMap.get(1, 1)
 
 What if I want to get all the maps in a given episode? This is the purpose of the
 :py:meth:`~.DynamoDBModel.query` methode which also allows to filter the results
 name = dynamodb-mapper
 version = 1.6.2.dev
 summary = Object mapper for Amazon DynamoDB
-description_file = README.rst
+description-file = README.rst
 author = Max Noel
 author_email = mnoel@ludia.com
-classifiers =
+maintainer = Jean-Tiare Le Bigot
+maintainer_email = jtlebigot@socialludia.com
+home_page = http://dynamodb-mapper.readthedocs.org/en/latest/
+classifier =
     Topic :: Internet
     Topic :: Database :: Front-Ends
     Operating System :: OS Independent
     Intended Audience :: Developers
-    Development Status :: 5 - Production/Stable
+    Development Status :: 4 - Beta
     Programming Language :: Python
     Programming Language :: Python :: 2.7
     License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.