Commits

Jean-Tiare Le Bigot committed cacb4dc

started doc refactor.

* page organization
* index page organization
* added overview
* added feture lists
* import changelog

Comments (0)

Files changed (8)

docs/_include/intro.rst

+`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>`_
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', '_include']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
+################################
 Dynamodb-mapper's documentation.
-================================
+################################
 
 Overview
---------
+========
 
-Dynamodb-mapper is a tiny abstraction layer for Amazon's DynamoDB. It provides
-easy object and type mapping through a straightforward schema definition.
+.. include:: _include/intro.rst
 
-API:
-----
+Content
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   pages/overview
+   pages/getting_started
+   pages/changelog
+
+
+
+Raw api
+=======
 
 .. toctree::
    :maxdepth: 2

docs/pages/changelog.rst

+#############################
+Change log - Migration guide.
+#############################
+
+.. include:: ../../CHANGES.rst

docs/pages/getting_started.rst

+####################################
+Getting started with Dynamodb-mapper
+####################################

docs/pages/overview.rst

+###########################
+Overview of Dynamodb-mapper
+###########################
+
+.. include:: ../_include/intro.rst
+
+Features
+========
+
+- Python <--> DynamoDB type mapping
+- dict and lists serialization
+- default values
+- Multi-target transaction support with auto-retry (new in 1.6.0)
+- Auto-inc hash_key
+- Protection against the 'lost update' syndrom
+- New table creation
+- Framework agnostic
+- Exposes most BOTO functionalities
+
+.. TODO: add links to related documentation
+
+Known limitations
+=================
+
+- Dates nested in a dict or set can not be saved as ``datetime`` does not support
+    JSON serialization.
+
+Quick example
+=============

dynamodb_mapper/model.py

     ``_dynamodb_to_python(t, _python_to_dynamodb(v)) == v`` for any v.
 
     :param schema_type: A type supported by the mapper
+
     .. (TODO Clearly list those).
 
     :param value: The DynamoDB attribute to convert to a Python object.
 setup_requires = [
     # d2to1 bootstrap
     'd2to1',
+    'boto',
 
     # Testing dependencies (the application doesn't need them to *run*)
     'nose',
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.