pyPreservica 2.6.5__py3-none-any.whl → 2.7.0__py3-none-any.whl

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.6.5"
+__version__ = "2.7.0"
 
 __license__ = "Apache License Version 2.0"

pyPreservica/adminAPI.py

@@ -373,16 +373,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"):
         """

pyPreservica/common.py

@@ -23,6 +23,7 @@ import xml.etree.ElementTree
 from enum import Enum
 from pathlib import Path
 import pyotp
+from requests import Response, Session
 from urllib3.util import Retry
 import requests
 from requests.adapters import HTTPAdapter
@@ -406,10 +407,11 @@ class Bitstream:
         self.content_url = content_url
 
     def __str__(self):
-        return f"Filename:\t\t\t{self.filename}\n" \
-               f"FileSize:\t\t\t{self.length}\n" \
-               f"Content:\t{self.content_url}\n" \
-               f"Fixity:\t{self.fixity}"
+        return f"""
+           Filename:       {self.filename}
+           File Length:    {self.length}
+           Fixity:         {self.fixity}
+        """
 
     def __repr__(self):
         return self.__str__()
@@ -431,11 +433,14 @@ class Generation:
         self.formats = list()
 
     def __str__(self):
-        return f"Active:\t\t\t{self.active}\n" \
-               f"Original:\t\t\t{self.original}\n" \
-               f"Format_group:\t\t\t{self.format_group}\n" \
-               f"Formats:\t\t\t{self.formats}\n" \
-               f"Properties:\t\t\t{self.properties}\n"
+        return f"""
+           Active:         {self.active}
+           Original:       {self.original}
+           Format Group:   {self.format_group}
+           Effective Date: {self.effective_date}
+           Formats:        {self.formats}
+           Properties:     {self.properties}
+           """
 
     def __repr__(self):
         return self.__str__()
@@ -459,19 +464,15 @@ class Entity:
         self.custom_type = None
 
     def __str__(self):
-        if self.custom_type is None:
-            return f"Ref:\t\t\t{self.reference}\n" \
-                   f"Title:\t\t\t{self.title}\n" \
-                   f"Description:\t{self.description}\n" \
-                   f"Security Tag:\t{self.security_tag}\n" \
-                   f"Parent:\t\t\t{self.parent}\n\n"
-        else:
-            return f"Ref:\t\t\t{self.reference}\n" \
-                   f"Title:\t\t\t{self.title}\n" \
-                   f"Description:\t{self.description}\n" \
-                   f"Security Tag:\t{self.security_tag}\n" \
-                   f"Parent:\t\t\t{self.parent}\n" \
-                   f"Type:\t\t\t{self.custom_type}\n\n"
+        return f"""
+            Entity:         {self.entity_type}
+            Entity Ref:     {self.reference}
+            Title:          {self.title}
+            Description:    {self.description}
+            Security Tag:   {self.security_tag}
+            Parent:         {self.parent}
+            Custom Type:    {self.custom_type}
+            """
 
     def __repr__(self):
         return self.__str__()
@@ -860,7 +861,7 @@ class AuthenticatedAPI:
 
         config = configparser.ConfigParser(interpolation=configparser.Interpolation())
         config.read('credentials.properties', encoding='utf-8')
-        self.session = requests.Session()
+        self.session: Session = requests.Session()
 
         retries = Retry(
             total=3,
@@ -869,7 +870,7 @@ class AuthenticatedAPI:
             allowed_methods=Retry.DEFAULT_ALLOWED_METHODS
         )
 
-        self.shared_secret = bool(use_shared_secret)
+        self.shared_secret: bool = bool(use_shared_secret)
         self.protocol = protocol
         self.two_fa_secret_key = two_fa_secret_key
 

pyPreservica/entityAPI.py

@@ -58,7 +58,7 @@ class EntityAPI(AuthenticatedAPI):
 
         :param bitstream:   The bitstream
         :param chunk_size:  The chunk size to return
-        :return:
+        :return:            A chunk of the requested bitstream content
         """
         if not isinstance(bitstream, Bitstream):
             logger.error("bitstream_content argument is not a Bitstream object")
@@ -1880,7 +1880,11 @@ class EntityAPI(AuthenticatedAPI):
     def children(self, folder: Union[str, Folder] = None, maximum: int = 100, next_page: str = None) -> PagedSet:
         headers = {HEADER_TOKEN: self.token}
         data = {'start': str(0), 'max': str(maximum)}
