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

pyPreservica/__init__.py

@@ -1,16 +1,27 @@
 """
-pyPreservica module definition
+pyPreservica package definition
 import API classes, for entity, content, upload, workflows & retention
 
 author:     James Carr
 licence:    Apache License 2.0
 
 """
+
 from .common import *
-from .contentAPI import ContentAPI
+from .contentAPI import ContentAPI, Field, SortOrder
 from .entityAPI import EntityAPI
-from .uploadAPI import UploadAPI, simple_asset_package, complex_asset_package, cvs_to_xsd, cvs_to_xml, \
-                    cvs_to_cmis_xslt, csv_to_search_xml, generic_asset_package, upload_config, multi_asset_package
+from .uploadAPI import (
+    UploadAPI,
+    simple_asset_package,
+    complex_asset_package,
+    cvs_to_xsd,
+    cvs_to_xml,
+    cvs_to_cmis_xslt,
+    csv_to_search_xml,
+    generic_asset_package,
+    upload_config,
+    multi_asset_package,
+)
 from .workflowAPI import WorkflowAPI, WorkflowContext, WorkflowInstance
 from .retentionAPI import RetentionAPI, RetentionAssignment, RetentionPolicy
 from .parAPI import PreservationActionRegistry
@@ -18,11 +29,12 @@ from .adminAPI import AdminAPI
 from .monitorAPI import MonitorAPI, MonitorCategory, MonitorStatus, MessageStatus
 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 Preservica API package
-__version__ = "2.0.3"
+# Version of the pyPreservica package
+__version__ = "3.3.3"
 
 __license__ = "Apache License Version 2.0"

pyPreservica/adminAPI.py

@@ -10,7 +10,7 @@ licence:    Apache License 2.0
 """
 import csv
 import xml.etree.ElementTree
-from typing import List, Any
+from typing import List, Any, Union
 
 from pyPreservica.common import *
 
@@ -36,7 +36,7 @@ class AdminAPI(AuthenticatedAPI):
         request = self.session.delete(f'{self.protocol}://{self.server}/api/admin/security/roles/{role_name}',
                                       headers=headers)
         if request.status_code == requests.codes.no_content:
-            return
+            return None
         elif request.status_code == requests.codes.unauthorized:
             self.token = self.__token__()
             return self.delete_system_role(role_name)
@@ -61,7 +61,7 @@ class AdminAPI(AuthenticatedAPI):
         request = self.session.delete(f'{self.protocol}://{self.server}/api/admin/security/tags/{tag_name}',
                                       headers=headers)
         if request.status_code == requests.codes.no_content:
-            return
+            return None
         elif request.status_code == requests.codes.unauthorized:
             self.token = self.__token__()
             return self.delete_security_tag(tag_name)
@@ -211,7 +211,7 @@ class AdminAPI(AuthenticatedAPI):
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/xml;charset=UTF-8'}
         request = self.session.delete(f'{self.protocol}://{self.server}/api/admin/users/{username}', headers=headers)
         if request.status_code == requests.codes.no_content:
-            return
+            return None
         elif request.status_code == requests.codes.unauthorized:
             self.token = self.__token__()
             return self.delete_user(username)
@@ -251,8 +251,9 @@ class AdminAPI(AuthenticatedAPI):
             xml.etree.ElementTree.SubElement(xml_roles, "Role").text = role
         xml_request = xml.etree.ElementTree.tostring(xml_object, encoding='utf-8')
         logger.debug(xml_request)
+        params = {"source": "UX2"}
         request = self.session.post(f'{self.protocol}://{self.server}/api/admin/users', data=xml_request,
-                                    headers=headers)
+                                    headers=headers, params=params)
         if request.status_code == requests.codes.created:
             return self.user_details(username)
         elif request.status_code == requests.codes.unauthorized:
@@ -373,16 +374,16 @@ class AdminAPI(AuthenticatedAPI):
         self._check_if_user_has_manager_role()
         return self._account_status_(username, "false", "disable_user")
 
-    # def enable_user(self, username):
-    #     """
-    #      Enable a Preservica User
-    #
-    #     :param username: email address of the preservica user
-    #     :type username: str
-    #
-    #     """
-    #     self.__check_if_user_has_manager_role()
-    #     return self.__account_status_(username, "true", "enable_user")
+    def enable_user(self, username):
+        """
+        Enable a Preservica User
+
+        :param username: email address of the preservica user
+        :type username: str
+
+        """
+        self._check_if_user_has_manager_role()
+        return self._account_status_(username, "true", "enable_user")
 
     def user_report(self, report_name="users.csv"):
         """
@@ -444,7 +445,7 @@ class AdminAPI(AuthenticatedAPI):
         :param xml_data: The xml schema as a UTF-8 string or a file like object
         :type xml_data: Any
 
-        :return: None
+        :return:
         :rtype: None
         """
 
