Updated README and docs

technige · technige · commit 3f45b0fe0345 · 2018-08-13T16:26:27.000+01:00
diff --git a/README.rst b/README.rst
@@ -2,15 +2,15 @@
 Neo4j Bolt Driver for Python
 ****************************
 
-The Official Neo4j Driver for Python supports Neo4j 3.0 and above and Python versions 2.7, 3.4, 3.5 and 3.6.
+The official Neo4j driver for Python supports Neo4j 3.0 and above and Python versions 2.7, 3.4, 3.5, 3.6, and 3.7.
 
 
 Quick Example
 =============
 
 .. code-block:: python
 
-    from neo4j.v1 import GraphDatabase
+    from neo4j import GraphDatabase
 
     driver = GraphDatabase.driver("bolt://localhost:7687", auth=("neo4j", "password"))
 
@@ -38,13 +38,13 @@ To install the latest stable version, use:
 
 .. code:: bash
 
-    pip install neo4j-driver
+    pip install neo4j
 
 For the most up-to-date version (generally unstable), use:
 
 .. code:: bash
 
-    pip install git+https://github.com/neo4j/neo4j-python-driver.git#egg=neo4j-driver
+    pip install git+https://github.com/neo4j/neo4j-python-driver.git#egg=neo4j
 
 
 Other Information
diff --git a/docs/source/driver.rst b/docs/source/driver.rst
@@ -12,10 +12,10 @@ Construction
 
 :class:`.Driver` construction can either be carried out directly or via a `classmethod` on the :class:`.GraphDatabase` class.
 
-.. autoclass:: neo4j.v1.GraphDatabase
+.. autoclass:: neo4j.GraphDatabase
    :members:
 
-.. autoclass:: neo4j.v1.Driver(uri, **config)
+.. autoclass:: neo4j.Driver(uri, **config)
    :members:
 
 
@@ -42,7 +42,7 @@ This may be a standalone server or could be a specific member of a cluster.
 
 Connections established by a :class:`.DirectDriver` are always made to the exact host and port detailed in the URI.
 
-.. autoclass:: neo4j.v1.DirectDriver
+.. autoclass:: neo4j.DirectDriver
    :members:
    :inherited-members:
 
@@ -55,7 +55,7 @@ URI scheme:
 Driver subclass:
     :class:`.RoutingDriver`
 
-.. autoclass:: neo4j.v1.RoutingDriver
+.. autoclass:: neo4j.RoutingDriver
    :members:
    :inherited-members:
 
@@ -72,9 +72,9 @@ An authentication token for the server.
 For basic auth, this can be a simple tuple, for example ``("neo4j", "password")``.
 Alternatively, one of the auth token functions can be used.
 
-.. autofunction:: neo4j.v1.basic_auth
+.. autofunction:: neo4j.basic_auth
 
-.. autofunction:: neo4j.v1.custom_auth
+.. autofunction:: neo4j.custom_auth
 
 ``encrypted``
 -------------
@@ -88,14 +88,14 @@ Defaults to :py:const:`True` if TLS is available.
 The trust level for certificates received from the server during TLS negotiation.
 This setting does not have any effect if ``encrypted`` is set to :py:const:`False`.
 
-.. py:attribute:: neo4j.v1.TRUST_ALL_CERTIFICATES
+.. py:attribute:: neo4j.TRUST_ALL_CERTIFICATES
 
    Trust any server certificate (default). This ensures that communication
    is encrypted but does not verify the server certificate against a
    certificate authority. This option is primarily intended for use with
    the default auto-generated server certificate.
 
-.. py:attribute:: neo4j.v1.TRUST_SYSTEM_CA_SIGNED_CERTIFICATES
+.. py:attribute:: neo4j.TRUST_SYSTEM_CA_SIGNED_CERTIFICATES
 
    Trust server certificates that can be verified against the system
    certificate authority. This option is primarily intended for use with
@@ -173,7 +173,7 @@ For example:
 
 .. code-block:: python
 
-    from neo4j.v1 import GraphDatabase
+    from neo4j import GraphDatabase
 
     class Application(object):
 
diff --git a/docs/source/errors.rst b/docs/source/errors.rst
@@ -2,10 +2,6 @@
 Errors
 ******
 
-
-.. autoclass:: neo4j.exceptions.AddressError
-   :members:
-
 .. autoclass:: neo4j.exceptions.CypherError
    :members:
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,6 +1,6 @@
-********************************
+**************************************
 Neo4j Bolt Driver |version| for Python
-********************************
+**************************************
 
 The Official Neo4j Driver for Python supports Neo4j 3.1 and above and requires Python version 2.7, 3.4, 3.5 or 3.6.
 
