commonlib-reader 1.0.6__tar.gz → 1.0.8__tar.gz

{commonlib_reader-1.0.6 → commonlib_reader-1.0.8}/PKG-INFO

@@ -1,18 +1,18 @@
 Metadata-Version: 2.3
 Name: commonlib-reader
-Version: 1.0.6
+Version: 1.0.8
 Summary: Reader for Equinor commonlib api.
 License: MIT
 Author: Åsmund Våge Fannemel
 Author-email: asmf@equinor.com
-Requires-Python: >=3.9.2,<4.0.0
+Requires-Python: >=3.10,<4.0.0
 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: msal_bearer (>=1.3.3,<2.0.0)
+Requires-Dist: eq-api-connector (>=1.0.0,<2.0.0)
 Requires-Dist: pandas (>=2.1.4)
 Requires-Dist: requests (>=2.32.4)
 Requires-Dist: urllib3 (>=2.5.0)

commonlib_reader-1.0.8/commonlib_reader/connector.py

@@ -0,0 +1,29 @@
+from eq_api_connector import APIConnector
+
+_connector = None
+
+
+def get_connector() -> APIConnector:
+    """Get a singleton instance of the APIConnector.
+
+    Returns:
+        APIConnector: An instance of the APIConnector class.
+    """
+    global _connector
+    if _connector is None:
+        clientID = "728cfddd-b8e9-4ed7-b9a3-8f2fd5b8e79a"
+        scopes = ["37d598fc-da0f-46bd-949f-7107918d47a5/user_impersonation"]
+        _connector = APIConnector(client_id=clientID, scope=scopes)
+        _connector.set_url_prod("https://commonlibapi.equinor.com/")
+
+    return _connector
+
+
+def set_connector(connector: APIConnector):
+    """Set the singleton instance of the APIConnector.
+
+    Args:
+        connector (APIConnector): An instance of the APIConnector class.
+    """
+    global _connector
+    _connector = connector

{commonlib_reader-1.0.6 → commonlib_reader-1.0.8}/commonlib_reader/facility.py

@@ -15,6 +15,7 @@ class Facility:
         Field (str)            : Field identifier associated with the facility (if available).
         ParentFacility (str)   : Parent facility identifier (if available).
         NPDID (str)            : NPD ID (if available).
+        GovernmentalName (str) : Governmental facility name (if available).
 
     _cache (list of dict, optional):
         Class level cache to store facility data, to minimize data source access.
@@ -41,14 +42,23 @@ class Facility:
         self.name = self._data["name"]
         self.description = self._data["description"]
 
-        common_attributes = ["SAPPlant", "Field", "ParentFacility", "NPDID"]
-        for attr in common_attributes:
-            self.__setattr__(attr, "")
+        self.SAPPlant = ""
+        self.Field = ""
+        self.ParentFacility = ""
+        self.NPDID = ""
+        self.GovernmentalName = ""
 
         for key, val in self._attributes.items():
-            if key in common_attributes:
+            if key in self.__getattribute__("__dict__").keys():
                 self.__setattr__(key, val)
 
+        self.STID = self.identity  # Alias for identity
+        self.instCode = self.identity  # Alias for identity
+        try:
+            self.SAP = int(self.SAPPlant)  # Alias for SAPPlant as integer
+        except (TypeError, ValueError):
+            pass
+
     def isSTID(self):
         """
         Checks if the facility is marked for STID.
@@ -62,6 +72,9 @@ class Facility:
 
         return False
 
+    def __str__(self):
+        return f"Facility: {self.identity}, Name: {self.name}, Description: {self.description}"
+
     @classmethod
     def get_all_facilities(cls) -> List["Facility"]:
         """
@@ -92,7 +105,7 @@ class Facility:
         Retrieves the facility data for the given code.
 
         Parameters:
-            code (str): The STID plant code corresponding to the facility.
+            code (str): The STID plant code corresponding to the facility. NB! SAP codes and governmental facility names can also be used.
 
         Returns:
             dict: A dictionary containing data related to the facility.

{commonlib_reader-1.0.6 → commonlib_reader-1.0.8}/commonlib_reader/ims.py

@@ -1,4 +1,5 @@
 from typing import List, Union
+from commonlib_reader.facility import Facility
 from commonlib_reader.utils import attributes_list_to_dict, get_code
 
 
@@ -23,7 +24,7 @@ class IMS:
         Raises:
             ValueError: If input data is not a dict.
         """
-        if isinstance(data, str):
+        if isinstance(data, str) or isinstance(data, int):
             data = IMS.from_facility(data)._data
 
         if not isinstance(data, dict):
@@ -42,11 +43,11 @@ class IMS:
             self.__setattr__(attr["definitionName"], attr["displayValue"])
 
     @staticmethod
-    def from_facility(facility: str) -> "IMS":
+    def from_facility(facility: Union[Facility, str, int]) -> "IMS":
         """Get IMS instance from STID code.
 
         Args:
-            facility (str): Facility code
+            facility (str): Facility inst code (STID) or SAP code.
 
         Raises:
             ValueError: Not able to instantiate IMS object from input facility code.