@@ -463,7 +464,7 @@ class AdminAPI(AuthenticatedAPI):
                                     params=params,
                                     data=xml_data)
         if request.status_code == requests.codes.created:
-            return
+            return None
         elif request.status_code == requests.codes.unauthorized:
             self.token = self.__token__()
             return self.add_xml_schema(name, description, originalName, xml_data)
@@ -493,7 +494,7 @@ class AdminAPI(AuthenticatedAPI):
         :param document_type: The type of the XML document, defaults to descriptive metadata templates
         :type document_type: str
 
-        :return: None
+        :return:
         :rtype: None
 
         """
@@ -513,7 +514,7 @@ class AdminAPI(AuthenticatedAPI):
                                     params=params,
                                     data=xml_data)
         if request.status_code == requests.codes.created:
-            return
+            return None
         elif request.status_code == requests.codes.unauthorized:
             self.token = self.__token__()
             return self.add_xml_document(name, xml_data, document_type)
@@ -523,12 +524,12 @@ class AdminAPI(AuthenticatedAPI):
 
     def delete_xml_document(self, uri: str):
         """
-        Delete a XML document from Preservica
+        Delete an XML document from Preservica's XML document store
 
         :param uri: The URI of the xml document to delete
         :type uri: str
 
-        :return: None
+        :return:
         :rtype: None
 
         """
@@ -543,13 +544,14 @@ class AdminAPI(AuthenticatedAPI):
                     f"{self.protocol}://{self.server}/api/admin/documents/{document['ApiId']}",
                     headers=headers)
                 if request.status_code == requests.codes.no_content:
-                    return
+                    return None
                 elif request.status_code == requests.codes.unauthorized:
                     self.token = self.__token__()
                     return self.delete_xml_document(uri)
                 else:
                     logger.error(request.content.decode('utf-8'))
                     raise RuntimeError(request.status_code, "delete_xml_document failed")
+        return None
 
     def delete_xml_schema(self, uri: str):
         """
@@ -558,7 +560,7 @@ class AdminAPI(AuthenticatedAPI):
         :param uri: The URI of the xml schema to delete
         :type uri: str
 
-        :return: None
+        :return:
         :rtype: None
 
         """
@@ -572,17 +574,18 @@ class AdminAPI(AuthenticatedAPI):
                 request = self.session.delete(f"{self.protocol}://{self.server}/api/admin/schemas/{schema['ApiId']}",
                                               headers=headers)
                 if request.status_code == requests.codes.no_content:
-                    return
+                    return None
                 elif request.status_code == requests.codes.unauthorized:
                     self.token = self.__token__()
                     return self.delete_xml_schema(uri)
                 else:
                     logger.error(request.content.decode('utf-8'))
                     raise RuntimeError(request.status_code, "delete_xml_schema failed")
+        return None
 
-    def xml_schema(self, uri: str) -> str:
+    def xml_schema(self, uri: str) -> Union[str, None]:
         """
-         fetch the metadata schema XSD document as a string by its URI
+         Fetch the metadata schema XSD document as a string by its URI
 
         :param uri: The URI of the xml schema
         :type uri: str
@@ -607,8 +610,9 @@ class AdminAPI(AuthenticatedAPI):
                 else:
                     logger.error(request.content.decode('utf-8'))
                     raise RuntimeError(request.status_code, "xml_schema failed")
+        return None
 
-    def xml_document(self, uri: str) -> str:
+    def xml_document(self, uri: str) -> Union[str, None]:
         """
         fetch the metadata XML document as a string by its URI
 
@@ -634,6 +638,7 @@ class AdminAPI(AuthenticatedAPI):
                 else:
                     logger.error(request.content.decode('utf-8'))
                     raise RuntimeError(request.status_code, "xml_document failed")
+        return None
 
     def xml_documents(self) -> List:
         """
@@ -695,7 +700,10 @@ class AdminAPI(AuthenticatedAPI):
                 aip_id = schema.find(f'.//{{{self.admin_ns}}}ApiId')
                 schema_dict['SchemaUri'] = schema_uri.text
                 schema_dict['Name'] = name.text
