clerk-sdk 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

clerk/decorator/task_decorator.py

@@ -1,5 +1,5 @@
 import pickle
-from typing import Callable
+from typing import Callable, Optional
 from functools import wraps
 from .models import ClerkCodePayload
 
@@ -10,34 +10,42 @@ output_pkl: str = "/app/data/output/output.pkl"
 def clerk_code():
     def decorator(func: Callable[[ClerkCodePayload], ClerkCodePayload]):
         @wraps(func)
-        def wrapper():
-            # Step 1: Load and parse input
-            try:
-                with open(input_pkl, "rb") as f:
-                    raw_data = pickle.load(f)
-                parsed = (
-                    ClerkCodePayload.model_validate(raw_data)
-                    if not isinstance(raw_data, ClerkCodePayload)
-                    else raw_data
-                )
-            except Exception as e:
-                raise RuntimeError(f"Failed to load and parse input pickle: {e}") from e
+        def wrapper(payload: Optional[ClerkCodePayload] = None) -> ClerkCodePayload:
+            # 1. Load payload from file if not provided
+            if payload is None:
+                try:
+                    with open(input_pkl, "rb") as f:
+                        raw_data = pickle.load(f)
+                    payload = (
+                        ClerkCodePayload.model_validate(raw_data)
+                        if not isinstance(raw_data, ClerkCodePayload)
+                        else raw_data
+                    )
+                except Exception as e:
+                    raise RuntimeError(
+                        f"Failed to load and parse input pickle: {e}"
+                    ) from e
 
-            # Step 2: Call the function and validate output
+            # 2. Execute function
             try:
-                output = func(parsed)
+                output = func(payload)
                 if not isinstance(output, ClerkCodePayload):
                     raise TypeError("Function must return a ClerkCodePayload instance.")
             except Exception as e:
-                output = e  # Save exception to output file for later debugging
+                output = e
 
-            # Step 3: Write output or exception to pickle
+            # 3. Always write to output.pkl
             try:
                 with open(output_pkl, "wb") as f:
                     pickle.dump(output, f)
             except Exception as e:
                 raise RuntimeError(f"Failed to write output pickle: {e}") from e
 
+            # 4. Raise if error or return result
+            if isinstance(output, Exception):
+                raise output
+            return output
+
         return wrapper
 
     return decorator

