Merge pull request #74 from adamnsch/user-agent

Set explicit user agent in default constructor

Author: Mats-SX

graphdatascience/__init__.py

@@ -1,4 +1,5 @@
 from .graph_data_science import GraphDataScience
 from .query_runner.query_runner import QueryRunner
+from .version import __version__
 
-__all__ = ["GraphDataScience", "QueryRunner"]
+__all__ = ["GraphDataScience", "QueryRunner", "__version__"]

graphdatascience/graph_data_science.py

@@ -7,6 +7,7 @@
 from .error.uncallable_namespace import UncallableNamespace
 from .query_runner.neo4j_query_runner import Neo4jQueryRunner
 from .query_runner.query_runner import QueryResult, QueryRunner
+from .version import __version__
 
 GDS = TypeVar("GDS", bound="GraphDataScience")
 
@@ -18,20 +19,23 @@ def __init__(
         self, endpoint: Union[str, QueryRunner], auth: Any = None, aura_ds: bool = False
     ):
         if isinstance(endpoint, str):
-            self._config = {}
+            self._config: Dict[str, Any] = {
+                "user_agent": f"neo4j-graphdatascience-v{__version__}"
+            }
+
             if aura_ds:
                 protocol = endpoint.split(":")[0]
                 if not protocol == self._AURA_DS_PROTOCOL:
                     raise ValueError(
-                        f"AuraDS requires using the 'neo4j+s' protocol (provided protocol was '{protocol}')"
+                        f"AuraDS requires using the '{self._AURA_DS_PROTOCOL}' protocol ('{protocol}' was provided)"
                     )
-                self._config = {
-                    "max_connection_lifetime": 60 * 8,  # 8 minutes
-                    "keep_alive": True,
-                    "max_connection_pool_size": 50,
-                }
+
+                self._config["max_connection_lifetime"] = 60 * 8  # 8 minutes
+                self._config["keep_alive"] = True
+                self._config["max_connection_pool_size"] = 50
 
             driver = GraphDatabase.driver(endpoint, auth=auth, **self._config)
+
             self._query_runner = self.create_neo4j_query_runner(driver)
         else:
             self._query_runner = endpoint

graphdatascience/tests/integration/test_database_ops.py

@@ -4,6 +4,7 @@
 from graphdatascience.graph_data_science import GraphDataScience
 from graphdatascience.query_runner.neo4j_query_runner import Neo4jQueryRunner
 from graphdatascience.tests.integration.conftest import AUTH, URI
+from graphdatascience.version import __version__
 
 GRAPH_NAME = "g"
 
@@ -34,28 +35,29 @@ def test_from_neo4j_driver(neo4j_driver: Driver) -> None:
 def test_from_neo4j_credentials() -> None:
     gds = GraphDataScience(URI, auth=AUTH)
     assert len(gds.list()) > 10
+    assert gds.driver_config()["user_agent"] == f"neo4j-graphdatascience-v{__version__}"
 
 
 def test_aurads_rejects_bolt() -> None:
     with pytest.raises(
         ValueError,
-        match=r"AuraDS requires using the 'neo4j\+s' protocol \(provided protocol was 'bolt'\)",
+        match=r"AuraDS requires using the 'neo4j\+s' protocol \('bolt' was provided\)",
     ):
         GraphDataScience("bolt://localhost:7687", auth=AUTH, aura_ds=True)
 
 
 def test_aurads_rejects_neo4j() -> None:
     with pytest.raises(
         ValueError,
-        match=r"AuraDS requires using the 'neo4j\+s' protocol \(provided protocol was 'neo4j'\)",
+        match=r"AuraDS requires using the 'neo4j\+s' protocol \('neo4j' was provided\)",
     ):
         GraphDataScience("neo4j://localhost:7687", auth=AUTH, aura_ds=True)
 
 
 def test_aurads_rejects_neo4j_ssc() -> None:
     with pytest.raises(
         ValueError,
-        match=r"AuraDS requires using the 'neo4j\+s' protocol \(provided protocol was 'neo4j\+ssc'\)",
+        match=r"AuraDS requires using the 'neo4j\+s' protocol \('neo4j\+ssc' was provided\)",
     ):
         GraphDataScience("neo4j+ssc://localhost:7687", auth=AUTH, aura_ds=True)
 
@@ -66,6 +68,7 @@ def test_aurads_accepts_neo4j_s() -> None:
     assert gds.driver_config()["keep_alive"]
     assert gds.driver_config()["max_connection_lifetime"] == 60 * 8
     assert gds.driver_config()["max_connection_pool_size"] == 50
+    assert gds.driver_config()["user_agent"] == f"neo4j-graphdatascience-v{__version__}"
 
 
 def test_run_cypher(gds: GraphDataScience) -> None:

graphdatascience/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

setup.py

@@ -6,6 +6,9 @@
 with open("requirements/base.txt", "r", encoding="utf-8") as f:
     reqs = f.read().splitlines()
 
+with open("graphdatascience/version.py") as f:
+    version = f.readline().strip().split()[-1][1:-1]
+
 classifiers = [
     "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
@@ -26,7 +29,7 @@
 
 setuptools.setup(
     name="graphdatascience",
-    version="0.1.0",
+    version=version,
     author="Neo4j",
     author_email="team-gds@neo4j.org",
     description="A Python client for the Neo4j Graph Data Science (GDS) library",