clerk-sdk 0.1.1__tar.gz → 0.1.2__tar.gz

{clerk_sdk-0.1.1/clerk_sdk.egg-info → clerk_sdk-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.1.1
+Version: 0.1.2
 Summary: Library for interacting with Clerk
 Home-page: https://github.com/F-ONE-Group/clerk_pypi
 Author: F-ONE Group
@@ -26,14 +26,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 +69,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 → clerk_sdk-0.1.2}/README.md

@@ -1,13 +1,13 @@
 # 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
@@ -43,17 +43,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.2/clerk/decorator/task_decorator.py

@@ -0,0 +1,51 @@
+import pickle
+from typing import Callable, Optional
+from functools import wraps
+from .models import ClerkCodePayload
+
+input_pkl: str = "/app/data/input/input.pkl"
+output_pkl: str = "/app/data/output/output.pkl"
+
+
+def clerk_code():
+    def decorator(func: Callable[[ClerkCodePayload], ClerkCodePayload]):
+        @wraps(func)
+        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
+
+            # 2. Execute function
+            try:
+                output = func(payload)
+                if not isinstance(output, ClerkCodePayload):
+                    raise TypeError("Function must return a ClerkCodePayload instance.")
+            except Exception as e:
+                output = e
+
+            # 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 → clerk_sdk-0.1.2/clerk_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clerk-sdk
-Version: 0.1.1
+Version: 0.1.2
 Summary: Library for interacting with Clerk
 Home-page: https://github.com/F-ONE-Group/clerk_pypi
 Author: F-ONE Group
@@ -26,14 +26,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 +69,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 → clerk_sdk-0.1.2}/setup.py

@@ -6,7 +6,7 @@ with open("./requirements.txt", "r") as f:
 
 setup(
     name="clerk-sdk",
-    version="0.1.1",
+    version="0.1.2",
     description="Library for interacting with Clerk",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",

clerk_sdk-0.1.1/clerk/decorator/task_decorator.py

@@ -1,43 +0,0 @@
-import pickle
-from typing import Callable
-from functools import wraps
-from .models import ClerkCodePayload
-
-input_pkl: str = "/app/data/input/input.pkl"
-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
-
-            # Step 2: Call the function and validate output
-            try:
-                output = func(parsed)
-                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
-
-            # Step 3: Write output or exception to pickle
-            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
-
-        return wrapper
-
-    return decorator