Add helper functions for reading from env variables

Co-authored-by: Rafal Skolasinski <[email protected]>

Author: FlorentinD

changelog.md

@@ -13,6 +13,9 @@
 
 * Allow creating sessions of size `512GB`.
 * Allow passing additional parameters for the Neo4j driver connection to `GdsSessions.get_or_create(neo4j_driver_config={..})`
+* Add helper functions to create config objects from environment variables
+    * `AuraApiCredentials::from_env`
+    * `DbmsConnectionInfo::from_env`
 
 
 ## Other changes

graphdatascience/session/dbms_connection_info.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import os
 from dataclasses import dataclass
 from typing import Optional
 
@@ -23,3 +24,20 @@ def auth(self) -> tuple[str, str]:
             A tuple containing the username and password.
         """
         return self.username, self.password
+
+    @staticmethod
+    def from_env() -> DbmsConnectionInfo:
+        """
+        Create a DbmsConnectionInfo instance from environment variables.
+        The environment variables are:
+            - NEO4J_URI
+            - NEO4J_USERNAME
+            - NEO4J_PASSWORD
+            - NEO4J_DATABASE
+        """
+        uri = os.environ["NEO4J_URI"]
+        username = os.environ.get("NEO4J_USERNAME", "neo4j")
+        password = os.environ["NEO4J_PASSWORD"]
+        database = os.environ.get("NEO4J_DATABASE")
+
+        return DbmsConnectionInfo(uri, username, password, database)

graphdatascience/session/gds_sessions.py

@@ -30,6 +30,21 @@ class AuraAPICredentials:
     client_secret: str
     project_id: Optional[str] = None
 
+    @staticmethod
+    def from_env() -> AuraAPICredentials:
+        """
+        Create an AuraApi instance from environment variables.
+        The environment variables are:
+            - CLIENT_ID
+            - CLIENT_SECRET
+            - PROJECT_ID
+        """
+        client_id = os.environ["CLIENT_ID"]
+        client_secret = os.environ["CLIENT_SECRET"]
+        project_id = os.environ.get("PROJECT_ID")
+
+        return AuraAPICredentials(client_id, client_secret, project_id)
+
 
 class GdsSessions:
     """