{clerk_sdk-0.1.1.dist-info → clerk_sdk-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.1.1
+Version: 0.1.3
 Summary: Library for interacting with Clerk
 Home-page: https://github.com/F-ONE-Group/clerk_pypi
 Author: F-ONE Group
@@ -11,8 +11,9 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pydantic>2.0.0
-Requires-Dist: backoff>2.0.0
+Requires-Dist: pydantic<3.0.0,>=2.0.0
+Requires-Dist: backoff<3.0.0,>=2.0.0
+Requires-Dist: requests<3.0.0,>=2.32.3
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -26,14 +27,14 @@ Dynamic: summary
 
 # CLERK
 
-`clerk-sdk` is a Python library designed to simplify interactions with the Clerk API. It provides a robust and user-friendly interface for managing documents, handling API requests, and integrating structured data models into your workflows. With built-in support for Prefect task flows and retry mechanisms, `clerk-sdk` is ideal for developers looking to streamline their integration with Clerk.
+`clerk-sdk` is a Python library designed to simplify interactions with the Clerk API. It provides a robust and user-friendly interface for managing documents, handling API requests, and integrating structured data models into your workflows. `clerk-sdk` is ideal for developers looking to streamline their integration with Clerk.
 
 ## Features
 
 - **Document Management**: Retrieve and manage documents and their associated files.
 - **API Request Handling**: Simplified GET and POST requests with automatic retries and error handling.
 - **Data Models**: Predefined Pydantic models for structured data validation and serialization.
-- **Task Flow Integration**: Prefect-based decorators for creating and managing task flows.
+- **Task Flow Integration**: Decorator for creating and managing task flows.
 - **Extensibility**: Easily extend and customize the library to fit your specific use case.
 
 ## Installation
@@ -69,17 +70,38 @@ for file in files:
     print(file.name)
 ```
 
-### Use the Prefect Task Decorator
+### Use the Task Decorator
+
+#### PROD
 
 ```python
 from clerk.decorator import clerk_code
+from clerk.decorator.models import ClerkCodePayload
 
 @clerk_code()
-def process_document(payload):
-    # Your processing logic here
-    return {"status": "processed"}
+def main(payload: ClerkCodePayload) -> ClerkCodePayload:
+    payload.structured_data["status"] = "ok"
+    return payload
+
+main()
 ```
 
+#### TEST
+
+```python
+from clerk.decorator.models import ClerkCodePayload, Document
+
+def test_main():
+    test_payload = ClerkCodePayload(
+        document=Document(id="doc-123", message_subject="Hello"),
+        structured_data={}
+    )
+
+    result = main(test_payload)  # ✅ Just pass it!
+    assert result.structured_data["status"] == "ok"
+```
+
+
 ## Requirements
 
 - Python 3.10+

{clerk_sdk-0.1.1.dist-info → clerk_sdk-0.1.3.dist-info}/RECORD

@@ -2,14 +2,14 @@ clerk/__init__.py,sha256=LWpbImG7352mUJYC1tRm_zsn5rnt4sFl5ldoq5f0dlo,26
 clerk/client.py,sha256=UEbs5AhnBs6JWstLzT-TPHZ-yxyBwTFDLemv-yh25K4,3386
 clerk/decorator/__init__.py,sha256=4VCGOFNq7pA7iJS410V_R9eWfjxP7mwxwa4thwaUTf8,39
 clerk/decorator/models.py,sha256=FKs7oCq50hmvbzYWuscvqlL7boPYzMKv0Vg3tznmwao,361
-clerk/decorator/task_decorator.py,sha256=nLKpPG4kRvNuviO5OLeBzHQppNG2RTHFclGOSARajdM,1536
+clerk/decorator/task_decorator.py,sha256=CW8Fhu-4DanJWB8OaDSZtdeWhDeJQOIq4PofEDf8sqg,1799
 clerk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 clerk/models/document.py,sha256=Bbt3YSvGcOrJJjJBYjbDGXpZIaQAYdq_-uIr2urwy5s,525
 clerk/models/document_statuses.py,sha256=ytTQhgACs2m22qz51_7Ti0IxzbVyl-fl7uF7CnDEyLA,279
 clerk/models/file.py,sha256=7n6bV6ukRA-uh7MFxUx_TEMNpVAdNe5O0nKIeneCQhg,459
 clerk/models/response_model.py,sha256=R62daUN1YVOwgnrh_epvFRsQcOwT7R4u97l73egvm-c,232
-clerk_sdk-0.1.1.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
-clerk_sdk-0.1.1.dist-info/METADATA,sha256=LYguUv0vCO8dpZOkwO5TSuD6VpQeTzq4DcgbRMIasmI,2634
-clerk_sdk-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-clerk_sdk-0.1.1.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
-clerk_sdk-0.1.1.dist-info/RECORD,,
+clerk_sdk-0.1.3.dist-info/licenses/LICENSE,sha256=GTVQl3vH6ht70wJXKC0yMT8CmXKHxv_YyO_utAgm7EA,1065
+clerk_sdk-0.1.3.dist-info/METADATA,sha256=lNoj7zwtbuuWUSqI_s6Lq25Q9HGfUsmAYwidw_SCGVE,3041
+clerk_sdk-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+clerk_sdk-0.1.3.dist-info/top_level.txt,sha256=99eQiU6d05_-f41tmSFanfI_SIJeAdh7u9m3LNSfcv4,6
+clerk_sdk-0.1.3.dist-info/RECORD,,