PLAT-245 -- Amend library as per PR.

Author: gianchub

docs/source/index.rst

@@ -13,71 +13,72 @@ PyTest Example
 Comparing two schemas is easy. You can verify they are the same like
 this:
 
-.. literalinclude:: ../../test/endtoend/test_example.py
-    :lines: 6,8,9,13-22
-
-
-You can also verify that they are different:
-
-.. literalinclude:: ../../test/endtoend/test_example.py
-    :lines: 25-33
-
-
-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.
-
-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:
-
-
-.. code-block:: JSON
-
-    {
-        'tables': {
-            'left_only': ['addresses'],
-            'right_only': ['roles']
-        },
-        'tables_data': {
-            'employees': {
-                'columns': {
-                    'left_only': [
-                        {
-                            'default': None,
-                            'name': 'favourite_meal',
-                            'nullable': False,
-                            'type': "ENUM('meat','vegan')"
-                        }
-                    ],
-                    'right_only': [
-                        {
-                            'autoincrement': False,
-                            'default': None,
-                            'name': 'role_id',
-                            'nullable': False,
-                            'type': 'INTEGER(11)'
-                        },
-                        {
-                            'autoincrement': False,
-                            'default': None,
-                            'name': 'number_of_pets',
-                            'nullable': False,
-                            'type': 'INTEGER(11)'
+.. code-block:: Python
+
+    >>> result = compare(uri_left, uri_right)
+    >>> result.is_match
+        True
+
+
+When they are different, ``result.is_match`` will be ``False``.
+
+When two schemas don't match, you can inspect the differences between
+them by looking at the ``errors`` dict on the ``result``:
+
+.. code-block:: Python
+
+    >>> result = compare(uri_left, uri_right)
+    >>> result.is_match
+        False
+    >>> result.errors
+            {
+                'tables': {
+                    'left_only': ['addresses'],
+                    'right_only': ['roles']
+                },
+                'tables_data': {
+                    'employees': {
+                        'columns': {
+                            'left_only': [
+                                {
+                                    'default': None,
+                                    'name': 'favourite_meal',
+                                    'nullable': False,
+                                    'type': "ENUM('meat','vegan')"
+                                }
+                            ],
+                            'right_only': [
+                                {
+                                    'autoincrement': False,
+                                    'default': None,
+                                    'name': 'role_id',
+                                    'nullable': False,
+                                    'type': 'INTEGER(11)'
+                                },
+                                {
+                                    'autoincrement': False,
+                                    'default': None,
+                                    'name': 'number_of_pets',
+                                    'nullable': False,
+                                    'type': 'INTEGER(11)'
+                                },
+                            ]
                         },
-                    ]
+                        'foreign_keys': { ... },
+                        'primary_keys': { ... },
+                        'indexes': { .. }
+                    },
+                    'phone_numbers': { ... }
                 },
-                'foreign_keys': { ... },
-                'primary_keys': { ... },
-                'indexes': { .. }
-            },
-            'phone_numbers': { ... }
-        },
-        'uris': {
-            'left': "your left URI",
-            'right': "your right URI",
-        }
-    }
+                'uris': {
+                    'left': "your left URI",
+                    'right': "your right URI",
+                }
+            }
+
+
+If you wish to persist that dict to a JSON file, you can quickly do so
+by calling ``result.dump_errors()``.
 
 
 Features

setup.py

@@ -13,7 +13,7 @@
 
 setup(
     name='sqlalchemy-diff',
-    version='0.0.2',
+    version='0.0.3',
     description='Compare two database schemas using sqlalchemy.',
     long_description=readme,
     author='student.com',
@@ -34,11 +34,6 @@
             "Sphinx==1.3.1",
         ],
     },
-    entry_points={
-        'pytest11': [
-            'sqlalchemy_diff=sqlalchemydiff.pyfixtures'
-        ]
-    },
     zip_safe=True,
     license='Apache License, Version 2.0',
     classifiers=[

sqlalchemydiff/pyfixtures.py

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+import pytest
+
+
+@pytest.fixture(scope="module")
+def db_uri():
+    return "mysql+mysqlconnector://root:@localhost/sqlalchemydiff"

test/endtoend/conftest.py

@@ -4,13 +4,42 @@
 import pytest
 
 from sqlalchemydiff.comparer import compare
-from sqlalchemydiff.util import prepare_schema_from_models
+from sqlalchemydiff.util import (
+    destroy_database,
+    get_temporary_uri,
+    new_db,
+    prepare_schema_from_models,
+)
 from .models_left import Base as Base_left
 from .models_right import Base as Base_right
 
 from test import assert_items_equal
 
 
+@pytest.fixture(scope="module")
+def uri_left(db_uri):
+    return get_temporary_uri(db_uri)
+
+
+@pytest.fixture(scope="module")
+def uri_right(db_uri):
+    return get_temporary_uri(db_uri)
+
+
+@pytest.yield_fixture
+def new_db_left(uri_left):
+    new_db(uri_left)
+    yield
+    destroy_database(uri_left)
+
+
+@pytest.yield_fixture
+def new_db_right(uri_right):
+    new_db(uri_right)
+    yield
+    destroy_database(uri_right)
+
+
 @pytest.mark.usefixtures("new_db_left")
 @pytest.mark.usefixtures("new_db_right")
 def test_same_schema_is_the_same(uri_left, uri_right):