-        folder_reference = folder
+
+        if isinstance(folder, Folder):
+            folder_reference = folder.reference
+        else:
+            folder_reference = folder
         if next_page is None:
             if folder_reference is None:
                 request = self.session.get(f'{self.protocol}://{self.server}/api/entity/root/children', params=data,

pyPreservica/monitorAPI.py

@@ -108,7 +108,7 @@ class MonitorAPI(AuthenticatedAPI):
 
         :param monitor_id:  The Process ID
         :type monitor_id:   str
-        :return: List of timeseries information
+        :return:            List of timeseries information
         """
         headers = {HEADER_TOKEN: self.token, 'Content-Type': 'application/json;charset=UTF-8'}
         request = self.session.get(f'{self.protocol}://{self.server}/api/processmonitor/monitors/{monitor_id}/timeseries',

pyPreservica/workflowAPI.py

@@ -11,7 +11,6 @@ licence:    Apache License 2.0
 
 import uuid
 import datetime
-from xml.dom import minidom
 from xml.etree import ElementTree
 
 from pyPreservica.common import *
@@ -19,23 +18,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
-
     """
 
     def __init__(self, instance_id: int):
@@ -62,14 +48,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 +55,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__()

{pyPreservica-2.6.5.dist-info → pyPreservica-2.7.0.dist-info}/METADATA

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

pyPreservica-2.7.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+pyPreservica/__init__.py,sha256=9CnLUpMumnbIHfqhA4Y1riWp7PJbD_1gMy1sIuNaU5k,1085
+pyPreservica/adminAPI.py,sha256=511bc5KtrCAXbDyBk39dmDnxUVDaOu6xaiyu0jYhxa4,37781
+pyPreservica/authorityAPI.py,sha256=Eule8g6LXr8c8SFcJgpRah4lH1FgevUItO5HhHDEaZE,9172
+pyPreservica/common.py,sha256=upTmwvPK9kcgSO3L8mfIMVrCOWJCCYIHi5GK516jOok,36518
+pyPreservica/contentAPI.py,sha256=d6bK7qXFLep8rOs8y-dJGzoFuqanO3fo82G4dW0YWWE,17245
+pyPreservica/entityAPI.py,sha256=adJFoPE1tfL_K8dE9kfWZMYdnMFtAMv8X6ZUQGxpQRA,114636
+pyPreservica/monitorAPI.py,sha256=HD-PUPdSI9wGAa07e2_2_-FLINH8PoWUwpFogz7F-j4,6269
+pyPreservica/opex.py,sha256=ccra1S4ojUXS3PlbU8WfxajOkJrwG4OykBnNrYP_jus,4875
+pyPreservica/parAPI.py,sha256=bgaQvYfWNnzdD7ibKMV3ZV85pNkEdSoLsgVigoiFFfw,10771
+pyPreservica/retentionAPI.py,sha256=Cx1ofz9V31a8c8utEfKYLlfQaHSaaqg_D4R3LUFBEx0,23612
+pyPreservica/uploadAPI.py,sha256=4Rdm9xvO2FKC8SirOP41g5wVnPEZLRI0Mz4KinxT-L4,93553
+pyPreservica/vocabularyAPI.py,sha256=jPl6KDZoBGqlY0oEYjTpZ9kNEPzchDW-gyp-HH-MSKk,5729
+pyPreservica/webHooksAPI.py,sha256=0wP-59mep8gtlIZ9P5vV68-HnNdTuuo2kzGcDWj0bNg,6790
+pyPreservica/workflowAPI.py,sha256=ENFWxcuPW5WX9jG2CAha6UzTywULWvosgTUVsmvs8f8,17323
+pyPreservica-2.7.0.dist-info/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+pyPreservica-2.7.0.dist-info/METADATA,sha256=G8cCrLf_qnlYZ2ujMTM3edGsjxaVyoAdv3H8QiHUa4A,2784
+pyPreservica-2.7.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+pyPreservica-2.7.0.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
+pyPreservica-2.7.0.dist-info/RECORD,,

pyPreservica-2.6.5.dist-info/RECORD

@@ -1,19 +0,0 @@
-pyPreservica/__init__.py,sha256=xaxuBRyqBz0HqppYSxn2b4Qfu0eapAeK9_hd5ueUbBQ,1085
-pyPreservica/adminAPI.py,sha256=HoiNw1eWKhyb2Ccr40GjjMRjxMQIfoPIWP3h3pQjm0E,37810
-pyPreservica/authorityAPI.py,sha256=Eule8g6LXr8c8SFcJgpRah4lH1FgevUItO5HhHDEaZE,9172
-pyPreservica/common.py,sha256=EUGur629HxdYURuEKO5PoymJHIRvzp7J6EPTCGxDLTY,36777
-pyPreservica/contentAPI.py,sha256=d6bK7qXFLep8rOs8y-dJGzoFuqanO3fo82G4dW0YWWE,17245
-pyPreservica/entityAPI.py,sha256=C-OeanPz_v1MA-Y7rrER0U4XN5BZBgYPNHSWLsv-bWw,114472
-pyPreservica/monitorAPI.py,sha256=Xto2uSiryfZlUMUCrH7it2B8xOPVSLgSVLodxZW45po,6258
-pyPreservica/opex.py,sha256=ccra1S4ojUXS3PlbU8WfxajOkJrwG4OykBnNrYP_jus,4875
-pyPreservica/parAPI.py,sha256=bgaQvYfWNnzdD7ibKMV3ZV85pNkEdSoLsgVigoiFFfw,10771
-pyPreservica/retentionAPI.py,sha256=Cx1ofz9V31a8c8utEfKYLlfQaHSaaqg_D4R3LUFBEx0,23612
-pyPreservica/uploadAPI.py,sha256=4Rdm9xvO2FKC8SirOP41g5wVnPEZLRI0Mz4KinxT-L4,93553
-pyPreservica/vocabularyAPI.py,sha256=jPl6KDZoBGqlY0oEYjTpZ9kNEPzchDW-gyp-HH-MSKk,5729
-pyPreservica/webHooksAPI.py,sha256=0wP-59mep8gtlIZ9P5vV68-HnNdTuuo2kzGcDWj0bNg,6790
-pyPreservica/workflowAPI.py,sha256=QOMd4Nw69Vf8tJ7Px4gSLpug7VakAtNi-90UTgWSed0,17862
-pyPreservica-2.6.5.dist-info/LICENSE.txt,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-pyPreservica-2.6.5.dist-info/METADATA,sha256=_EAz4x6us5peNLXe7e_UTK6lU1IEYAUMqcBvdAu06CU,2784
-pyPreservica-2.6.5.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-pyPreservica-2.6.5.dist-info/top_level.txt,sha256=iIBh6NAznYQHOV8mv_y_kGKSDITek9rANyFDwJsbU-c,13
-pyPreservica-2.6.5.dist-info/RECORD,,