PLAT-245 -- Amend library according to code review.

Author: gianchub

README.rst

@@ -3,6 +3,7 @@ SQLAlchemy Diff
 
 .. pull-quote::
 
-    Compare two database schemas using SQLAlchemy.
+    Compare and generate a diff between two databases using SQLAlchemy's
+    inspection API.
 
 Documentation here: (link to read the docs)

docs/__init__.py

@@ -3,36 +3,34 @@ SQLAlchemy Diff
 
 .. pull-quote::
 
-    Compare two database schemas using SQLAlchemy.
+    Compare and generate a diff between two databases using SQLAlchemy's
+    inspection API
 
 
 PyTest Example
 --------------
 
-This is how you can use the library to verify that two schemas are
-the same:
+Comparing two schemas is easy. You can verify they are the same like
+this:
 
-.. literalinclude:: ../testing/test_example.py
+.. literalinclude:: ../../test/endtoend/test_example.py
     :lines: 6,8,9,13-22
-    :emphasize-lines: 11
 
 
-You can also make sure that two schemas are different:
+You can also verify that they are different:
 
-.. literalinclude:: ../testing/test_example.py
+.. literalinclude:: ../../test/endtoend/test_example.py
     :lines: 25-33
-    :emphasize-lines: 7
 
 
-If your test fails, you can dump the errors to a file by just adding
-the following line of code:
+You will get back a ``result`` object: ``result.is_match`` will be
+``True`` when the two schemas are the same, and ``False`` when they are
+different.
 
-.. code-block:: Python
+When two schemas don't match, you can call ``result.dump_errors()`` to
+save all the differences between them to a JSON file that will look
+like this:
 
-    result.dump_errors()
-
-
-That will dump the errors dict to a JSON file that looks like this:
 
 .. code-block:: JSON
 
@@ -82,15 +80,6 @@ That will dump the errors dict to a JSON file that looks like this:
     }
 
 
-Using unittest
---------------
-
-If you prefer, you can use unittest:
-
-.. literalinclude:: ../testing/test_unittest.py
-    :lines: 2-47
-
-
 Features
 --------
 
@@ -109,10 +98,3 @@ Installation
 .. code-block:: bash
 
     $ pip install sqlalchemy-diff
-
-
-Full Example
-------------
-
-:ref:`Here <full_example>` you can find a full example on how to test
-two databases which are different.

docs/source/full_example.rst

@@ -13,21 +13,21 @@
 
 setup(
     name='sqlalchemy-diff',
-    version='0.0.1',
+    version='0.0.2',
     description='Compare two database schemas using sqlalchemy.',
     long_description=readme,
     author='student.com',
-    author_email='dark-side@student.com',  # TODO - Add proper email here
+    author_email='wearehiring@student.com',
     url='https://github.com/Overseas-Student-Living/sqlalchemy-diff',
     packages=find_packages(exclude=['docs', 'test', 'test.*']),
     install_requires=[
         "six==1.10.0",
         "mock==1.3.0",
-        "mysql-connector-python==2.0.4",
         "sqlalchemy-utils==0.31.2",
     ],
     extras_require={
         'dev': [
+            "mysql-connector-python==2.0.4",
             "pytest==2.8.2",
         ],
         'docs': [

docs/source/index.rst

@@ -103,25 +103,3 @@ def prepare_schema_from_models(uri, sqlalchemy_base):
     """Creates the database schema from the ``SQLAlchemy`` models. """
     engine = create_engine(uri)
     sqlalchemy_base.metadata.create_all(engine)
-
-
-def walk_dict(d, path):
-    """Walks a dict given a path of keys.
-
-    For example, if we have a dict like this::
-
-        d = {
-            'a': {
-                'B': {
-                    1: ['hello', 'world'],
-                    2: ['hello', 'again'],
-                }
-            }
-        }
-
-    Then ``walk_dict(d, ['a', 'B', 1])`` would return
-    ``['hello', 'world']``.
-    """
-    if not path:
-        return d
-    return walk_dict(d[path[0]], path[1:])

setup.py

@@ -4,7 +4,7 @@
 import pytest
 
 from sqlalchemydiff.comparer import compare
-from sqlalchemydiff.util import prepare_schema_from_models, walk_dict
+from sqlalchemydiff.util import prepare_schema_from_models
 from .models_left import Base as Base_left
 from .models_right import Base as Base_right
 
@@ -233,3 +233,25 @@ def compare_error_dicts(err1, err2):
         assert_items_equal(walk_dict(err1, path), walk_dict(err2, path))
 
     assert sorted(json.dumps(err1)) == sorted(json.dumps(err2))
+
+
+def walk_dict(d, path):
+    """Walks a dict given a path of keys.
+
+    For example, if we have a dict like this::
+
+        d = {
+            'a': {
+                'B': {
+                    1: ['hello', 'world'],
+                    2: ['hello', 'again'],
+                }
+            }
+        }
+
+    Then ``walk_dict(d, ['a', 'B', 1])`` would return
+    ``['hello', 'world']``.
+    """
+    if not path:
+        return d
+    return walk_dict(d[path[0]], path[1:])