kodexa 7.4.413792657062__py3-none-any.whl → 7.4.413902283427__py3-none-any.whl

kodexa/platform/client.py

@@ -23,6 +23,7 @@ from pydantic import BaseModel, Field, ConfigDict
 from pydantic_yaml import to_yaml_str
 
 from kodexa.model import Document
+from kodexa.model.model import Ref
 from kodexa.model.objects import (
     PageUser,
     PageMembership,
@@ -4669,6 +4670,23 @@ class DocumentFamilyEndpoint(DocumentFamily, ClientEndpoint):
         process_response(response)
         self.change_sequence = response.json()["changeSequence"]
 
+    def rename(self, new_name: str):
+        """
+        Rename the document family.
+        
+        Args:
+            name (str): The new name of the document family.
+            
+        Returns:
+            None
+        """
+        ref_helper = Ref(self.store_ref)
+        url = f"/api/stores/{ref_helper.org_slug}/{ref_helper.slug}/fs"
+        params = {"rename": new_name, "path": self.path}
+        response = self.client.put(url, params=params)
+        process_response(response)
+        self.change_sequence = response.json()["changeSequence"]
+
     def lock(self):
         """
         Lock the document family.
@@ -5775,7 +5793,7 @@ class DocumentStoreEndpoint(StoreEndpoint):
             document_family_response.json()
         ).set_client(self.client)
 
-    def stream_query(self, query: str = "*", sort=None, limit=None):
+    def stream_query(self, query: str = "*", sort=None, limit=None, page_size=5):
         """
         Stream the query for the document family.
 
@@ -5783,11 +5801,11 @@ class DocumentStoreEndpoint(StoreEndpoint):
             query (str, optional): The query to run. Defaults to "*".
             sort (str, optional): Sorting order of the query. Defaults to None.
             limit (int, optional): The maximum number of items to return. Defaults to None.
+            page_size (int, optional): Pagination size for the streaming
 
         Returns:
             generator: A generator of the document families.
         """
-        page_size = 5
         page = 1
         number_of_items = 0
 
@@ -5841,7 +5859,7 @@ class DocumentStoreEndpoint(StoreEndpoint):
             get_response.json()
         ).set_client(self.client)
 
-    def stream_filter(self, filter_string: str = "", sort=None, limit=None):
+    def stream_filter(self, filter_string: str = "", sort=None, limit=None, page_size=5):
         """
         Stream the filter for the document family.
 
@@ -5849,11 +5867,11 @@ class DocumentStoreEndpoint(StoreEndpoint):
             filter_string (str, optional): The filter string to use. Defaults to "".
             sort (str, optional): Sorting order of the query. Defaults to None.
             limit (int, optional): The maximum number of items to return. Defaults to None.
+            page_size (int, optional): The pagination size for the streaming
 
         Returns:
             generator: A generator of the document families.
         """
-        page_size = 5
         page = 1
         count = 0
         if not sort:

{kodexa-7.4.413792657062.dist-info → kodexa-7.4.413902283427.dist-info}/METADATA

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

{kodexa-7.4.413792657062.dist-info → kodexa-7.4.413902283427.dist-info}/RECORD

@@ -19,7 +19,7 @@ kodexa/model/utils.py,sha256=YEG3f8YzBil06D0P3_dfx2S9GnHREzyrjnlWwQ7oPlU,3038
 kodexa/pipeline/__init__.py,sha256=sA7f5D6qkdMrpp2xTIeefnrUBI6xxEEWostvxfX_1Cs,236
 kodexa/pipeline/pipeline.py,sha256=zyNEpA7KlGhPs_l-vgV6m-OCb16dbxQhl8QezeylugA,25540
 kodexa/platform/__init__.py,sha256=1O3oiWMg292NPL_NacKDnK1T3_R6cMorrPRue_9e-O4,216
-kodexa/platform/client.py,sha256=TzcpWtkkD_h7Jf4O4eRFgSZL7GC5NaA8TgCiubhlfaI,234255
+kodexa/platform/client.py,sha256=pxupPbBfknLHx8s0DrjIvrPc1dhruNWCR1syZDsnHlU,234976
 kodexa/platform/interaction.py,sha256=6zpcwXKNZstUGNS6m4JsoRXAqCZPJHWI-ZN3co8nnF0,1055
 kodexa/platform/kodexa.py,sha256=MUkJx0g-92R0JxoOTUubFqDP4YriXreCSLy6s46XPmo,35102
 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.413792657062.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
-kodexa-7.4.413792657062.dist-info/METADATA,sha256=JjrJDLtcTt_QrGBo_n2VeNSOJw1F4uL-B5Jzkom4ggI,2813
-kodexa-7.4.413792657062.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-kodexa-7.4.413792657062.dist-info/RECORD,,
+kodexa-7.4.413902283427.dist-info/LICENSE,sha256=WNHhf_5RCaeuKWyq_K39vmp9F28LxKsB4SpomwSZ2L0,11357
+kodexa-7.4.413902283427.dist-info/METADATA,sha256=J6xLxe-IRbkSTIlcdn_hsLDXLN8Wy0eRNmmS8cypTKw,2813
+kodexa-7.4.413902283427.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+kodexa-7.4.413902283427.dist-info/RECORD,,