pyPreservica 2.7.2__tar.gz → 2.7.4__tar.gz

{pyPreservica-2.7.2 → pypreservica-2.7.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyPreservica
-Version: 2.7.2
+Version: 2.7.4
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -20,6 +20,15 @@ Classifier: Operating System :: OS Independent
 Classifier: Topic :: System :: Archiving
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
+Requires-Dist: requests
+Requires-Dist: urllib3
+Requires-Dist: certifi
+Requires-Dist: boto3
+Requires-Dist: botocore
+Requires-Dist: s3transfer
+Requires-Dist: azure-storage-blob
+Requires-Dist: tqdm
+Requires-Dist: pyotp
 
 
 # pyPreservica

{pyPreservica-2.7.2 → pypreservica-2.7.4}/pyPreservica/__init__.py

@@ -23,6 +23,6 @@ from .mdformsAPI import MDFormsAPI
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the pyPreservica package
-__version__ = "2.7.2"
+__version__ = "2.7.4"
 
 __license__ = "Apache License Version 2.0"

{pyPreservica-2.7.2 → pypreservica-2.7.4}/pyPreservica/common.py

@@ -477,10 +477,10 @@ class Entity:
     def __repr__(self):
         return self.__str__()
 
-    def has_metadata(self):
+    def has_metadata(self) -> bool:
         return bool(self.metadata)
 
-    def metadata_namespaces(self):
+    def metadata_namespaces(self) -> list:
         return list(self.metadata.values())
 
 
@@ -714,11 +714,33 @@ class AuthenticatedAPI:
 
         return entity_dict
 
+    def edition(self) -> str:
+        """
+        Return the edition of this tenancy
+        """
+        if self.major_version < 8 and self.minor_version < 3:
+            raise RuntimeError("Entitlement  API is only available when connected to a v7.3 System")
+
+        headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/json'}
+
+        response = self.session.get(f'{self.protocol}://{self.server}/api/entitlement/edition', headers=headers)
+
+        if response.status_code == requests.codes.ok:
+            return response.json()['edition']
+        elif response.status_code == requests.codes.unauthorized:
+            self.token = self.__token__()
+            return self.edition()
+        else:
+            exception = HTTPException("", response.status_code, response.url,
+                                      "edition", response.content.decode('utf-8'))
+            logger.error(exception)
+            raise exception
+
     def __version_namespace__(self):
         """
         Generate version specific namespaces from the server version
         """
-        if self.major_version == 7:
+        if self.major_version > 6:
             self.xip_ns = f"{NS_XIP_ROOT}v{self.major_version}.{self.minor_version}"
             self.entity_ns = f"{NS_ENTITY_ROOT}v{self.major_version}.{self.minor_version}"
             self.rm_ns = f"{NS_RM_ROOT}v{6}.{2}"
@@ -857,12 +879,16 @@ class AuthenticatedAPI:
                 raise RuntimeError(response.status_code, msg)
 
     def __init__(self, username: str = None, password: str = None, tenant: str = None, server: str = None,
-                 use_shared_secret: bool = False, two_fa_secret_key: str = None, protocol: str = "https"):
+                 use_shared_secret: bool = False, two_fa_secret_key: str = None,
+                 protocol: str = "https", request_hook=None):
 
         config = configparser.ConfigParser(interpolation=configparser.Interpolation())
         config.read('credentials.properties', encoding='utf-8')
         self.session: Session = requests.Session()
 
