pyPreservica 3.0.1__tar.gz → 3.0.5__tar.gz

{pypreservica-3.0.1 → pypreservica-3.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pyPreservica
-Version: 3.0.1
+Version: 3.0.5
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -24,12 +24,23 @@ License-File: LICENSE.txt
 Requires-Dist: requests
 Requires-Dist: urllib3
 Requires-Dist: certifi
-Requires-Dist: boto3
+Requires-Dist: boto3<1.36.0
 Requires-Dist: botocore
 Requires-Dist: s3transfer
 Requires-Dist: azure-storage-blob
 Requires-Dist: tqdm
 Requires-Dist: pyotp
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
 
 
 # pyPreservica

{pypreservica-3.0.1 → pypreservica-3.0.5}/pyPreservica/__init__.py

@@ -23,6 +23,6 @@ from .mdformsAPI import MetadataGroupsAPI, Group, GroupField, GroupFieldType
 __author__ = "James Carr (drjamescarr@gmail.com)"
 
 # Version of the pyPreservica package
-__version__ = "3.0.1"
+__version__ = "3.0.5"
 
 __license__ = "Apache License Version 2.0"

{pypreservica-3.0.1 → pypreservica-3.0.5}/pyPreservica/common.py

@@ -405,6 +405,9 @@ class Bitstream:
         self.length = int(length)
         self.fixity = fixity
         self.content_url = content_url
+        self.bs_index = None
+        self.gen_index = None
+        self.co_ref = None
 
     def __str__(self):
         return f"""

{pypreservica-3.0.1 → pypreservica-3.0.5}/pyPreservica/entityAPI.py

@@ -8,7 +8,7 @@ author:     James Carr
 licence:    Apache License 2.0
 
 """
-import hashlib
+
 import os.path
 import uuid
 import xml.etree.ElementTree
@@ -118,6 +118,38 @@ class EntityAPI(AuthenticatedAPI):
                 logger.error(exception)
                 raise exception
 
+    def bitstream_location(self, bitstream: Bitstream):
+        """"
+        Retrieves information about a bitstreams storage locations
+        """
+        if not isinstance(bitstream, Bitstream):
+            logger.error("bitstream argument is not a Bitstream object")
+            raise RuntimeError("bitstream argument is not a Bitstream object")
+
+        storage_locations = []
+
+        url: str = f'{self.protocol}://{self.server}/api/entity/content-objects/{bitstream.co_ref}/generations/{bitstream.gen_index}/bitstreams/{bitstream.bs_index}/storage-locations'
+
+        with self.session.get(url, headers={HEADER_TOKEN: self.token}, stream=True) as request:
+            if request.status_code == requests.codes.unauthorized:
+                self.token = self.__token__()
+                return self.bitstream_location(bitstream)
+            elif request.status_code == requests.codes.ok:
+                xml_response = str(request.content.decode('utf-8'))
+                entity_response = xml.etree.ElementTree.fromstring(xml_response)
+                logger.debug(xml_response)
+                locations = entity_response.find(f'.//{{{self.entity_ns}}}StorageLocation')
+                for adapter in locations:
+                    storage_locations.append(adapter.attrib['name'])
+            else:
+                exception = HTTPException(bitstream.filename, request.status_code, request.url, "bitstream_location",
+                                          request.content.decode('utf-8'))
+                logger.error(exception)
+                raise exception
+
+        return storage_locations
+
+
     def bitstream_content(self, bitstream: Bitstream, filename: str, chunk_size: int = CHUNK_SIZE) -> Union[int, None]:
         """
         Download a file represented as a Bitstream to a local filename
@@ -1474,7 +1506,7 @@ class EntityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-    def generation(self, url: str) -> Generation:
+    def generation(self, url: str, content_ref: str = None) -> Generation:
         """
          Retrieve a list of generation objects
 
@@ -1524,7 +1556,11 @@ class EntityAPI(AuthenticatedAPI):
             bitstreams = entity_response.findall(f'./{{{self.entity_ns}}}Bitstreams/{{{self.entity_ns}}}Bitstream')
             bitstream_list = []
             for bit in bitstreams:
-                bitstream_list.append(self.bitstream(bit.text))
+                bs: Bitstream = self.bitstream(bit.text)
+                bs.gen_index = index
+                if content_ref is not None:
+                    bs.co_ref = content_ref
+                bitstream_list.append(bs)
             generation = Generation(strtobool(ge.attrib['original']), strtobool(ge.attrib['active']),
                                     format_group.text if hasattr(format_group, 'text') else None,
                                     effective_date.text if hasattr(effective_date, 'text') else None,
@@ -1741,7 +1777,7 @@ class EntityAPI(AuthenticatedAPI):
             result = []
             for g in generations:
                 if hasattr(g, 'text'):
-                    generation = self.generation(g.text)
+                    generation = self.generation(g.text, content_object.reference)
                     generation.asset = content_object.asset
                     generation.content_object = content_object
                     generation.representation_type = content_object.representation_type

{pypreservica-3.0.1 → pypreservica-3.0.5}/pyPreservica/uploadAPI.py

@@ -1661,30 +1661,52 @@ class UploadAPI(AuthenticatedAPI):
                          security_tag: str = "open",
                          delete_after_upload: bool = True, max_MB_ingested: int = -1):
 
+        from pyPreservica import EntityAPI
+
+        def entity_value(client: EntityAPI, identifier: str) -> Entity:
+            back_off: int = 5
+            while True:
+                try:
+                    entities = client.identifier("code", identifier)
+                    if bool(len(entities) > 0):
+                        return entities.pop()
+                    else:
+                        return None
+                except HTTPException as e:
+                    sleep(back_off)
+                    back_off = back_off * 2
+
+        def entity_exists(client: EntityAPI, identifier: str) -> bool:
+            back_off: int = 5
+            while True:
+                try:
+                    entities = client.identifier("code", identifier)
+                    return bool(len(entities) > 0)
+                except HTTPException as e:
+                    sleep(back_off)
+                    back_off = back_off * 2
+
         def get_parent(client, identifier, parent_reference):
-            id = str(os.path.dirname(identifier))
-            if not id:
-                id = identifier
-            entities = client.identifier("code", id)
-            if len(entities) > 0:
-                folder = entities.pop()
+            dirname_id: str = str(os.path.dirname(identifier))
+            if not dirname_id:
+                dirname_id = identifier
+            folder = entity_value(client, dirname_id)
+            if folder is not None:
                 folder = client.folder(folder.reference)
                 return folder.reference
             else:
                 return parent_reference
 
         def get_folder(client, name, tag, parent_reference, identifier):
-            entities = client.identifier("code", identifier)
-            if len(entities) == 0:
+            folder = entity_value(client, identifier)
+            if folder is None:
                 logger.info(f"Creating new folder with name {name}")
                 folder = client.create_folder(name, name, tag, parent_reference)
                 client.add_identifier(folder, "code", identifier)
             else:
                 logger.info(f"Found existing folder with name {name}")
-                folder = entities.pop()
             return folder
 
-        from pyPreservica import EntityAPI
         entity_client = EntityAPI(username=self.username, password=self.password, server=self.server,
                                   tenant=self.tenant,
                                   two_fa_secret_key=self.two_fa_secret_key, use_shared_secret=self.shared_secret,
@@ -1714,7 +1736,7 @@ class UploadAPI(AuthenticatedAPI):
                     files.remove(file)
                     continue
                 asset_code = os.path.join(code, file)
-                if len(entity_client.identifier("code", asset_code)) == 0:
+                if not entity_exists(entity_client, asset_code):
                     bytes_ingested = bytes_ingested + os.stat(full_path).st_size
                     logger.info(f"Adding new file: {file} to package ready for upload")
                     file_identifiers = {"code": asset_code}
@@ -1737,8 +1759,8 @@ class UploadAPI(AuthenticatedAPI):
                                             delete_after_upload=delete_after_upload)
                 else:
                     self.upload_zip_to_Source(path_to_zip_package=package, container_name=bucket_name,
-                                                  show_progress= bool(progress_display is not None),
-                                                  delete_after_upload=delete_after_upload)
+                                              show_progress=bool(progress_display is not None),
+                                              delete_after_upload=delete_after_upload)
 
                 logger.info(f"Uploaded " + "{:.1f}".format(bytes_ingested / (1024 * 1024)) + " MB")
 

