kodexa 7.4.412795054059__py3-none-any.whl → 7.4.412806034916__py3-none-any.whl

kodexa/platform/client.py

@@ -4577,7 +4577,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
 
     def unlock(self):
         """
-        Lock the document family.
+        Unlock the document family.
         """
         url = f"/api/stores/{self.store_ref.replace(':', '/')}/families/{self.id}/unlock"
         response = self.client.put(url)
@@ -4616,6 +4616,35 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
         url = f"/api/documentFamilies/{self.id}/externalData"
         response = self.client.put(url, body=external_data)
         return response.json()
+        
+    def get_json(
+            self,
+            project_id: str,
+            friendly_names=False,            
+    ) -> str:
+        """Get the JSON export for the document family
+
+        Args:
+            project_id str: The project ID
+            friendly_names (bool): Whether to use friendly names. Defaults to False
+
+        Returns:
+            str: The JSON
+        """
+        if project_id is None:
+            raise Exception(
+                f"Project ID is required"
+            )
+        
+        url = f"/api/stores/{self.store_ref.replace(':', '/')}/families/{self.id}/dataObjects"
+        params = {
+            "format": "json",
+            "friendlyNames": friendly_names,
+            "projectId": project_id,
+        }
+
+        response = self.client.get(url, params=params)
+        return response.text
 
     def export(self) -> bytes:
         """
@@ -4651,6 +4680,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             mixin: Optional[str] = None,
             label: Optional[str] = None,
             timeout: int = 60,
+            polling_delay_in_seconds: int = 5,
     ) -> "DocumentFamilyEndpoint":
         """
         Wait for the document family to be ready.
@@ -4659,6 +4689,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             mixin (Optional[str]): The mixin. Defaults to None.
             label (Optional[str]): The label. Defaults to None.
             timeout (int): The timeout. Defaults to 60.
+            polling_delay_in_seconds (int): The polling delay in seconds. Defaults to 5. 5 is the minimum value.
 
         Returns:
             DocumentFamilyEndpoint: The updated document family endpoint.
@@ -4667,6 +4698,9 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             "Waiting for mixin and/or label to be available on document family %s",
             self.id,
         )
+        if polling_delay_in_seconds < 5:        
+            polling_delay_in_seconds = 5
+            
         start = time.time()
         while time.time() - start < timeout:
             url = f"/api/stores/{self.store_ref.replace(':', '/')}/families/{self.id}"
@@ -4680,7 +4714,7 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
             ):
                 return updated_document_family
 
-            time.sleep(5)
+            time.sleep(polling_delay_in_seconds)
 
         raise Exception(f"Not available on document family {self.id}")
 
@@ -5108,7 +5142,6 @@ class DataStoreEndpoint(StoreEndpoint):
             path: Optional[str] = None,
             root_name: str = "",
             friendly_names=True,
-            project_id: Optional[str] = None,
     ) -> str:
         """Get the data objects export of the store
 
@@ -5118,7 +5151,6 @@ class DataStoreEndpoint(StoreEndpoint):
             path (Optional[str]): The path to the data object
             root_name (str): The root name of the data objects export
             friendly_names (bool): Whether to use friendly names. Defaults to True
-            project_id (Optional[str]): The project ID
 
         Returns:
             str: The data objects export of the store
@@ -5134,16 +5166,13 @@ class DataStoreEndpoint(StoreEndpoint):
 
         if path:
             params["path"] = path
-            
-        if project_id:
-            params["projectId"] = project_id
 
         if output_format == "csv" and not path:
             raise ValueError("CSV output requires a path")
 
         response = self.client.get(url, params=params)
         return response.text
-
+    
     def get_taxonomies(self) -> List[Taxonomy]:
         """Get the taxonomies of the store
 

{kodexa-7.4.412795054059.dist-info → kodexa-7.4.412806034916.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kodexa
-Version: 7.4.412795054059
+Version: 7.4.412806034916
 Summary: Python SDK for the Kodexa Platform
 Author: Austin Redenbaugh
 Author-email: austin@kodexa.com

{kodexa-7.4.412795054059.dist-info → kodexa-7.4.412806034916.dist-info}/RECORD

@@ -19,7 +19,7 @@ kodexa/model/utils.py,sha256=6R-3rFiW9irBwj0Mq5yhp7EDXkNUFaeFhr3bWmnlW4g,2961
 kodexa/pipeline/__init__.py,sha256=sA7f5D6qkdMrpp2xTIeefnrUBI6xxEEWostvxfX_1Cs,236
 kodexa/pipeline/pipeline.py,sha256=Z4O6UwoISeP_HMlxm6l6kbcvFBDw3Glm7lT4cUibri4,25461
 kodexa/platform/__init__.py,sha256=1O3oiWMg292NPL_NacKDnK1T3_R6cMorrPRue_9e-O4,216
-kodexa/platform/client.py,sha256=U4p3epTlARDeRJ8CM00-P0N1CCH5XikDqqkLD44Laps,227918
+kodexa/platform/client.py,sha256=UdMLp_1fcWa8bJc30AD8kwLyqM6zxWLQp57cZKYZV9Q,228861
 kodexa/platform/interaction.py,sha256=6zpcwXKNZstUGNS6m4JsoRXAqCZPJHWI-ZN3co8nnF0,1055
 kodexa/platform/kodexa.py,sha256=tPXHO500q3S75GhKGDcaxO51Viq2PNlHmAzpBZlahgo,34857
 kodexa/selectors/__init__.py,sha256=xA9-4vpyaAZWPSk3bh2kvDLkdv6XEmm7PjFbpziiTIk,100
@@ -44,7 +44,7 @@ kodexa/testing/test_utils.py,sha256=v44p__gE7ia67W7WeHN2HBFCWSCUrCZt7G4xBNCmwf8,
 kodexa/training/__init__.py,sha256=xs2L62YpRkIRfslQwtQZ5Yxjhm7sLzX2TrVX6EuBnZQ,52
 kodexa/training/train_utils.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kodexa/utils/__init__.py,sha256=Pnim1o9_db5YEnNvDTxpM7HG-qTlL6n8JwFwOafU9wo,5928
-kodexa-7.4.412795054059.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-kodexa-7.4.412795054059.dist-info/METADATA,sha256=HAlQrKawcDqjYn0bNr8F0maABqFC8sNRT4XDIDOTJ4Q,3528
-kodexa-7.4.412795054059.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-kodexa-7.4.412795054059.dist-info/RECORD,,
+kodexa-7.4.412806034916.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+kodexa-7.4.412806034916.dist-info/METADATA,sha256=nG2DqKve0rZiNBTlMTFRdhCjlmQgQsbe8bZduugLzcU,3528
+kodexa-7.4.412806034916.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+kodexa-7.4.412806034916.dist-info/RECORD,,