pyPreservica 2.0.3__py3-none-any.whl → 3.3.3__py3-none-any.whl

pyPreservica/webHooksAPI.py

@@ -8,7 +8,6 @@ author:     James Carr
 licence:    Apache License 2.0
 
 """
-import json
 from http.server import BaseHTTPRequestHandler
 from urllib.parse import urlparse, parse_qs
 import hmac
@@ -73,6 +72,9 @@ class TriggerType(Enum):
     """
     MOVED = "MOVED"
     INDEXED = "FULL_TEXT_INDEXED"
+    SECURITY_CHANGED = "CHANGED_SECURITY_DESCRIPTOR"
+    INGEST_FAILED = "INGEST_FAILED"
+    CHANGE_ASSET_VISIBILITY  = "CHANGE_ASSET_VISIBILITY"
 
 
 class WebHooksAPI(AuthenticatedAPI):

pyPreservica/workflowAPI.py

@@ -11,7 +11,7 @@ licence:    Apache License 2.0
 
 import uuid
 import datetime
-from xml.dom import minidom
+from typing import Callable
 from xml.etree import ElementTree
 
 from pyPreservica.common import *
@@ -19,23 +19,10 @@ from pyPreservica.common import *
 logger = logging.getLogger(__name__)
 
 
-def prettify(elem):
-    """Return a pretty-printed XML string for the Element.
-    """
-    rough_string = ElementTree.tostring(elem, 'utf-8')
-    re_parsed = minidom.parseString(rough_string)
-    return re_parsed.toprettyxml(indent="  ")
-
-
 class WorkflowInstance:
     """
         Defines a workflow Instance.
-        The workflow Instance is context which has been executed
-
-
-        :param instance_id: The Workflow instance Id
-        :type instance_id: int
-
+        The workflow Instance is a context which has been executed
     """
 
     def __init__(self, instance_id: int):
@@ -62,14 +49,6 @@ class WorkflowContext:
     """
         Defines a workflow context.
         The workflow context is the pre-defined workflow which is ready to run
-
-
-        :param workflow_name: The Workflow context name
-        :type workflow_name: str
-
-        :param workflow_id: The Workflow context id
-        :type workflow_id: str
-
     """
 
     def __init__(self, workflow_id, workflow_name: str):
@@ -77,8 +56,10 @@ class WorkflowContext:
         self.workflow_name = workflow_name
 
     def __str__(self):
-        return f"Workflow ID:\t\t\t{self.workflow_id}\n" \
-               f"Workflow Name:\t\t\t{self.workflow_name}\n"
+        return f"""
+              Workflow ID:    {self.workflow_id}
+              Workflow Name:  {self.workflow_name}
+        """
 
     def __repr__(self):
         return self.__str__()
@@ -99,8 +80,11 @@ class WorkflowAPI(AuthenticatedAPI):
     workflow_types = ['Ingest', 'Access', 'Transformation', 'DataManagement']
 
     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, credentials_path: str = 'credentials.properties'):
+
+        super().__init__(username, password, tenant, server, use_shared_secret, two_fa_secret_key,
+                         protocol, request_hook, credentials_path)
         self.base_url = "sdb/rest/workflow"
 
     def get_workflow_contexts_by_type(self, workflow_type: str):
@@ -265,13 +249,13 @@ class WorkflowAPI(AuthenticatedAPI):
             assert instance_id == w_id
             workflow_instance = WorkflowInstance(int(instance_id))
             started_element = entity_response.find(f".//{{{NS_WORKFLOW}}}Started")
-            if started_element:
+            if started_element is not None:
                 if hasattr(started_element, "text"):
                     workflow_instance.started = datetime.datetime.strptime(started_element.text,
                                                                            '%Y-%m-%dT%H:%M:%S.%fZ')
 
             finished_element = entity_response.find(f".//{{{NS_WORKFLOW}}}Finished")
-            if finished_element:
+            if finished_element is not None:
                 if hasattr(finished_element, "text"):
                     workflow_instance.finished = datetime.datetime.strptime(finished_element.text,
                                                                             '%Y-%m-%dT%H:%M:%S.%fZ')