{pypreservica-3.0.1 → pypreservica-3.0.5}/pyPreservica.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pyPreservica
-Version: 3.0.1
+Version: 3.0.5
 Summary: Python library for the Preservica API
 Home-page: https://pypreservica.readthedocs.io/
 Author: James Carr
@@ -24,12 +24,23 @@ License-File: LICENSE.txt
 Requires-Dist: requests
 Requires-Dist: urllib3
 Requires-Dist: certifi
-Requires-Dist: boto3
+Requires-Dist: boto3<1.36.0
 Requires-Dist: botocore
 Requires-Dist: s3transfer
 Requires-Dist: azure-storage-blob
 Requires-Dist: tqdm
 Requires-Dist: pyotp
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
 
 
 # pyPreservica

{pypreservica-3.0.1 → pypreservica-3.0.5}/pyPreservica.egg-info/requires.txt

@@ -1,7 +1,7 @@
 requests
 urllib3
 certifi
-boto3
+boto3<1.36.0
 botocore
 s3transfer
 azure-storage-blob

{pypreservica-3.0.1 → pypreservica-3.0.5}/setup.py

@@ -13,7 +13,7 @@ PKG = "pyPreservica"
 
 # 'setup.py publish' shortcut.
 if sys.argv[-1] == 'publish':