-                schema_dict['Description'] = description.text
+                if description is not None:
+                    schema_dict['Description'] = description.text
+                else:
+                    schema_dict['Description'] = ""
                 schema_dict['ApiId'] = aip_id.text
                 results.append(schema_dict)
             return results
@@ -751,7 +759,7 @@ class AdminAPI(AuthenticatedAPI):
             logger.error(request.content.decode('utf-8'))
             raise RuntimeError(request.status_code, "xml_transforms failed")
 
-    def xml_transform(self, input_uri: str, output_uri: str) -> str:
+    def xml_transform(self, input_uri: str, output_uri: str) -> Union[str, None]:
         """
         fetch the XML transform as a string by its URIs
 
@@ -779,6 +787,7 @@ class AdminAPI(AuthenticatedAPI):
                 else:
                     logger.error(request.content.decode('utf-8'))
                     raise RuntimeError(request.status_code, "xml_transform failed")
+        return None
 
     def delete_xml_transform(self, input_uri: str, output_uri: str):
         """
@@ -790,7 +799,7 @@ class AdminAPI(AuthenticatedAPI):
         :param output_uri: The URI of the output XML document
         :type output_uri: str
 
-        :return: None
+        :return:
         :rtype: None
 
         """
@@ -805,13 +814,14 @@ class AdminAPI(AuthenticatedAPI):
                     f"{self.protocol}://{self.server}/api/admin/transforms/{transform['ApiId']}",
                     headers=headers)
                 if request.status_code == requests.codes.no_content:
-                    return
+                    return None
                 elif request.status_code == requests.codes.unauthorized:
                     self.token = self.__token__()
                     return self.delete_xml_transform(input_uri, output_uri)
                 else:
                     logger.error(request.content.decode('utf-8'))
                     raise RuntimeError(request.status_code, "delete_xml_transform failed")
+        return None
 
     def add_xml_transform(self, name: str, input_uri: str, output_uri: str, purpose: str, originalName: str,
                           xml_data: Any):
@@ -836,7 +846,7 @@ class AdminAPI(AuthenticatedAPI):
         :param xml_data: The transform xml as a string or file like object
         :type xml_data: Any
 
-        :return: None
+        :return:
         :rtype: None
 
         """
@@ -857,7 +867,7 @@ class AdminAPI(AuthenticatedAPI):
                                     params=params,
                                     data=xml_data)
         if request.status_code == requests.codes.created:
-            return
+            return None
 
         if request.status_code == requests.codes.unauthorized:
             self.token = self.__token__()

pyPreservica/authorityAPI.py

@@ -8,9 +8,9 @@ author:     James Carr
 licence:    Apache License 2.0
 
 """
-import json
+
 import csv
-import requests
+from typing import List, Set
 
 from pyPreservica.common import *
 
@@ -54,7 +54,7 @@ class AuthorityAPI(AuthenticatedAPI):
             self.token = self.__token__()
             return self.delete_record(reference)
         if response.status_code == requests.codes.no_content:
-            return
+            return None
         else:
             exception = HTTPException("", response.status_code, response.url, "delete_record",
                                       response.content.decode('utf-8'))
@@ -91,7 +91,7 @@ class AuthorityAPI(AuthenticatedAPI):
          :param table:    The Table to add the record to
          :type: table:    Table
 
-         :param record:    The record
+         :param record:    The record as a dictionary
          :type: record:    dict
 
          :return: A single record
@@ -122,7 +122,7 @@ class AuthorityAPI(AuthenticatedAPI):
         """
          Return a record by its reference
 
-         :param reference:    The record reference
+         :param reference:    The reference of the record
          :type: reference:    str
 
          :return: A single record
@@ -144,11 +144,11 @@ class AuthorityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-    def records(self, table: Table) -> list[dict]:
+    def records(self, table: Table) -> List[dict]:
         """
          Return all records from a table
 
-         :param table:    The authority table
+         :param table:    The authority table to return the records from
          :type: table:    Table
 
          :return: List of records
@@ -177,7 +177,7 @@ class AuthorityAPI(AuthenticatedAPI):
         :param reference:    The reference for the authority table
         :type: reference:    str
 
-        :return: An authority table
+        :return: An authority table of interest
         :rtype: Table
 
         """
@@ -200,7 +200,7 @@ class AuthorityAPI(AuthenticatedAPI):
             logger.error(exception)
             raise exception
 
-    def tables(self) -> set[Table]:
+    def tables(self) -> Set[Table]:
         """
         List reference metadata tables