@@ -10,7 +10,7 @@ Quick Example
 
 .. code-block:: python
 
-    from neo4j.v1 import GraphDatabase
+    from neo4j import GraphDatabase
 
     uri = "bolt://localhost:7687"
     driver = GraphDatabase.driver(uri, auth=("neo4j", "password"))
@@ -32,13 +32,13 @@ To install the latest stable version, use:
 
 .. code:: bash
 
-    pip install neo4j-driver
+    pip install neo4j
 
 For the most up-to-date version (possibly unstable), use:
 
 .. code:: bash
 
-    pip install git+https://github.com/neo4j/neo4j-python-driver.git#egg=neo4j-driver
+    pip install git+https://github.com/neo4j/neo4j-python-driver.git#egg=neo4j
 
 
 API Documentation
diff --git a/docs/source/results.rst b/docs/source/results.rst
@@ -9,19 +9,19 @@ Each result consists of header metadata, zero or more :class:`.Record` objects a
 Results also contain a buffer that automatically stores unconsumed records when results are consumed out of order.
 A :class:`.BoltStatementResult` is attached to an active connection, through a :class:`.Session`, until all its content has been buffered or consumed.
 
-.. autoclass:: neo4j.v1.BoltStatementResult
+.. autoclass:: neo4j.BoltStatementResult
    :inherited-members:
    :members:
 
-.. autoclass:: neo4j.v1.Record
+.. autoclass:: neo4j.Record
    :members:
 
 
 Summary Details
 ---------------
 
-.. autoclass:: neo4j.v1.result.BoltStatementResultSummary
+.. autoclass:: neo4j.BoltStatementResultSummary
    :members:
 
-.. autoclass:: neo4j.v1.result.SummaryCounters
+.. autoclass:: neo4j.SummaryCounters
    :members:
diff --git a/docs/source/transactions.rst b/docs/source/transactions.rst
@@ -75,8 +75,8 @@ Returning a live result object would prevent the driver from correctly managing
 
 API
 ===
-.. autoclass:: neo4j.v1.Session
+.. autoclass:: neo4j.Session
    :members:
 
-.. autoclass:: neo4j.v1.Transaction
+.. autoclass:: neo4j.Transaction
    :members:
diff --git a/neo4j/__main__.py b/neo4j/__main__.py
@@ -28,7 +28,7 @@
 
 from neobolt.util import Watcher
 
-from .v1 import GraphDatabase
+from neo4j import GraphDatabase
 from neo4j.exceptions import CypherError
 
 
diff --git a/test/auth.py b/test/auth.py
@@ -23,7 +23,7 @@
 
 from neobolt.util import Watcher
 
-from neo4j.v1 import GraphDatabase, basic_auth
+from neo4j import GraphDatabase, basic_auth
 
 
 def update_password(user, password, new_password):
diff --git a/test/examples/auth_example.py b/test/examples/auth_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::basic-auth-import[]
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 # end::basic-auth-import[]
 
 
diff --git a/test/examples/base_application.py b/test/examples/base_application.py
@@ -18,7 +18,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 
 
 class BaseApplication(object):
diff --git a/test/examples/config_connection_pool_example.py b/test/examples/config_connection_pool_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::config-connection-pool-import[]
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 # end::config-connection-pool-import[]
 
 
diff --git a/test/examples/config_connection_timeout_example.py b/test/examples/config_connection_timeout_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::config-connection-timeout-import[]
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 # end::config-connection-timeout-import[]
 
 
diff --git a/test/examples/config_load_balancing_strategy_example.py b/test/examples/config_load_balancing_strategy_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::config-load-balancing-strategy-import[]
-from neo4j.v1 import GraphDatabase, LOAD_BALANCING_STRATEGY_LEAST_CONNECTED
+from neo4j import GraphDatabase, LOAD_BALANCING_STRATEGY_LEAST_CONNECTED
 # end::config-load-balancing-strategy-import[]
 
 
diff --git a/test/examples/config_max_retry_time_example.py b/test/examples/config_max_retry_time_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::config-max-retry-time-import[]
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 # end::config-max-retry-time-import[]
 
 
diff --git a/test/examples/config_trust_example.py b/test/examples/config_trust_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::config-trust-import[]
-from neo4j.v1 import GraphDatabase, TRUST_ALL_CERTIFICATES
+from neo4j import GraphDatabase, TRUST_ALL_CERTIFICATES
 # end::config-trust-import[]
 
 