@@ -348,13 +332,13 @@ class WorkflowAPI(AuthenticatedAPI):
             creator = kwargs.get("creator")
             params["creator"] = creator
 
-        if "from" in kwargs:
-            from_date = kwargs.get("from")
-            params["from"] = from_date
+        if "from_date" in kwargs:
+            from_date = kwargs.get("from_date")
+            params["from"] = parse_date_to_iso(from_date)
 
-        if "to" in kwargs:
-            to_date = kwargs.get("to")
-            params["to"] = to_date
+        if "to_date" in kwargs:
+            to_date = kwargs.get("to_date")
+            params["to"] = parse_date_to_iso(to_date)
 
         params["start"] = int(start_value)
         params["max"] = int(maximum)
@@ -373,13 +357,13 @@ class WorkflowAPI(AuthenticatedAPI):
                 workflow_instance = WorkflowInstance(int(instance_id))
 
                 started_element = instance.find(f".//{{{NS_WORKFLOW}}}Started")
-                if started_element:
+                if started_element is not None:
                     if hasattr(started_element, "text"):
                         workflow_instance.started = datetime.datetime.strptime(started_element.text,
                                                                                '%Y-%m-%dT%H:%M:%S.%fZ')
 
                 finished_element = instance.find(f".//{{{NS_WORKFLOW}}}Finished")
-                if finished_element:
+                if finished_element is not None:
                     if hasattr(finished_element, "text"):
                         workflow_instance.finished = datetime.datetime.strptime(finished_element.text,
                                                                                 '%Y-%m-%dT%H:%M:%S.%fZ')

{pyPreservica-2.0.3.dist-info → pypreservica-3.3.3.dist-info}/METADATA

