pyPreservica 3.1.1__py3-none-any.whl → 3.2.0__py3-none-any.whl

pyPreservica/__init__.py

@@ -30,10 +30,11 @@ from .monitorAPI import MonitorAPI, MonitorCategory, MonitorStatus, MessageStatu
 from .webHooksAPI import WebHooksAPI, TriggerType, WebHookHandler
 from .authorityAPI import AuthorityAPI, Table
 from .mdformsAPI import MetadataGroupsAPI, Group, GroupField, GroupFieldType
+from .settingsAPI import SettingsAPI
 
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the pyPreservica package
-__version__ = "3.1.1"
+__version__ = "3.2.0"
 
 __license__ = "Apache License Version 2.0"

pyPreservica/contentAPI.py

@@ -34,6 +34,11 @@ class Field:
 
 
 class ContentAPI(AuthenticatedAPI):
+    """
+        The ContentAPI class provides the search interface to the Preservica repository.
+
+    """
+
 
     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,

pyPreservica/entityAPI.py

@@ -933,6 +933,43 @@ class EntityAPI(AuthenticatedAPI):
                     raise exception
         return self.entity(entity.entity_type, entity.reference)
 
+    def add_metadata_as_fragment(self, entity: Entity, schema: str, xml_fragment: str) -> Entity:
+        """
+        Add a metadata fragment with a given namespace URI to an Entity
+
+        Don't parse the xml fragment which may add extra namespaces etc
+
+        Returns The updated Entity
+
+        :param xml_fragment:  The new XML as a string
+        :param entity: The Entity to update
+        :param schema: The schema URI of the XML document
+        """
+        headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/xml;charset=UTF-8'}
+
+        xml_doc = f"""<xip:MetadataContainer xmlns="{schema}" schemaUri="{schema}" xmlns:xip="{self.xip_ns}">
+            <xip:Entity>{entity.reference}</xip:Entity>
+                <xip:Content>
+                   {xml_fragment}
+                </xip:Content>
+            </xip:MetadataContainer>"""
+
+        end_point = f"/{entity.path}/{entity.reference}/metadata"
+        logger.debug(xml_doc)
+        request = self.session.post(f'{self.protocol}://{self.server}/api/entity{end_point}', data=xml_doc,
+                                    headers=headers)
+        if request.status_code == requests.codes.ok:
+            return self.entity(entity_type=entity.entity_type, reference=entity.reference)
+        elif request.status_code == requests.codes.unauthorized:
+            self.token = self.__token__()
+            return self.add_metadata(entity, schema, xml_fragment)
+        else:
+            exception = HTTPException(entity.reference, request.status_code, request.url, "add_metadata",
+                                      request.content.decode('utf-8'))
+            logger.error(exception)
+            raise exception
+
+
     def add_metadata(self, entity: Entity, schema: str, data) -> Entity:
         """
         Add a metadata fragment with a given namespace URI
@@ -960,6 +997,7 @@ class EntityAPI(AuthenticatedAPI):
         xml_request = xml.etree.ElementTree.tostring(xml_object, encoding='utf-8')
         end_point = f"/{entity.path}/{entity.reference}/metadata"
         logger.debug(xml_request)
+        print(xml_request)
         request = self.session.post(f'{self.protocol}://{self.server}/api/entity{end_point}', data=xml_request,
                                     headers=headers)
         if request.status_code == requests.codes.ok:

pyPreservica/settingsAPI.py

@@ -0,0 +1,295 @@
+"""
+pyPreservica Settings API  module definition
+
+API for retrieving information about configuration settings.
+
+author:     James Carr
+licence:    Apache License 2.0
+
+"""
+
+from typing import Callable
+
+from pyPreservica.common import *
+
+logger = logging.getLogger(__name__)
+
+
+class SettingsAPI(AuthenticatedAPI):
+    """
+    API for retrieving information about configuration settings.
+
+    Includes  methods for:
+
+    *  metadata-enrichment
+
+    """
+
+    def __init__(
+        self,
+        username=None,
+        password=None,
+        tenant=None,
+        server=None,
+        use_shared_secret=False,
+        two_fa_secret_key: str = None,
+        protocol: str = "https",
+        request_hook: Callable = None,
+        credentials_path: str = "credentials.properties",
+    ):
+        super().__init__(
+            username,
+            password,
+            tenant,
+            server,
+            use_shared_secret,
+            two_fa_secret_key,
+            protocol,
+            request_hook,
+            credentials_path,
+        )
+
+        if self.major_version < 7 and self.minor_version < 7:
+            raise RuntimeError(
+                "Settings API is only available when connected to a v7.7 System or higher"
+            )
+
+        self.base_url = "api/settings"
+
+    def metadata_enrichment_rules(self, profile_id: str = None) -> dict:
+        """
+        Returns a list of metadata enrichment rules.
+        An empty selection implies that the rule is applied to all content.
+        Rules define where particular behaviours, defined by profiles, will be applied.
+        Rules are evaluated in order, with the first matching rule being applied.
+
+        :param profile_id: The rules for a specific profile id, Set to None for all rules
+        :type profile_id: str
+
+        """
+        headers = {
+            HEADER_TOKEN: self.token,
+            "Accept": "application/json",
+            "Content-Type": "application/json;charset=UTF-8",
+        }
+
+        endpoint: str = "/metadata-enrichment/config/rules"
+
+        request = self.session.get(
+            f"{self.protocol}://{self.server}/{self.base_url}{endpoint}",
+            headers=headers)
+
+        if request.status_code == requests.codes.ok:
+            rules: dict = json.loads(request.content.decode("utf-8"))
+            if profile_id is None:
+                return rules
+            else:
+                profile_rules = []
+                for rule in rules["rules"]:
+                    if rule["profileId"] == profile_id:
+                        profile_rules.append(rule)
+                return {"rules": profile_rules}
+        else:
+            logger.debug(request.content.decode("utf-8"))
+            raise RuntimeError(request.status_code, f"metadata_enrichment_rules failed")
+
+    def metadata_enrichment_delete_rule(self, rule_id: str):
+        """
+        Deletes a metadata enrichment rule.
+
+        :param rule_id: The rule id
+        :type rule_id: str
+
+        :return: No return value
+        :rtype: None
+
+        """
+        headers = {
+            HEADER_TOKEN: self.token,
+            "Accept": "application/json",
+            "Content-Type": "application/json;charset=UTF-8",
+        }
+
+        endpoint: str = f"/metadata-enrichment/config/rules/{rule_id}"
+
+        request = self.session.delete(
+            f"{self.protocol}://{self.server}/{self.base_url}{endpoint}", headers=headers)
+
+        if request.status_code == requests.codes.no_content:
+            return
+        else:
+            logger.debug(request.content.decode("utf-8"))
+            raise RuntimeError(request.status_code, f"metadata_enrichment_delete_rule failed")
+
+    def metadata_enrichment_add_rule(self, profile_id: str, priority: int = 1):
+        """
+        Create a metadata enrichment rule to control when metadata enrichment profiles are applied and return it.
+        Rules define where particular behaviours, defined by profiles, will be applied.
+        Rules are evaluated in order, with the first matching rule being applied.
+        Note that not specifying, or specifying an empty selection implies that the rule will be applied to all content.
+        Currently only securityDescriptorSelector, representationSelector and hierarchySelector are supported selectors.
+        If a rule already exists for the requested priority, existing rules will be shifted down priority to accommodate the new entry.
+
+        :param profile_id: The profile id
+        :type profile_id: str
+
+        :param priority: The rule priority
+        :type priority: int
+
+        :return: The metadata enrichment rule
+        :rtype: dict
+        """
+
+        headers = {
+            HEADER_TOKEN: self.token,
+            "Accept": "application/json",
+            "Content-Type": "application/json;charset=UTF-8",
+        }
+
+        endpoint: str = "/metadata-enrichment/config/rules"
+
+        rule: dict = {
+            "profileId": profile_id,
+            "priority": str(priority),
+            "selectorSettings": {},
+        }
+
+        request = self.session.post(
+            f"{self.protocol}://{self.server}/{self.base_url}/{endpoint}",
+            headers=headers,
+            json=rule,
+        )
+        if request.status_code == requests.codes.created:
+            return json.loads(request.content.decode("utf-8"))
+        else:
+            logger.debug(request.content.decode("utf-8"))
+            raise RuntimeError(
+                request.status_code, f"metadata_enrichment_add_rule failed"
+            )
+
+    def metadata_enrichment_add_profile(self, name: str, active: bool = True):
+        """
+        Create a metadata enrichment profile to control automatic metadata enrichment of content and return it.
+        Profiles define a set of behaviours that will be applied when the profile is selected by a rule.
+        A profile has no effect if it is not used by a rule. Includes settings for PII identification.
+        PII detection tools may be run against the full text extracted from content.
+
+
+        :param name: The profile name
+        :type name: str
+
+        :param active: The profile active status
+        :type active: bool
+
+        :return: The metadata enrichment profile
+        :rtype: dict
+
+        """
+
+        headers = {
+            HEADER_TOKEN: self.token,
+            "Accept": "application/json",
+            "Content-Type": "application/json;charset=UTF-8",
+        }
+
+        endpoint: str = "/metadata-enrichment/config/profiles"
+
+        profile: dict = {"name": name, "piiSettings": {"active": str(active).lower()}}
+
+        request = self.session.post(
+            f"{self.protocol}://{self.server}/{self.base_url}{endpoint}",
+            headers=headers, json=profile)
+
+        if request.status_code == requests.codes.created:
+            return json.loads(request.content.decode("utf-8"))
+        else:
+            logger.debug(request.content.decode("utf-8"))
+            raise RuntimeError(request.status_code, f"metadata_enrichment_add_profile failed")
+
+    def metadata_enrichment_profile(self, profile_id: str) -> dict:
+        """
+        Returns a single profile by its ID
+        Profiles define a set of behaviours that will be applied when the profile is selected by a rule.
+        A profile has no effect if it is not used by a rule. Includes settings for PII identification.
+        PII detection tools may be run against the full text extracted from content.
+
+        :param profile_id: The profile name
+        :type profile_id: str
+
+        :return: The metadata enrichment profile
+        :rtype: dict
+
+        """
+        headers = {
+            HEADER_TOKEN: self.token,
+            "Accept": "application/json",
+            "Content-Type": "application/json;charset=UTF-8",
+        }
+
+        endpoint: str = f"/metadata-enrichment/config/profiles/{profile_id}"
+
+        request = self.session.get(
+            f"{self.protocol}://{self.server}/{self.base_url}{endpoint}", headers=headers)
+
+        if request.status_code == requests.codes.ok:
+            return json.loads(request.content.decode("utf-8"))
+        else:
+            logger.debug(request.content.decode("utf-8"))
+            raise RuntimeError(request.status_code, f"metadata_enrichment_profile failed")
+
+    def metadata_enrichment_delete_profile(self, profile_id: str) -> None:
+        """
+        Deletes a metadata enrichment profile
+
+        :param profile_id: The profile name
+        :type profile_id: str
+
+        :return: No return value
+        :rtype: None
+
+        """
+        headers = {
+            HEADER_TOKEN: self.token,
+            "Accept": "application/json",
+            "Content-Type": "application/json;charset=UTF-8",
+        }
+
+        endpoint: str = f"/metadata-enrichment/config/profiles/{profile_id}"
+
+        request = self.session.delete(
+            f"{self.protocol}://{self.server}/{self.base_url}{endpoint}", headers=headers)
+
+        if request.status_code == requests.codes.forbidden:
+            logger.debug(request.content.decode("utf-8"))
+            raise RuntimeError(request.status_code, f"Can't delete a profile with rules assigned")
+
+        if request.status_code == requests.codes.no_content:
+            return
+        else:
+            logger.debug(request.content.decode("utf-8"))
+            raise RuntimeError(request.status_code, f"metadata_enrichment_delete_profile failed")
+
+    def metadata_enrichment_profiles(self) -> dict:
+        """
+        Returns the list of all metadata enrichment profiles.
+        Profiles define a set of behaviours that will be applied when the profile is selected by a rule.
+        A profile has no effect if it is not used by a rule. Includes settings for PII identification.
+        PII detection tools may be run against the full text extracted from content.
+        """
+
+        headers = {
+            HEADER_TOKEN: self.token,
+            "Accept": "application/json",
+            "Content-Type": "application/json;charset=UTF-8",
+        }
+
+        endpoint: str = "/metadata-enrichment/config/profiles"
+
+        request = self.session.get(
+            f"{self.protocol}://{self.server}/{self.base_url}{endpoint}", headers=headers)
+
+        if request.status_code == requests.codes.ok:
+            return json.loads(request.content.decode("utf-8"))
+        else:
+            logger.debug(request.content.decode("utf-8"))
+            raise RuntimeError(request.status_code, f"metadata_enrichment_profiles failed")

{pypreservica-3.1.1.dist-info → pypreservica-3.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyPreservica
-Version: 3.1.1
+Version: 3.2.0
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr

{pypreservica-3.1.1.dist-info → pypreservica-3.2.0.dist-info}/RECORD

@@ -1,19 +1,20 @@
-pyPreservica/__init__.py,sha256=A3EpVn5oHQJjia8sh7D3Pzk6GlNPgrlpRL0VnDZn1f8,1212
+pyPreservica/__init__.py,sha256=erL11_X3f9F3yfHhgtVxRdAH1m2LIOsYkTvReMS3em4,1250
 pyPreservica/adminAPI.py,sha256=aMN2twcUZOFoGx2yapC6GVtBTdYHUJFA-5bdWVkCwS8,37773
 pyPreservica/authorityAPI.py,sha256=jpf_m9i-IakyNVooi2yELuKt4yhX73hWqQNbPRHZx2g,9206
 pyPreservica/common.py,sha256=iEeF4Kg51d4Vug-Dv8TeqS1lP2zcfM7YtBO8oANEcCU,38273
-pyPreservica/contentAPI.py,sha256=nOj7WciYARhLQWW65215Ghwz3CG61AVvikETPdtN4r0,22174
-pyPreservica/entityAPI.py,sha256=p0u2OoLWOg1UxGq7ZRU__bz99FS5_nXW7wENufMgKNI,123919
+pyPreservica/contentAPI.py,sha256=ZvX2aGQEaksmw-m-oEUI6daVSqFe_IcE1cGwCNbSCDQ,22286
+pyPreservica/entityAPI.py,sha256=cIuipvOlFUNgaLBOXtevTYQrT0zh1NG2y5gXz5sr_k0,125673
 pyPreservica/mdformsAPI.py,sha256=_hBjT4-OzgLQGDfYX7b_01P27wc-RmsCEu57VtyAdh8,19173
 pyPreservica/monitorAPI.py,sha256=LJOUrynBOWKlNiYpZ1iH8qB1oIIuKX1Ms1SRBcuXohA,6274
 pyPreservica/opex.py,sha256=ccra1S4ojUXS3PlbU8WfxajOkJrwG4OykBnNrYP_jus,4875
 pyPreservica/parAPI.py,sha256=f0ZUxLd0U-BW6kBx5K7W2Pv7NjG3MkTNydmxQ3U1ZVE,9296
 pyPreservica/retentionAPI.py,sha256=QUTCbN4P3IpqmrebU_wd3n5ZVcyxVLTFAli8Y_GxOW4,24843
+pyPreservica/settingsAPI.py,sha256=jXnMOCq3mimta6E-Os3J1I1if2pYsjLpOazAx8L-ZQI,10721
 pyPreservica/uploadAPI.py,sha256=uX67mW-2q7FmjtXQ759GwHPL6Zs7R-iE8-86PBApvbY,99823
 pyPreservica/webHooksAPI.py,sha256=B3C6PV_3JLlJrr9PtsTzL-21M0msx8Mnj18Xb3Bv4RE,6814
 pyPreservica/workflowAPI.py,sha256=OcOiiUdrQerbPllrkj1lWpmuW0jTuyyV0urwPSYcd_U,17561
-pypreservica-3.1.1.dist-info/licenses/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pypreservica-3.1.1.dist-info/METADATA,sha256=fWV7Yk9RUUDKhAGYJnkpf27fjbzwqFjqYN4NdB5-ZWI,3009
-pypreservica-3.1.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-pypreservica-3.1.1.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
-pypreservica-3.1.1.dist-info/RECORD,,
+pypreservica-3.2.0.dist-info/licenses/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pypreservica-3.2.0.dist-info/METADATA,sha256=x3FR1zZKihN0pfSN_JdvM10pfP_IsfY1GWV8t3Yd_bo,3009
+pypreservica-3.2.0.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+pypreservica-3.2.0.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
+pypreservica-3.2.0.dist-info/RECORD,,

{pypreservica-3.1.1.dist-info → pypreservica-3.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any