+        if request_hook is not None:
+            self.session.hooks['response'].append(request_hook)
+
         retries = Retry(
             total=3,
             backoff_factor=0.1,

{pyPreservica-2.7.2 → pypreservica-2.7.4}/pyPreservica/contentAPI.py

@@ -10,7 +10,7 @@ licence:    Apache License 2.0
 """
 
 import csv
-from typing import Generator
+from typing import Generator, Callable
 from pyPreservica.common import *
 
 logger = logging.getLogger(__name__)
@@ -19,8 +19,10 @@ logger = logging.getLogger(__name__)
 class ContentAPI(AuthenticatedAPI):
 
     def __init__(self, username=None, password=None, tenant=None, server=None, use_shared_secret=False,
-                 two_fa_secret_key: str = None, protocol: str = "https"):
-        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key, protocol)
+                 two_fa_secret_key: str = None, protocol: str = "https", request_hook: Callable = None):
+
+        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key,
+                         protocol, request_hook)
         self.callback = None
 
     class SearchResult:
@@ -130,7 +132,8 @@ class ContentAPI(AuthenticatedAPI):
             logger.error(f"indexed_fields failed with error code: {results.status_code}")
             raise RuntimeError(results.status_code, f"indexed_fields failed with error code: {results.status_code}")
 
-    def simple_search_csv(self, query: str = "%", page_size: int = 50, csv_file="search.csv", list_indexes: list = None):
+    def simple_search_csv(self, query: str = "%", page_size: int = 50, csv_file="search.csv",
+                          list_indexes: list = None):
         if list_indexes is None or len(list_indexes) == 0:
             metadata_fields = ["xip.reference", "xip.title", "xip.description", "xip.document_type",
                                "xip.parent_ref", "xip.security_descriptor"]
@@ -193,7 +196,8 @@ class ContentAPI(AuthenticatedAPI):
             logger.error(f"search failed with error code: {results.status_code}")
             raise RuntimeError(results.status_code, f"simple_search failed with error code: {results.status_code}")
 
-    def search_index_filter_csv(self, query: str = "%", csv_file="search.csv", page_size: int = 50, filter_values: dict = None,
+    def search_index_filter_csv(self, query: str = "%", csv_file="search.csv", page_size: int = 50,
+                                filter_values: dict = None,
                                 sort_values: dict = None):
         if filter_values is None:
             filter_values = {}

{pyPreservica-2.7.2 → pypreservica-2.7.4}/pyPreservica/entityAPI.py

@@ -15,7 +15,7 @@ import xml.etree.ElementTree
 from datetime import datetime, timedelta, timezone
 from io import BytesIO
 from time import sleep
-from typing import Any, Generator, Tuple, Iterable, Union
+from typing import Any, Generator, Tuple, Iterable, Union, Callable
 
 from pyPreservica.common import *
 
@@ -34,8 +34,12 @@ class EntityAPI(AuthenticatedAPI):
     """
 
     def __init__(self, username: str = None, password: str = None, tenant: str = None, server: str = None,
-                 use_shared_secret: bool = False, two_fa_secret_key: str = None, protocol: str = "https"):
-        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key, protocol)
+                 use_shared_secret: bool = False, two_fa_secret_key: str = None,
+                 protocol: str = "https", request_hook: Callable = None):
+
+        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key,
+                         protocol, request_hook)
+
         xml.etree.ElementTree.register_namespace("oai_dc", "http://www.openarchives.org/OAI/2.0/oai_dc/")
         xml.etree.ElementTree.register_namespace("ead", "urn:isbn:1-931666-22-9")
 

{pyPreservica-2.7.2 → pypreservica-2.7.4}/pyPreservica/mdformsAPI.py

@@ -10,14 +10,19 @@ licence:    Apache License 2.0
 """
 import json
 import xml.etree.ElementTree
+from typing import Callable
 
 from pyPreservica.common import *
 
 
 class MDFormsAPI(AuthenticatedAPI):
     def __init__(self, username: str = None, password: str = None, tenant: str = None, server: str = None,
-                 use_shared_secret: bool = False, two_fa_secret_key: str = None, protocol: str = "https"):
-        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key, protocol)
+                 use_shared_secret: bool = False, two_fa_secret_key: str = None,
+                 protocol: str = "https", request_hook: Callable = None):
+
+        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key,
+                         protocol, request_hook)
+
         xml.etree.ElementTree.register_namespace("oai_dc", "http://www.openarchives.org/OAI/2.0/oai_dc/")
         xml.etree.ElementTree.register_namespace("ead", "urn:isbn:1-931666-22-9")
 

{pyPreservica-2.7.2 → pypreservica-2.7.4}/pyPreservica/retentionAPI.py

@@ -11,7 +11,7 @@ licence:    Apache License 2.0
 
 
 import xml.etree.ElementTree
-from typing import Set
+from typing import Set, Callable
 
 from pyPreservica.common import *
 
@@ -59,8 +59,10 @@ class RetentionPolicy:
 class RetentionAPI(AuthenticatedAPI):
 
     def __init__(self, username=None, password=None, tenant=None, server=None, use_shared_secret=False,
-                 two_fa_secret_key: str = None, protocol: str = "https"):
-        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key, protocol)
+                 two_fa_secret_key: str = None, protocol: str = "https", request_hook: Callable = None):
+
+        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key,
+                         protocol, request_hook)
         if self.major_version < 7 and self.minor_version < 2:
             raise RuntimeError("Retention API is only available when connected to a v6.2 System")