pyPreservica 2.2.1__tar.gz → 2.3.1__tar.gz

{pyPreservica-2.2.1 → pyPreservica-2.3.1}/PKG-INFO

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

{pyPreservica-2.2.1 → pyPreservica-2.3.1}/pyPreservica/__init__.py

@@ -23,6 +23,6 @@ from .authorityAPI import AuthorityAPI, Table
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the Preservica API package
-__version__ = "2.2.1"
+__version__ = "2.3.1"
 
 __license__ = "Apache License Version 2.0"

{pyPreservica-2.2.1 → pyPreservica-2.3.1}/pyPreservica/entityAPI.py

@@ -9,6 +9,7 @@ licence:    Apache License 2.0
 
 """
 import hashlib
+import os.path
 import uuid
 import xml.etree.ElementTree
 from datetime import datetime, timedelta, timezone
@@ -1694,6 +1695,34 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
+    def add_access_representation(self, entity: Entity, access_file: str, name: str = "Access"):
+        """
+        Add a new representation to an existing asset.
+
+        :param entity:          The existing asset which will receive the new representation
+        :param access_file:     The new digital file
+        :param name:            The name of the new access representation defaults to "Access"
+        :return:
+        """
+
+        if self.major_version < 7 and self.minor_version < 12:
+            raise RuntimeError("Add Representation API is only available when connected to a v6.12 System")
+
+        if isinstance(entity, Folder) or isinstance(entity, ContentObject):
+            raise RuntimeError("Add Representation cannot be added to Folders and Content Objects")
+
+        headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/octet-stream'}
+
+        filename = os.path.basename(access_file)
+
+        params = {'type': 'Access', 'name': name, 'filename': filename}
+
+        with open(access_file, 'rb') as fd:
+            request = self.session.post(
+                f'{self.protocol}://{self.server}/api/entity/{entity.path}/{entity.reference}/representations',
+                data=fd, headers=headers, params=params)
+
+
     def add_thumbnail(self, entity: Entity, image_file: str):
         """
          add a thumbnail icon to a folder or asset
@@ -1708,7 +1737,7 @@ class EntityAPI(AuthenticatedAPI):
         if isinstance(entity, ContentObject):
             raise RuntimeError("Thumbnails cannot be added to Content Objects")
 
-        headers = {HEADER_TOKEN: self.token,  'Content-Type': 'application/octet-stream'}
+        headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/octet-stream'}
 
         with open(image_file, 'rb') as fd:
             request = self.session.put(

{pyPreservica-2.2.1 → pyPreservica-2.3.1}/pyPreservica/uploadAPI.py

@@ -1662,9 +1662,9 @@ class UploadAPI(AuthenticatedAPI):
         """
         return self.upload_locations()
 
-    def crawl_filesystem(self, filesystem_path, bucket_name, preservica_parent, callback=None,
+    def crawl_filesystem(self, filesystem_path, bucket_name, preservica_parent, callback: bool = False,
                          security_tag: str = "open",
-                         delete_after_upload=True, max_MB_ingested: int = -1):
+                         delete_after_upload: bool = True, max_MB_ingested: int = -1):
 
         def get_parent(client, identifier, parent_reference):
             id = str(os.path.dirname(identifier))
@@ -1730,8 +1730,13 @@ class UploadAPI(AuthenticatedAPI):
                 full_path_list = [os.path.join(dirname, file) for file in files]
                 package = multi_asset_package(asset_file_list=full_path_list, parent_folder=f, SecurityTag=security_tag,
                                               Identifiers=identifiers)
+                if callback:
+                    progress_display = UploadProgressConsoleCallback(package)
+                else:
+                    progress_display = None
+
                 self.upload_zip_package_to_S3(path_to_zip_package=package, bucket_name=bucket_name,
-                                              callback=callback, delete_after_upload=delete_after_upload)
+                                              callback=progress_display, delete_after_upload=delete_after_upload)
                 logger.info(f"Uploaded " + "{:.1f}".format(bytes_ingested / (1024 * 1024)) + " MB")
 
                 if max_MB_ingested > 0:

{pyPreservica-2.2.1 → pyPreservica-2.3.1}/pyPreservica.egg-info/PKG-INFO

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

{pyPreservica-2.2.1 → pyPreservica-2.3.1}/setup.py

@@ -21,7 +21,7 @@ if sys.argv[-1] == 'publish':
 # This call to setup() does all the work
 setup(
     name=PKG,
-    version="2.2.1",
+    version="2.3.1",
     description="Python library for the Preservica API",
     long_description=README,
     long_description_content_type="text/markdown",