diff --git a/test/examples/config_unencrypted_example.py b/test/examples/config_unencrypted_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::config-unencrypted-import[]
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 # end::config-unencrypted-import[]
 
 
diff --git a/test/examples/custom_auth_example.py b/test/examples/custom_auth_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::custom-auth-import[]
-from neo4j.v1 import GraphDatabase, custom_auth
+from neo4j import GraphDatabase, custom_auth
 # end::custom-auth-import[]
 
 
diff --git a/test/examples/cypher_error_example.py b/test/examples/cypher_error_example.py
@@ -21,7 +21,7 @@
 from test.examples.base_application import BaseApplication
 
 # tag::cypher-error-import[]
-from neo4j.v1 import ClientError
+from neo4j import ClientError
 # end::cypher-error-import[]
 
 
diff --git a/test/examples/driver_lifecycle_example.py b/test/examples/driver_lifecycle_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::driver-lifecycle-import[]
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 # end::driver-lifecycle-import[]
 
 
diff --git a/test/examples/hello_world_example.py b/test/examples/hello_world_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::hello-world-import[]
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 # end::hello-world-import[]
 
 
diff --git a/test/examples/kerberos_auth_example.py b/test/examples/kerberos_auth_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag::kerberos-auth-import[]
-from neo4j.v1 import GraphDatabase, kerberos_auth
+from neo4j import GraphDatabase, kerberos_auth
 # end::kerberos-auth-import[]
 
 
diff --git a/test/examples/pass_bookmarks_example.py b/test/examples/pass_bookmarks_example.py
@@ -19,7 +19,7 @@
 # limitations under the License.
 
 # tag:pass-bookmarks-import[]
-from neo4j.v1 import GraphDatabase
+from neo4j import GraphDatabase
 # end::pass-bookmarks-import[]
 
 
diff --git a/test/examples/test_examples.py b/test/examples/test_examples.py
@@ -175,13 +175,13 @@ def test_transaction_function_example(self):
         self.assertEqual(self.person_count("Alice"), 1)
 
     def read(self, statement):
-        from neo4j.v1 import GraphDatabase
+        from neo4j import GraphDatabase
         with GraphDatabase.driver(self.bolt_uri, auth=self.auth_token) as driver:
             with driver.session() as session:
                 return session.read_transaction(lambda tx: tx.run(statement))
 
     def write(self, statement):
-        from neo4j.v1 import GraphDatabase
+        from neo4j import GraphDatabase
         with GraphDatabase.driver(self.bolt_uri, auth=self.auth_token) as driver:
             with driver.session() as session:
                 return session.write_transaction(lambda tx: tx.run(statement))
@@ -190,7 +190,7 @@ def clean(self):
         self.write("MATCH (a) DETACH DELETE a")
         
     def person_count(self, name):
-        from neo4j.v1 import GraphDatabase
+        from neo4j import GraphDatabase
         with GraphDatabase.driver(self.bolt_uri, auth=self.auth_token) as driver:
             with driver.session() as session:
                 record_list = list(session.run("MATCH (a:Person {name: $name}) RETURN count(a)", {"name": name}))
diff --git a/test/integration/test_driver.py b/test/integration/test_driver.py
@@ -21,7 +21,7 @@
 
 from neobolt.direct import DEFAULT_PORT
 
-from neo4j.v1 import GraphDatabase, Driver, ServiceUnavailable
+from neo4j import GraphDatabase, Driver, ServiceUnavailable
 
 from test.integration.tools import IntegrationTestCase
 
diff --git a/test/integration/test_readme.py b/test/integration/test_readme.py
@@ -31,7 +31,7 @@ def test_should_run_readme(self):
         names = set()
         print = names.add
 
-        from neo4j.v1 import GraphDatabase
+        from neo4j import GraphDatabase
 
         driver = GraphDatabase.driver(self.bolt_uri, auth=self.auth_token)
 
diff --git a/test/integration/test_security.py b/test/integration/test_security.py
@@ -21,7 +21,7 @@
 
 from socket import socket
 
-from neo4j.v1 import GraphDatabase, TRUST_CUSTOM_CA_SIGNED_CERTIFICATES
+from neo4j import GraphDatabase, TRUST_CUSTOM_CA_SIGNED_CERTIFICATES
 from neo4j.exceptions import AuthError
 
 from test.integration.tools import IntegrationTestCase
diff --git a/test/integration/test_session.py b/test/integration/test_session.py
@@ -22,7 +22,7 @@
 from unittest import SkipTest
 from uuid import uuid4
 
-from neo4j.v1 import \
+from neo4j import \
     READ_ACCESS, WRITE_ACCESS, \
     CypherError, SessionError, TransactionError
 from neo4j.v1.types.graph import Node, Relationship, Path
diff --git a/test/integration/tools.py b/test/integration/tools.py
