umnetdb-utils 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

umnetdb_utils/base.py

@@ -2,6 +2,7 @@
 from os import getenv
 import re
 import logging
+from decouple import Config, RepositoryEnv
 
 from sqlalchemy import create_engine, text
 from sqlalchemy.orm import Session
@@ -15,13 +16,20 @@ class UMnetdbBase:
     # set in child classes - you can use environment variables within curly braces here
     URL = None
 
-    def __init__(self):
+    def __init__(self, env_file:str=".env"):
         """
-        Initiate a umnetdb object. Note that you must provide either a url or a path
-        to an env file that looks like the 'sample_env' provided in this repo.
-        If both are provided, the url takes precedence.
+        Initiate a umnetdb object. Optionally provide a path to a file with environment variables
+        containing the credentials for the database. If no file is provided and there's no ".env",
+        the code will look in the user's environment (os.getenv) for these values.
         """
+
+        try:
+            self._env = Config(RepositoryEnv(env_file))
+        except FileNotFoundError:
+            self._env = {}
+
         self.url = self._resolve_url()
+
         self.engine = create_engine(self.url)
         self.session = None
 
@@ -34,10 +42,11 @@ class UMnetdbBase:
         url = self.URL
         for m in re.finditer(r"{(\w+)}", url):
             var = m.group(1)
+            val = self._env.get(var, getenv(var))
 
-            if not getenv(var):
-                raise ValueError(f"Undefined environment variable {var} in {url}")
-            url = re.sub(r"{" + var + "}", getenv(var), url)
+            if not val:
+                raise ValueError(f"Undefined environment variable {val} in {url}")
+            url = re.sub(r"{" + var + "}", val, url)
 
         return url
 
@@ -126,7 +135,12 @@ class UMnetdbBase:
 
     def _execute(self, sql, rows_as_dict=True):
         '''
-        Generic sqlalchemy "execute this sql command and give me all the results"
+        Generic sqlalchemy "open a session, execute this sql command and give me all the results"
+
+        NB This function is defined for legacy database classes that came from umnet-scripts.
+        It's encouraged to use "self.session.execute" in other child methods, allowing
+        scripts that import the child class to use the context manager and execute multiple
+        mehtods within the same session.
         '''
         with self as session:
             r = session.execute(text(sql))

umnetdb_utils-0.1.1.dist-info/METADATA

@@ -0,0 +1,35 @@
+Metadata-Version: 2.3
+Name: umnetdb-utils
+Version: 0.1.1
+Summary: Helper classes for querying UMnet databases
+License: MIT
+Author: Amy Liebowitz
+Author-email: amylieb@umich.edu
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: oracledb (>=3.1.0,<4.0.0)
+Requires-Dist: psycopg[binary] (>=3.2.9,<4.0.0)
+Requires-Dist: python-decouple (>=3.8,<4.0)
+Requires-Dist: sqlalchemy (>=2.0.41,<3.0.0)
+Description-Content-Type: text/markdown
+
+# umnetdb-utils
+Helper classes for gathering data from umnet databases
+
+This package is hosted on pypi - you can install it with `pip install umnetdb-utils` and use it in your own code.
+
+## Database Helper Classes
+As of May 2025 this repo defines db wrapper classes for Equipdb, Netinfo, Netdisco and UMnetdb (populated by agador, hosted on wintermute).
+To use these classes you need to set specific environment variables with the credentials for each db respectively:
+* Netinfo: `NETINFO_USERNAME`, `NETINFO_PASSSWORD`
+* Netdisco: `NETDISCO_DB_USER`, `NETDISCO_DB_PASSWORD`
+* Equipdb: `EQUIP_DB_USER`, `EQUIP_DB_PASSWORD`
+* UMnetdb: `UMNETDB_USER`, `UMNETDB_PASSWORD`
+
+Netinfo, Netdisco, and Equipdb classes are copied over from `umnet-scripts` which is reaching the end of its life as a package.
+

{umnetdb_utils-0.1.0.dist-info → umnetdb_utils-0.1.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
 umnetdb_utils/__init__.py,sha256=QJaytbr4ccKESiwaKjpf1b4b8s2cHNfCDdnCOs1tmoI,131
-umnetdb_utils/base.py,sha256=u0ZEKb3Vx8aSTrN8r4dbVCSpKHaBVw0Aw4VwTZfMRjc,4609
+umnetdb_utils/base.py,sha256=PCtc08eZ1BwExSY1nm-eGWMTd_V56fsZXhXq2D6rU0Q,5231
 umnetdb_utils/umnetdb.py,sha256=2jPsZsJWFtwWKIRqww86B8tRWBQ0cbw3iOk9PwAXaxY,1948
 umnetdb_utils/umnetdisco.py,sha256=Z2XwT79jKO_avd3w_z99DDEdAikrfKxYm1JYHRWqvG4,7841
 umnetdb_utils/umnetequip.py,sha256=jOW5kvk0FXtdHv8PA4rYT_PWfLdMiq83Mjwmy-c1DN8,5701
 umnetdb_utils/umnetinfo.py,sha256=MH1YDW4OWtHD46qfYb5Pv40vPSbL0GrMNW5gAhdlihE,18445
 umnetdb_utils/utils.py,sha256=wU6QMYfofj7trX3QeqXty0btbGdhP_RUaSqA7QTflFM,991
-umnetdb_utils-0.1.0.dist-info/METADATA,sha256=JTcsp2paNp2hNZowNqNbfGyZIx23TKym5x3pVtz5GBc,750
-umnetdb_utils-0.1.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-umnetdb_utils-0.1.0.dist-info/RECORD,,
+umnetdb_utils-0.1.1.dist-info/METADATA,sha256=T0ycl5URR_p5V8qWkm-IBk1VuDLsvEkwGZbUMYZFm-M,1521
+umnetdb_utils-0.1.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+umnetdb_utils-0.1.1.dist-info/RECORD,,

umnetdb_utils-0.1.0.dist-info/METADATA

@@ -1,22 +0,0 @@
-Metadata-Version: 2.3
-Name: umnetdb-utils
-Version: 0.1.0
-Summary: Helper classes for querying UMnet databases
-License: MIT
-Author: Amy Liebowitz
-Author-email: amylieb@umich.edu
-Requires-Python: >=3.10
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: oracledb (>=3.1.0,<4.0.0)
-Requires-Dist: psycopg[binary] (>=3.2.9,<4.0.0)
-Requires-Dist: sqlalchemy (>=2.0.41,<3.0.0)
-Description-Content-Type: text/markdown
-
-# umnetdb-utils
-Helper classes for gathering data from umnet databases
-