STY: Add docstrings, fix formatting

Author: jithu-keyvalue

README.md

@@ -66,19 +66,19 @@ This guide will help you set up your environment to contribute to the `siren-ai`
     ```
 
 5.  **Set up pre-commit hooks:**
-    (Ensures code quality before commits. Run from the activated environment or use `uv run ...`)
+    (Ensures code quality before commits)
     ```bash
-    pre-commit install
+    uv run pre-commit install
     ```
     You can also run all hooks manually:
     ```bash
-    pre-commit run --all-files
+    uv run pre-commit run --all-files
     ```
 
 6.  **Run tests:**
-    (Verify the setup and SDK functionality. Run from the activated environment or use `uv run ...`)
+    (Verify the setup and SDK functionality)
     ```bash
-    pytest
+    uv run pytest
     ```
 
 7.  **Start developing!**

examples/basic_usage.py

@@ -1,19 +1,22 @@
+"""Basic usage examples for the Siren SDK."""
+
 # examples/basic_usage.py
 
 # This file will demonstrate basic usage of the SirenClient.
 
 # from siren import SirenClient # This will work once the package is installed
 
 # For local development, you might need to adjust sys.path:
-import sys
 import os
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+import sys
+
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 
 from siren.client import SirenClient
 
 if __name__ == "__main__":
     print("Running Siren SDK basic usage example...")
-    
+
     # Replace 'YOUR_API_KEY' with a real or test API key
     api_key = "YOUR_API_KEY"
     if api_key == "YOUR_API_KEY":

pyproject.toml

@@ -100,6 +100,7 @@ ignore = [
     "D212", # Conflicts with D213 (pydocstyle: Multi-line docstring summary should start at the first line)
     # "D100", # Missing docstring in public module
     # "D104", # Missing docstring in public package
+    "E501", # Line too long (handled by formatter)
 ]
 fixable = ["ALL"]
 

siren/__init__.py

@@ -1,3 +1,5 @@
+"""Siren SDK for Python."""
+
 # siren/__init__.py
 
 # This file makes the 'siren' directory a Python package.
@@ -7,4 +9,4 @@
 # from .client import SirenClient
 # from .templates import TemplateManager
 
-__version__ = "0.1.0" # Placeholder version
+__version__ = "0.1.0"  # Placeholder version

siren/client.py

@@ -1,7 +1,17 @@
+"""Siren API client implementation."""
+
 # siren/client.py
 
+
 class SirenClient:
+    """Client for interacting with the Siren API."""
+
     def __init__(self, api_key: str):
+        """Initialize the SirenClient.
+
+        Args:
+            api_key: The API key for authentication.
+        """
         self.api_key = api_key
         # We will add base_url and other configurations later
         print(f"SirenClient initialized with API key: {api_key[:5]}...")

siren/formatter.py

@@ -1,3 +1,5 @@
+"""Data formatting utilities for Siren SDK."""
+
 # siren/formatter.py
 
 # This module will handle the format_for_human functionality.

siren/templates.py

@@ -1,3 +1,5 @@
+"""Template management for Siren SDK."""
+
 # siren/templates.py
 
 # This module will handle template-related functionalities.

siren/utils.py

@@ -1,3 +1,5 @@
+"""Utility functions for the Siren SDK."""
+
 # siren/utils.py
 
 # This module will contain utility functions for the SDK.

siren/webhooks.py

@@ -1,3 +1,5 @@
+"""Webhook handling for Siren SDK."""
+
 # siren/webhooks.py
 
 # This module will handle webhook configurations and processing.

siren/workflows.py

@@ -1,3 +1,5 @@
+"""Workflow management for Siren SDK."""
+
 # siren/workflows.py
 
 # This module will handle workflow-related functionalities.