-    os.system('python setup.py sdist bdist_wheel')
+    os.system('python -m build')
     os.system('twine upload dist/*')
     sys.exit()
 
@@ -21,7 +21,7 @@ if sys.argv[-1] == 'publish':
 # This call to setup() does all the work
 setup(
     name=PKG,
-    version="3.0.1",
+    version="3.0.5",
     description="Python library for the Preservica API",
     long_description=README,
     long_description_content_type="text/markdown",
@@ -42,7 +42,7 @@ setup(
         "Topic :: System :: Archiving",
     ],
     keywords='Preservica API Preservation',
-    install_requires=["requests", "urllib3", "certifi", "boto3", "botocore", "s3transfer", "azure-storage-blob", "tqdm", "pyotp"],
+    install_requires=["requests", "urllib3", "certifi", "boto3 < 1.36.0", "botocore", "s3transfer", "azure-storage-blob", "tqdm", "pyotp"],
     project_urls={
         'Documentation': 'https://pypreservica.readthedocs.io',
         'Source': 'https://github.com/carj/pyPreservica',

{pypreservica-3.0.1 → pypreservica-3.0.5}/tests/test_bitstream.py

@@ -97,3 +97,11 @@ def test_get_bitstream_content(setup_data):
     assert os.path.isfile(bitstream.filename) is True
     assert Path(bitstream.filename).stat().st_size == 1942466
     os.remove(bitstream.filename)
+
+
+def test_get_bitstream_locations(setup_data):
+    client = EntityAPI()
+    asset = client.asset(ASSET_ID)
+    for bs  in client.bitstreams_for_asset(asset):
+        locations = client.bitstream_location(bs)
+        assert "Primary Adapter" in locations

{pypreservica-3.0.1 → pypreservica-3.0.5}/tests/test_users.py

@@ -1,7 +1,35 @@
+import pytest
 from pyPreservica import *
 
 
-def test_get_all_users():
+def setup():
+    client = AdminAPI()
+    users = client.all_users()
+    for u in users:
+        if u  ==  "pypreservica@gmail.com":
+            client.delete_user(u)
+
+
+
+def tear_down():
+    pass
+
+
+@pytest.fixture
+def setup_data():
+    print("\nSetting up resources...")
+
+    setup()
+
+    yield
+
+    print("\nTearing down resources...")
+
+    tear_down()
+
+
+
+def test_get_all_users(setup_data):
     client = AdminAPI()
     users = client.all_users()
     assert type(users) is list
@@ -10,7 +38,7 @@ def test_get_all_users():
     assert client.username in users
 
 
-def test_get_user():
+def test_get_user(setup_data):
     client = AdminAPI()
     user = client.user_details(client.username)
     assert type(user) is dict
@@ -19,7 +47,7 @@ def test_get_user():
     assert 'SDB_MANAGER_USER' in user['Roles']
 
 
-def test_add_user():
+def test_add_user(setup_data):
     client = AdminAPI()
     user = client.add_user("pypreservica@gmail.com", "pypreservica", ['SDB_MANAGER_USER', 'SDB_INGEST_USER'])
     assert user['UserName'] == "pypreservica@gmail.com"
@@ -30,7 +58,7 @@ def test_add_user():
     assert "pypreservica@gmail.com" not in client.all_users()
 
 
-def test_change_display_name():
+def test_change_display_name(setup_data):
     client = AdminAPI()
     user = client.add_user("pypreservica@gmail.com", "pypreservica", ['SDB_MANAGER_USER', 'SDB_INGEST_USER'])
     assert user['UserName'] == "pypreservica@gmail.com"