@@ -54,10 +55,15 @@ class IMS:
         Returns:
             IMS: IMS instance
         """
-        if facility is None or len(facility) == 0:
-            raise ValueError(
-                "Facility must be provided. Empty strings are not allowed."
-            )
+        if isinstance(facility, int):
+            facility = Facility(facility).identity
+
+        if isinstance(facility, Facility):
+            facility = facility.identity
+
+        if not isinstance(facility, str) or len(facility) == 0:
+            raise ValueError("Not able to detect facility from input {facility}.")
+
         ims = IMS.get_ims_list(facility=facility)
         if len(ims) == 1:
             return ims[0]

{commonlib_reader-1.0.6 → commonlib_reader-1.0.8}/commonlib_reader/utils.py

@@ -3,12 +3,12 @@ from typing import Dict, List, Optional
 from urllib.parse import urljoin
 
 import requests
-from msal_bearer import BearerAuth, get_user_name
+
+from commonlib_reader.connector import get_connector
 
 
 def get_library_names():
-    url = urljoin(get_api_url(), "api/Library/NameList")
-    library_names = get_json(url=url)
+    library_names = get_connector().get_json(url="/api/Library/NameList")
     library_names.sort()
     return library_names
 
@@ -31,67 +31,13 @@ def get_code_param(code, params=None):
     if params is None:
         params = {}
 
-    url = urljoin(get_api_url(), f"api/Code/{code}")
-    return get_json(url, params=params)
+    return get_connector().get_json(f"/api/Code/{code}", params=params)
 
 
 def query_sql(sql: str):
     return post_sql(sql=sql, take=0, skip=0)
 
 
-def get_api_url() -> str:
-    """Get base url to api
-
-    Returns:
-        str: Base url to api
-    """
-    return "https://commonlibapi.equinor.com/"
-
-
-def get_auth() -> BearerAuth:
-    """Get Bearerauth object including token for accessing api.
-
-    Returns:
-        BearerAuth: Object with access token for api.
-    """
-    tenantID = "3aa4a235-b6e2-48d5-9195-7fcf05b459b0"
-    clientID = "728cfddd-b8e9-4ed7-b9a3-8f2fd5b8e79a"
-    scopes = ["37d598fc-da0f-46bd-949f-7107918d47a5/user_impersonation"]
-    auth = BearerAuth.get_auth(
-        tenantID=tenantID,
-        clientID=clientID,
-        scopes=scopes,
-        username=f"{get_user_name()}@equinor.com",
-    )
-
-    return auth
-
-
-def get_json(url: str, params=None) -> list:
-    """Get json from api endpoint
-
-    Args:
-        url (str): Url to api endpoint to get.
-        params (dict, optional): Dictionary of parameters to pass. Defaults to None.
-
-    Returns:
-        list: List of response from api
-    """
-    response = requests.get(url, auth=get_auth(), params=params)
-    # response.raise_for_status()
-    if response.status_code == 200:
-        try:
-            return response.json()
-        except json.JSONDecodeError:
-            print(
-                f"Warning: {str(url)} returned successfully, but not with a valid json response"
-            )
-    else:
-        print(f"Warning: {str(url)} returned status code {response.status_code}")
-
-    return []
-
-
 def post_sql(sql: str, take: int = 100, skip: int = 0) -> list:
     """Get json from api/sql endpoint accepting sql queries.
 
@@ -103,9 +49,12 @@ def post_sql(sql: str, take: int = 100, skip: int = 0) -> list:
     Returns:
         list: List of response from api
     """
-    url = urljoin(get_api_url(), "api/sql")
+
+    url = urljoin(get_connector().get_url(), "api/sql")
     response = requests.post(
-        url=url, json={"query": sql, "take": take, "skip": skip}, auth=get_auth()
+        url=url,
+        json={"query": sql, "take": take, "skip": skip},
+        headers={"Authorization": "Bearer " + get_connector().get_token()},
     )
     if response.status_code == 200:
         try:

{commonlib_reader-1.0.6 → commonlib_reader-1.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "commonlib-reader"
-version = "1.0.6"
+version = "1.0.8"
 description = "Reader for Equinor commonlib api."
 authors = [
 	{ name = "Åsmund Våge Fannemel", email = "asmf@equinor.com" }
@@ -8,12 +8,12 @@ authors = [
 readme = "README.md"
 license = { text = "MIT" }
 urls = {"Repository" = "https://github.com/equinor/commonlib-reader.git"}
-requires-python = ">=3.9.2,<4.0.0"
+requires-python = ">=3.10,<4.0.0"
 dependencies = [
-	"msal_bearer>=1.3.3,<2.0.0",
 	"pandas>=2.1.4",
 	"requests>=2.32.4",
-	"urllib3>=2.5.0" # Pinned to avoid security issues in some older versions
+	"urllib3>=2.5.0", # Pinned to avoid security issues in some older versions
+	"eq-api-connector (>=1.0.0,<2.0.0)"
 ]
 
 [tool.poetry.group.test.dependencies]