@@ -1,84 +1,93 @@
-Metadata-Version: 2.1
-Name: pyPreservica
-Version: 2.0.3
-Summary: Python library for the Preservica API
-Home-page: https://pypreservica.readthedocs.io/
-Author: James Carr
-Author-email: drjamescarr@gmail.com
-License: Apache License 2.0
-Project-URL: Documentation, https://pypreservica.readthedocs.io
-Project-URL: Source, https://github.com/carj/pyPreservica
-Project-URL: Discussion Forum, https://groups.google.com/g/pypreservica
-Keywords: Preservica API Preservation
-Platform: UNKNOWN
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: System :: Archiving
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: requests
-Requires-Dist: certifi
-Requires-Dist: boto3
-Requires-Dist: botocore
-Requires-Dist: s3transfer
-Requires-Dist: azure-storage-blob
-Requires-Dist: tqdm
-Requires-Dist: pyotp
-
-
-# pyPreservica
-
-
-<!---
-[![Downloads](https://pepy.tech/badge/pyPreservica/month)](https://pepy.tech/project/pyPreservica/month)
---->
-
-[![Supported Versions](https://img.shields.io/pypi/pyversions/pyPreservica.svg)](https://pypi.org/project/pyPreservica)
-[![CodeQL](https://github.com/carj/pyPreservica/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/carj/pyPreservica/actions/workflows/codeql-analysis.yml)
-
-Python language binding for the Preservica API
-
-https://preservica.com/
-
-This library provides a Python class for working with the Preservica Rest API
-
-https://developers.preservica.com/api-reference
-
-Wiki with example scripts https://github.com/carj/pyPreservica/wiki
-
-## Documentation
-
-The full documentation is available at: https://pypreservica.readthedocs.io/
-
-[![Documentation Status](https://readthedocs.org/projects/pypreservica/badge/?version=latest)](https://pypreservica.readthedocs.io/en/latest/?badge=latest)
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/carj/pyPreservica
-
-For announcements about new versions and discussion of pyPreservica please subscribe to the google groups
-forum https://groups.google.com/g/pypreservica
-
-## License
-
-The package is available as open source under the terms of the Apache License 2.0
-
-
-## Installation
-
-pyPreservica is available from the Python Package Index (PyPI)
-
-https://pypi.org/project/pyPreservica/
-
-To install pyPreservica, simply run this simple command in your terminal of choice:
-
-
-    $ pip install pyPreservica
-
-
-
+Metadata-Version: 2.4
+Name: pyPreservica
+Version: 3.3.3
+Summary: Python library for the Preservica API
+Home-page: https://pypreservica.readthedocs.io/
+Author: James Carr
+Author-email: drjamescarr@gmail.com
+License: Apache License 2.0
+Project-URL: Documentation, https://pypreservica.readthedocs.io
+Project-URL: Source, https://github.com/carj/pyPreservica
+Project-URL: Discussion Forum, https://groups.google.com/g/pypreservica
+Keywords: Preservica API Preservation
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+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>=1.38.0
+Requires-Dist: botocore>=1.38.0
+Requires-Dist: s3transfer
+Requires-Dist: azure-storage-blob
+Requires-Dist: tqdm
+Requires-Dist: pyotp
+Requires-Dist: python-dateutil
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
+
+
+# pyPreservica
+
+
+[![Supported Versions](https://img.shields.io/pypi/pyversions/pyPreservica.svg)](https://pypi.org/project/pyPreservica)
+[![CodeQL](https://github.com/carj/pyPreservica/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/carj/pyPreservica/actions/workflows/codeql-analysis.yml)
+![PyPI Downloads](https://static.pepy.tech/badge/pypreservica)
+
+Python language binding for the Preservica API
+
+https://preservica.com/
+
+This library provides a Python class for working with the Preservica Rest API
+
+https://developers.preservica.com/api-reference
+
+Wiki with example scripts https://github.com/carj/pyPreservica/wiki
+
+## Documentation
+
+The full documentation is available at: https://pypreservica.readthedocs.io/
+
+[![Documentation Status](https://readthedocs.org/projects/pypreservica/badge/?version=latest)](https://pypreservica.readthedocs.io/en/latest/?badge=latest)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/carj/pyPreservica
+
+For announcements about new versions and discussion of pyPreservica please subscribe to the google groups
+forum https://groups.google.com/g/pypreservica
+
+## License
+
+The package is available as open source under the terms of the Apache License 2.0
+
+
+## Installation
+
+pyPreservica is available from the Python Package Index (PyPI)
+
+https://pypi.org/project/pyPreservica/
+
+To install pyPreservica, simply run this simple command in your terminal of choice:
+
+
+    $ pip install pyPreservica
+

pypreservica-3.3.3.dist-info/RECORD

@@ -0,0 +1,20 @@
+pyPreservica/__init__.py,sha256=KIbmVi2I4p8xCxvtnzU-liKWrg0zJG-qOhw9YLFZORU,1250
+pyPreservica/adminAPI.py,sha256=_ZTb8T708loYn8UdFgZ4G5RTef9Hd2HHtjKnnrzBAtY,38041
+pyPreservica/authorityAPI.py,sha256=A52sFiAK4E4mlend_dknNIOW2BEwKXcLFI02anZBt3U,9211
+pyPreservica/common.py,sha256=TV4VgO4QI5YDdPYvm9ue1lxqSIf2E2j0_tQbFmwMf0U,39922
+pyPreservica/contentAPI.py,sha256=nnWImPoS7yt47yfohbtG1wWi1dNS_XdellWaPCE9iUk,25041
+pyPreservica/entityAPI.py,sha256=kyw03RnxKEveViQvdDy6MdscXOcAZxs9LC7hpKe3B3g,140235
+pyPreservica/mdformsAPI.py,sha256=A2YTT5uh6j1k_kg_33492cplwZc_jYv6zmiIt5Rvx6c,23259
+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=UVRFcLDH4s0Tik0vWmkQ6WkJX2h5Yk1MnJZX83HtcpQ,82084
+pyPreservica/webHooksAPI.py,sha256=KMObsdHp_0K0HjJUl5oaFh-vs21GCAQZo2ZTKkY38R8,6872
+pyPreservica/workflowAPI.py,sha256=bIoXNlr8uBQJ9Nkd1EdpN0uVt_UwtELa_YXpX1PEJh4,17619
+pypreservica-3.3.3.dist-info/licenses/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pypreservica-3.3.3.dist-info/METADATA,sha256=IwjGyIEvGOgcN3yzo9LIFd9jZirLt0r4lJtTIyhjaHA,3077
+pypreservica-3.3.3.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+pypreservica-3.3.3.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
+pypreservica-3.3.3.dist-info/RECORD,,

{pyPreservica-2.0.3.dist-info → pypreservica-3.3.3.dist-info}/WHEEL

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

pyPreservica/vocabularyAPI.py

@@ -1,141 +0,0 @@
-"""
-pyPreservica ControlledVocabularyAPI module definition
-
-A client library for the Preservica Repository web services Webhook API
-https://us.preservica.com/api/reference-metadata/documentation.html
-
-author:     James Carr
-licence:    Apache License 2.0
-
-"""
-
-from pyPreservica.common import *
-
-logger = logging.getLogger(__name__)
-
-BASE_ENDPOINT = '/api/reference-metadata'
-
-
-class Table:
-    def __init__(self, reference: str, name: str, security_tag: str, displayField: str, metadataConnections: list):
-        self.reference = reference
-        self.name = name
-        self.security_tag = security_tag
-        self.displayField = displayField
-        self.metadataConnections = metadataConnections
-        self.fields = None
-
-    def __str__(self):
-        return f"Ref:\t\t\t{self.reference}\n" \
-               f"Name:\t\t\t{self.name}\n" \
-               f"Security Tag:\t{self.security_tag}\n" \
-               f"Display Field:\t\t\t{self.displayField}\n" \
-               f"Metadata Connections:\t\t\t{self.metadataConnections}\n" \
-               f"Fields:\t\t\t{self.fields}\n"
-
-
-class ControlledVocabularyAPI(AuthenticatedAPI):
-
-
-    def load_skos(self, uri):
-        """
-        Load a SKOS controlled vocabulary in skos RDF format
-
-        Simple Knowledge Organization System (SKOS)
-
-        :param uri:
-        :return:
-        """
-        pass
-
-    def record(self, reference: str):
-        """
-        Get individual record by its ref.
-        :param reference:
-        :return:
-        """
-        headers = {HEADER_TOKEN: self.token, 'accept': 'application/json;charset=UTF-8'}
-        response = self.session.get(f'{self.protocol}://{self.server}{BASE_ENDPOINT}/records/{reference}',
-                                    headers=headers)
-        if response.status_code == requests.codes.unauthorized:
-            self.token = self.__token__()
-            return self.record(reference)
-        if response.status_code == requests.codes.ok:
-            json_response = str(response.content.decode('utf-8'))
-            return json.loads(json_response)
-        else:
-            exception = HTTPException("", response.status_code, response.url, "record",
-                                      response.content.decode('utf-8'))
-            logger.error(exception)
-            raise exception
-
-    def records(self, table: Table):
-        """
-        Get all records from a table.
-        :return:
-        """
-        headers = {HEADER_TOKEN: self.token, 'accept': 'application/json;charset=UTF-8'}
-        response = self.session.get(f'{self.protocol}://{self.server}{BASE_ENDPOINT}/tables/{table.reference}/records',
-                                    headers=headers)
-        if response.status_code == requests.codes.unauthorized:
-            self.token = self.__token__()
-            return self.records(table)
-        if response.status_code == requests.codes.ok:
-            json_response = str(response.content.decode('utf-8'))
-            return json.loads(json_response)['records']
-        else:
-            exception = HTTPException("", response.status_code, response.url, "records",
-                                      response.content.decode('utf-8'))
-            logger.error(exception)
-            raise exception
-
-    def table(self, reference: str):
-        """
-        fetch a metadata table by id
-
-        :param reference:
-        :return:
-        """
-        headers = {HEADER_TOKEN: self.token, 'accept': 'application/json;charset=UTF-8'}
-        response = self.session.get(f'{self.protocol}://{self.server}{BASE_ENDPOINT}/tables/{reference}',
-                                    headers=headers)
-        if response.status_code == requests.codes.unauthorized:
-            self.token = self.__token__()
-            return self.table(reference)
-        if response.status_code == requests.codes.ok:
-            json_response = str(response.content.decode('utf-8'))
-            doc = json.loads(json_response)
-            table = Table(doc['ref'], doc['name'], doc['securityDescriptor'], doc['displayField'],
-                          doc['metadataConnections'])
-            table.fields = doc['fields']
-            return table
-        else:
-            exception = HTTPException("", response.status_code, response.url, "table",
-                                      response.content.decode('utf-8'))
-            logger.error(exception)
-            raise exception
-
-    def tables(self):
-        """
-        List reference metadata tables, optionally filtering by metadata connections.
-        :return:
-        """
-        headers = {HEADER_TOKEN: self.token, 'accept': 'application/json;charset=UTF-8'}
-        response = self.session.get(f'{self.protocol}://{self.server}{BASE_ENDPOINT}/tables', headers=headers)
-        if response.status_code == requests.codes.unauthorized:
-            self.token = self.__token__()
-            return self.tables()
-        if response.status_code == requests.codes.ok:
-            json_response = str(response.content.decode('utf-8'))
-            doc = json.loads(json_response)
-            results = set()
-            for table in doc['tables']:
-                t = Table(table['ref'], table['name'], table['securityDescriptor'], table['displayField'],
-                          table['metadataConnections'])
-                results.add(t)
-            return results
-        else:
-            exception = HTTPException("", response.status_code, response.url, "tables",
-                                      response.content.decode('utf-8'))
-            logger.error(exception)
-            raise exception

pyPreservica-2.0.3.dist-info/RECORD

@@ -1,19 +0,0 @@
-pyPreservica/__init__.py,sha256=wsWI-hy7FC_caKfcr3hzc95MwFXdCPZRYKnJ5sBKiUo,1084
-pyPreservica/adminAPI.py,sha256=ILO8ADLbtVPjNQcmh4pUw17A7Zl9wAIT7Cyh7Z7UXKc,37685
-pyPreservica/authorityAPI.py,sha256=XUuleBePg1-ji6SAGQi01etH8tbRX_tF4fuI-3sGzJQ,9142
-pyPreservica/common.py,sha256=TbAmmTaeEh87mYvKoQI0g9ckie2NIT6WE-i-DFXQa4k,34848
-pyPreservica/contentAPI.py,sha256=E-KkUStLpQREAlUMq_I-Bh3UgEWTpDv3Ki2pafu4vrY,16257
-pyPreservica/entityAPI.py,sha256=g1ikcd7nImCwABRO5Izn3MaF7paf83habWndlYhFAHY,105700
-pyPreservica/monitorAPI.py,sha256=Xto2uSiryfZlUMUCrH7it2B8xOPVSLgSVLodxZW45po,6258
-pyPreservica/opex.py,sha256=ccra1S4ojUXS3PlbU8WfxajOkJrwG4OykBnNrYP_jus,4875
-pyPreservica/parAPI.py,sha256=WdfDYKbrJFqDrRtRUu-f7sSh1R4t-3fcLsUO2APheks,10522
-pyPreservica/retentionAPI.py,sha256=Cx1ofz9V31a8c8utEfKYLlfQaHSaaqg_D4R3LUFBEx0,23612
-pyPreservica/uploadAPI.py,sha256=bPrM90Be0nDPMovz1U1cBLj0HUYj2OFvm1upOdUOhQw,92455
-pyPreservica/vocabularyAPI.py,sha256=jPl6KDZoBGqlY0oEYjTpZ9kNEPzchDW-gyp-HH-MSKk,5729
-pyPreservica/webHooksAPI.py,sha256=bhenk2nAlAZRauSET0AG9DZyKckJos2NENyl0LDN5Z4,6736
-pyPreservica/workflowAPI.py,sha256=QOMd4Nw69Vf8tJ7Px4gSLpug7VakAtNi-90UTgWSed0,17862
-pyPreservica-2.0.3.dist-info/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pyPreservica-2.0.3.dist-info/METADATA,sha256=YcCjCxt-wBC-6wSl9PD0qIVj0Ug25xVWS3WuFpgxOUE,2698
-pyPreservica-2.0.3.dist-info/WHEEL,sha256=ewwEueio1C2XeHTvT17n8dZUJgOvyCWCt0WVNLClP9o,92
-pyPreservica-2.0.3.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
-pyPreservica-2.0.3.dist-info/RECORD,,