Make tests run in half the time

Author: jaustinpage

docs/api.rst

@@ -4,7 +4,7 @@
 API
 ===
 
-.. module:: flask.ext.dynamo.manager
+.. module:: flask_dynamo.manager
 
 This part of the documentation documents all the public classes, functions, and
 API details in flask-dynamo.  This documentation is auto generated, and is
@@ -17,17 +17,26 @@ Configuration
 .. autoclass:: Dynamo
 
     .. automethod:: init_app
-    .. automethod:: init_settings
-    .. automethod:: check_settings
     .. autoattribute:: connection
-    .. autoattribute:: tables
+    .. autoinstanceattribute:: DynamoLazyTables
+    .. automethod:: get_table
+    .. automethod:: create_all
+    .. automethod:: destroy_all
+
+.. autoclass:: DynamoLazyTables
+
+    .. automethod:: keys
+    .. automethod:: len
+    .. automethod:: items
+    .. automethod:: wait_exists
+    .. automethod:: wait_not_exists
     .. automethod:: create_all
     .. automethod:: destroy_all
 
 
 Errors
 ------
 
-.. module:: flask.ext.dynamo.errors
+.. module:: flask_dynamo.errors
 
 .. autoclass:: ConfigurationError

docs/conf.py

@@ -16,7 +16,7 @@
 from os.path import abspath
 from sys import path
 
-from flask.ext.dynamo import __version__ as version
+from flask_dynamo import __version__ as version
 
 
 # If extensions (or modules to document with autodoc) are in another directory,

docs/quickstart.rst

@@ -1,5 +1,5 @@
 .. _quickstart:
-.. module:: flask.ext.dynamo
+.. module:: flask_dynamo
 
 
 Quickstart
@@ -69,7 +69,7 @@ Below is an example::
     # app.py
 
     from flask import Flask
-    from flask.ext.dynamo import Dynamo
+    from flask_dynamo import Dynamo
 
     app = Flask(__name__)
     app.config['DYNAMO_TABLES'] = [
@@ -104,7 +104,7 @@ All you need to do is pass your app to the ``Dynamo`` constructor::
     # app.py
 
     from flask import Flask
-    from flask.ext.dynamo import Dynamo
+    from flask_dynamo import Dynamo
 
     app = Flask(__name__)
     app.config['DYNAMO_TABLES'] = [
@@ -123,8 +123,38 @@ All you need to do is pass your app to the ``Dynamo`` constructor::
 
     dynamo = Dynamo(app)
 
+If you use the app factory pattern then use::
+
+    # app.py
+
+    from flask import Flask
+    from flask_dynamo import Dynamo
+
+    def create_app():
+        app = Flask(__name__)
+        app.config['DYNAMO_TABLES'] = [
+            {
+                 TableName='users',
+                 KeySchema=[dict(AttributeName='username', KeyType='HASH')],
+                 AttributeDefinitions=[dict(AttributeName='username', AttributeType='S')],
+                 ProvisionedThroughput=dict(ReadCapacityUnits=5, WriteCapacityUnits=5)
+            }, {
+                 TableName='groups',
+                 KeySchema=[dict(AttributeName='name', KeyType='HASH')],
+                 AttributeDefinitions=[dict(AttributeName='name', AttributeType='S')],
+                 ProvisionedThroughput=dict(ReadCapacityUnits=5, WriteCapacityUnits=5)
+            }
+        ]
+        dynamo = Dynamo()
+        dynamo.init_app(app)
+        return app
+
+    app = create_app()
+
+
 From this point on, you can interact with DynamoDB through the global ``dynamo``
-object.
+object, or through ``Flask.current_app.extensions['dynamodb']`` if you are
+using the Flask app factory pattern.
 
 
 Create Your Tables
@@ -145,44 +175,30 @@ This works great in bootstrap scripts.
 Working with Tables
 -------------------
 
-Now that you've got everything setup, you can easily access your tables in one
-of two ways: you can either access the table directly from the ``dynamo``
-global, or you can access the table in a dictionary-like format through
-``dynamo.tables``.
+Now that you've got everything setup, you can easily access your tables
+in a dictionary-like format through ``dynamo.tables``.
 
 Below is an example view which creates a new user account::
 
     # app.py
 
     @app.route('/create_user')
     def create_user():
-        dynamo.users.put_item(data={
-            'username': 'rdegges',
-            'first_name': 'Randall',
-            'last_name': 'Degges',
-            'email': '[email protected]',
-        })
-
-        # or ...
-
         dynamo.tables['users'].put_item(data={
             'username': 'rdegges',
             'first_name': 'Randall',
             'last_name': 'Degges',
             'email': '[email protected]',
         })
 
-Either of the above will work the same.
-
 On a related note, you can also use the ``dynamo.tables`` dictionary to iterate
 through all of your tables (*this is sometimes useful*).  Here's how you could
 iterate over your existing DynamoDB tables::
 
     # app.py
 
-    with app.app_context():
-        for table_name, table in dynamo.tables.iteritems():
-            print table_name, table
+    for table_name, table in dynamo.tables.items():
+        print(table_name, table)
 
 
 Deleting Tables
@@ -195,8 +211,7 @@ The below code snippet will destroy all of your predefined DynamoDB tables::
 
     # app.py
 
-    with app.app_context():
-        dynamo.destroy_all()
+    dynamo.destroy_all()
 
 .. note::
     Please be *extremely* careful when running this -- it has the potential to