meter-lib 0.0.3__tar.gz → 0.0.4__tar.gz

meter_lib-0.0.4/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: meter-lib
+Version: 0.0.4
+Summary: A litewave library to collect the customer credit usage
+Project-URL: Homepage, https://github.com/aiorch/meter-lib
+Project-URL: Repository, https://github.com/aiorch/meter-lib
+Project-URL: Issues, https://github.com/aiorch/meter-lib/issues
+Author-email: Sruthi <sruthi@litewave.ai>
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: requests>=2.28
+Description-Content-Type: text/markdown
+
+## meter-lib — Usage Guide
+
+### Overview
+
+`meter-lib` is a lightweight helper library for sending metering events to the Litewave backend and for looking up a customer account by `tenant_id`.
+
+### Requirements
+
+- Python 3.10+
+
+### Installation
+
+```bash
+pip install meter-lib
+```
+
+### Parameters Required
+
+```
+tenant_id,
+device_id,
+meter_id,
+total_usage,
+start_time,
+end_time
+```
+
+### Quickstart
+
+```python
+from meter_lib import post_meter_usage
+
+tenant_id = "tenant_123"
+device_id = "us-east-ing1"
+meter_id = "document.basic.page"
+
+result = post_meter_usage(
+    tenant_id=tenant_id,
+    device_id=device_id,
+    meter_id=meter_id,
+    total_usage=24,  # integer units as defined by your meter
+)
+```
+
+### For AI enabled
+
+```python
+from meter_lib import post_meter_usage
+
+tenant_id = "tenant_123"
+device_id = "us-east-ing1"
+meter_id = "chat.on.time_hours"
+start_time = 1759791552000 # Timestamp in milliseconds
+
+result = post_meter_usage(
+  tenant_id=tenant_id,
+  device_id=device_id,
+  meter_id=meter_id,
+  start_time= start_time # Timestamp in milliseconds
+)
+
+```
+
+### For AI disabled
+
+```python
+from meter_lib import post_meter_usage
+
+tenant_id = "tenant_123"
+device_id = "us-east-ing1"
+meter_id = "chat.on.time_hours"
+end_time = 1779799552000 # Timestamp in milliseconds
+
+result = post_meter_usage(
+  tenant_id=tenant_id,
+  device_id=device_id,
+  meter_id=meter_id,
+  end_time= end_time # Timestamp in milliseconds
+)
+```
+
+```python
+if result is None:
+    print("Failed to post meter usage event")
+else:
+    print("Event accepted:", result)
+```
+
+### Error Handling
+
+- `post_meter_usage` returns `None` for network errors or non-success HTTP statuses.
+- Prefer explicit checks for `None` and add retries or backoff in your application layer if needed.
+
+### API Reference
+
+#### post_meter_usage(tenant_id: str, device_id: str, meter_id: str, total_usage: int) -> dict | None
+
+- **Description**: Posts a metering event for a device and meter under a given tenant.
+- **Headers**:
+  - `x-tenant-id`: the tenant identifier (string)
+  - `x-device-id`: the device identifier (string)
+- **Payload (JSON)**:
+  - `meter_id` (string)
+  - `total_usage` (integer)
+  - `customer_id` (string) — auto-filled by the library.`
+- **Returns**: The backend JSON response (`dict`) on success, otherwise `None`.
+- **Timeout**: 10 seconds.
+- **Notes**:
+  - If the customer lookup fails, the call is skipped and `None` is returned.
+  - This function is synchronous and will block until the request completes or times out.
+
+### List Of Meters:
+- meter_id: "page.processed.basic"
+  name: "Basic Document Scanning"
+  type: "volume"
+  description: "Total number of basic pages processed"
+
+- meter_id: "page.processed.advanced"
+  name: "Advanced Document Scanning"
+  type: "volume"
+  description: "Total number of advanced pages processed"
+
+- meter_id: "report.generated.small"
+  name: "Small Report Generation"
+  type: "volume"
+  description: "Total number of small reports generated"
+
+- meter_id: "report.generated.medium"
+  name: "Medium Report Generation"
+  type: "volume"
+  description: "Total number of medium reports generated"
+
+- meter_id: "report.generated.large"
+  name: "Large Report Generation"
+  type: "volume"
+  description: "Total number of large reports generated"
+
+- meter_id: "report.generated.dataquery"
+  name: "Data Query Report Generation"
+  type: "volume"
+  description: "Total number of data query reports generated"
+
+- meter_id: "report.generated.insights"
+  name: "Insights Report Generation"
+  type: "volume"
+  description: "Total number of insights reports generated"
+
+- meter_id: "rule.executed.small"
+  name: "Small Rule Execution"
+  type: "volume"
+  description: "Total number of rules executed with runtime less than 1 minute"
+
+- meter_id: "rule.executed.medium"
+  name: "Medium Rule Execution"
+  type: "volume"
+  description: "Total number of rules executed with runtime between 1 and 3 minutes"
+
+- meter_id: "rule.executed.large"
+  name: "Large Rule Execution"
+  type: "volume"
+  description: "Total number of rules executed with runtime greater than 4 minutes"
+
+- meter_id: "chat.on.time_hours"
+  name: "Litewave AI Assistant Usage (Hours)"
+  type: "performance"
+  description: "Total active chat usage time in hours"
+
+- meter_id: "chat.query.time_secs"
+  name: "Litewave AI Assistant Query Time (Seconds)"
+  type: "performance"
+  description: "Total time spent per query in seconds"
+
+- meter_id: "document.storage.size_gb"
+  name: "Document Storage Size"
+  type: "volume"
+  description: "Total document storage consumed in GB"
+
+- meter_id: "template.processed.small"
+  name: "Small Template Processing"
+  type: "volume"
+  description: "Total number of small templates processed"
+
+- meter_id: "template.processed.medium"
+  name: "Medium Template Processing"
+  type: "volume"
+  description: "Total number of medium templates processed"
+
+- meter_id: "template.processed.large"
+  name: "Large Template Processing"
+  type: "volume"
+  description: "Total number of large templates processed"
+
+- meter_id: "template.processed.count"
+  name: "Template Licensing Count"
+  type: "volume"
+  description: "Total number of licensed templates processed"
+
+- meter_id: "template.licensed.total"
+  name: "Yearly Template Setup"
+  type: "volume"
+  description: "Total yearly template setup count"
+
+### Troubleshooting
+
+- Confirm your `tenant_id`, `device_id`, and `meter_id` values are correct.
+
+### Support
+
+- Homepage: `https://github.com/aiorch/meter-lib`
+- Issues: `https://github.com/aiorch/meter-lib/issues`

meter_lib-0.0.4/README.md

@@ -0,0 +1,210 @@
+## meter-lib — Usage Guide
+
+### Overview
+
+`meter-lib` is a lightweight helper library for sending metering events to the Litewave backend and for looking up a customer account by `tenant_id`.
+
+### Requirements
+
+- Python 3.10+
+
+### Installation
+
+```bash
+pip install meter-lib
+```
+
+### Parameters Required
+
+```
+tenant_id,
+device_id,
+meter_id,
+total_usage,
+start_time,
+end_time
+```
+
+### Quickstart
+
+```python
+from meter_lib import post_meter_usage
+
+tenant_id = "tenant_123"
+device_id = "us-east-ing1"
+meter_id = "document.basic.page"
+
+result = post_meter_usage(
+    tenant_id=tenant_id,
+    device_id=device_id,
+    meter_id=meter_id,
+    total_usage=24,  # integer units as defined by your meter
+)
+```
+
+### For AI enabled
+
+```python
+from meter_lib import post_meter_usage
+
+tenant_id = "tenant_123"
+device_id = "us-east-ing1"
+meter_id = "chat.on.time_hours"
+start_time = 1759791552000 # Timestamp in milliseconds
+
+result = post_meter_usage(
+  tenant_id=tenant_id,
+  device_id=device_id,
+  meter_id=meter_id,
+  start_time= start_time # Timestamp in milliseconds
+)
+
+```
+
+### For AI disabled
+
+```python
+from meter_lib import post_meter_usage
+
+tenant_id = "tenant_123"
+device_id = "us-east-ing1"
+meter_id = "chat.on.time_hours"
+end_time = 1779799552000 # Timestamp in milliseconds
+
+result = post_meter_usage(
+  tenant_id=tenant_id,
+  device_id=device_id,
+  meter_id=meter_id,
+  end_time= end_time # Timestamp in milliseconds
+)
+```
+
+```python
+if result is None:
+    print("Failed to post meter usage event")
+else:
+    print("Event accepted:", result)
+```
+
+### Error Handling
+
+- `post_meter_usage` returns `None` for network errors or non-success HTTP statuses.
+- Prefer explicit checks for `None` and add retries or backoff in your application layer if needed.
+
+### API Reference
+
+#### post_meter_usage(tenant_id: str, device_id: str, meter_id: str, total_usage: int) -> dict | None
+
+- **Description**: Posts a metering event for a device and meter under a given tenant.
+- **Headers**:
+  - `x-tenant-id`: the tenant identifier (string)
+  - `x-device-id`: the device identifier (string)
+- **Payload (JSON)**:
+  - `meter_id` (string)
+  - `total_usage` (integer)
+  - `customer_id` (string) — auto-filled by the library.`
+- **Returns**: The backend JSON response (`dict`) on success, otherwise `None`.
+- **Timeout**: 10 seconds.
+- **Notes**:
+  - If the customer lookup fails, the call is skipped and `None` is returned.
+  - This function is synchronous and will block until the request completes or times out.
+
+### List Of Meters:
+- meter_id: "page.processed.basic"
+  name: "Basic Document Scanning"
+  type: "volume"
+  description: "Total number of basic pages processed"
+
+- meter_id: "page.processed.advanced"
+  name: "Advanced Document Scanning"
+  type: "volume"
+  description: "Total number of advanced pages processed"
+
+- meter_id: "report.generated.small"
+  name: "Small Report Generation"
+  type: "volume"
+  description: "Total number of small reports generated"
+
+- meter_id: "report.generated.medium"
+  name: "Medium Report Generation"
+  type: "volume"
+  description: "Total number of medium reports generated"
+
+- meter_id: "report.generated.large"
+  name: "Large Report Generation"
+  type: "volume"
+  description: "Total number of large reports generated"
+
+- meter_id: "report.generated.dataquery"
+  name: "Data Query Report Generation"
+  type: "volume"
+  description: "Total number of data query reports generated"
+
+- meter_id: "report.generated.insights"
+  name: "Insights Report Generation"
+  type: "volume"
+  description: "Total number of insights reports generated"
+
+- meter_id: "rule.executed.small"
+  name: "Small Rule Execution"
+  type: "volume"
+  description: "Total number of rules executed with runtime less than 1 minute"
+
+- meter_id: "rule.executed.medium"
+  name: "Medium Rule Execution"
+  type: "volume"
+  description: "Total number of rules executed with runtime between 1 and 3 minutes"
+
+- meter_id: "rule.executed.large"
+  name: "Large Rule Execution"
+  type: "volume"
+  description: "Total number of rules executed with runtime greater than 4 minutes"
+
+- meter_id: "chat.on.time_hours"
+  name: "Litewave AI Assistant Usage (Hours)"
+  type: "performance"
+  description: "Total active chat usage time in hours"
+
+- meter_id: "chat.query.time_secs"
+  name: "Litewave AI Assistant Query Time (Seconds)"
+  type: "performance"
+  description: "Total time spent per query in seconds"
+
+- meter_id: "document.storage.size_gb"
+  name: "Document Storage Size"
+  type: "volume"
+  description: "Total document storage consumed in GB"
+
+- meter_id: "template.processed.small"
+  name: "Small Template Processing"
+  type: "volume"
+  description: "Total number of small templates processed"
+
+- meter_id: "template.processed.medium"
+  name: "Medium Template Processing"
+  type: "volume"
+  description: "Total number of medium templates processed"
+
+- meter_id: "template.processed.large"
+  name: "Large Template Processing"
+  type: "volume"
+  description: "Total number of large templates processed"
+
+- meter_id: "template.processed.count"
+  name: "Template Licensing Count"
+  type: "volume"
+  description: "Total number of licensed templates processed"
+
+- meter_id: "template.licensed.total"
+  name: "Yearly Template Setup"
+  type: "volume"
+  description: "Total yearly template setup count"
+
+### Troubleshooting
+
+- Confirm your `tenant_id`, `device_id`, and `meter_id` values are correct.
+
+### Support
+
+- Homepage: `https://github.com/aiorch/meter-lib`
+- Issues: `https://github.com/aiorch/meter-lib/issues`

meter_lib-0.0.4/meter_lib/__init__.py

@@ -0,0 +1 @@
+from .core import post_meter_usage, post_ai_meter_usage

meter_lib-0.0.4/meter_lib/core.py

@@ -0,0 +1,112 @@
+from datetime import datetime
+from typing import Optional
+import requests
+
+def fetch_customer_id(tenant_id: str):
+    """
+    Fetch the customer account for a given tenant_id.
+    Returns a dict with customer info, or None if not found/error.
+    """
+    url = f"http://metering.metering.svc.cluster.local:8000/v1alpha1/customer-accounts/tenant/{tenant_id}"
+    try:
+        response = requests.get(url, timeout=10)
+        response.raise_for_status()
+        data = response.json()
+
+        # Handle list response
+        if isinstance(data, list) and len(data) > 0:
+            return data[0]
+        elif isinstance(data, dict):
+            return data
+        else:
+            print(f"No customer account found for tenant {tenant_id}")
+            return None
+
+    except requests.RequestException as e:
+        print(f"Error fetching {url}: {e}")
+        return None
+
+
+def post_meter_usage(tenant_id: str, device_id: str, meter_id: str, total_usage: int) :
+    """
+    Posts meter usage to the events API.
+    Uses tenant_id + device_id in headers and includes customer_id in payload.
+    """
+    customer_account = fetch_customer_id(tenant_id)
+    if not customer_account:
+        print("No customer account available, skipping meter usage post")
+        return None
+
+    url = "https://stream.app.litewave.ai/topics/usage-events"
+    headers = {
+        "Content-Type": "application/vnd.kafka.json.v2+json",
+    }
+    payload = {
+        "records": [
+            {
+                "value": {
+                    "meter_id": meter_id,
+                    "customer_id": customer_account["id"],
+                    "total_usage": total_usage
+                }
+            }
+        ]
+    }
+
+    try:
+        response = requests.post(url, headers=headers, json=payload, timeout=10)
+        response.raise_for_status()
+        return response.json()
+    except requests.RequestException as e:
+        print(f" Error posting to {url}: {e}")
+        return None
+    
+def post_ai_meter_usage(tenant_id: str, device_id: str, meter_id: str, start_time:Optional[datetime]= None, end_time:Optional[datetime]=None) :
+    """
+    Posts meter usage to the ai events API.
+    Uses tenant_id + device_id in headers and includes customer_id in payload.
+    """
+    customer_account = fetch_customer_id(tenant_id)
+    if not customer_account:
+        print("No customer account available, skipping meter usage post")
+        return None
+
+    url = "https://stream.app.litewave.ai/topics/usage-events"
+    headers = {
+        "Content-Type": "application/vnd.kafka.json.v2+json",
+    }
+    if start_time:
+        payload = {
+            "records": [
+                {
+                    "value": {
+                        "ai_event": True,
+                        "meter_id": meter_id,
+                        "customer_id": customer_account["id"],
+                        "start_time": start_time
+                    }
+                }
+            ]
+        }
+    else:
+        payload = {
+            "records": [
+                {
+                    "value": {
+                        "ai_event": True,
+                        "meter_id": meter_id,
+                        "customer_id": customer_account["id"],
+                        "end_time": end_time
+                    }
+                }
+            ]
+        }
+
+    try:
+        response = requests.post(url, headers=headers, json=payload, timeout=10)
+        response.raise_for_status()
+        return response.json()
+    except requests.RequestException as e:
+        print(f" Error posting to {url}: {e}")
+        return None
+

{meter_lib-0.0.3 → meter_lib-0.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "meter-lib"
-version = "0.0.3"
+version = "0.0.4"
 description = "A litewave library to collect the customer credit usage"
 readme = "README.md"
 requires-python = ">=3.10"

{meter_lib-0.0.3 → meter_lib-0.0.4}/setup.py

@@ -10,7 +10,7 @@ with open("requirements.txt", "r", encoding="utf-8") as fh:
 
 setup(
     name="meter-lib",
-    version="0.0.3",
+    version="0.0.4",
     author="Sruthi R",
     author_email="sruthi@litewave.ai",
     description="A litewave library to collect the customer credit usage",

meter_lib-0.0.3/PKG-INFO

@@ -1,97 +0,0 @@
-Metadata-Version: 2.4
-Name: meter-lib
-Version: 0.0.3
-Summary: A litewave library to collect the customer credit usage
-Project-URL: Homepage, https://github.com/aiorch/meter-lib
-Project-URL: Repository, https://github.com/aiorch/meter-lib
-Project-URL: Issues, https://github.com/aiorch/meter-lib/issues
-Author-email: Sruthi <sruthi@litewave.ai>
-License: MIT
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.10
-Requires-Dist: requests>=2.28
-Description-Content-Type: text/markdown
-
-## meter-lib — Usage Guide
-
-### Overview
-
-`meter-lib` is a lightweight helper library for sending metering events to the Litewave backend and for looking up a customer account by `tenant_id`.
-
-### Requirements
-
-- Python 3.10+
-
-### Installation
-
-```bash
-pip install meter-lib
-```
-
-### Parameters Required
-
-```
-tenant_id,
-device_id,
-meter_id,
-total_usage
-```
-
-### Quickstart
-
-```python
-from meter_lib import post_meter_usage
-
-tenant_id = "tenant_123"
-device_id = "device_456"
-meter_id = "pages.processed.rate.hourly"
-
-result = post_meter_usage(
-    tenant_id=tenant_id,
-    device_id=device_id,
-    meter_id=meter_id,
-    total_usage=24,  # integer units as defined by your meter
-)
-
-if result is None:
-    # Handle network error or non-2xx response
-    print("Failed to post meter usage event")
-else:
-    print("Event accepted:", result)
-```
-
-### Error Handling
-
-- `post_meter_usage` returns `None` for network errors or non-success HTTP statuses.
-- Prefer explicit checks for `None` and add retries or backoff in your application layer if needed.
-
-### API Reference
-
-#### post_meter_usage(tenant_id: str, device_id: str, meter_id: str, total_usage: int) -> dict | None
-
-- **Description**: Posts a metering event for a device and meter under a given tenant.
-- **Headers**:
-  - `x-tenant-id`: the tenant identifier (string)
-  - `x-device-id`: the device identifier (string)
-- **Payload (JSON)**:
-  - `meter_id` (string)
-  - `total_usage` (integer)
-  - `customer_id` (string) — auto-filled by the library.`
-- **Returns**: The backend JSON response (`dict`) on success, otherwise `None`.
-- **Timeout**: 10 seconds.
-- **Notes**:
-  - If the customer lookup fails, the call is skipped and `None` is returned.
-  - This function is synchronous and will block until the request completes or times out.
-
-### Troubleshooting
-
-- Confirm your `tenant_id`, `device_id`, and `meter_id` values are correct.
-
-### Support
-
-- Homepage: `https://github.com/aiorch/meter-lib`
-- Issues: `https://github.com/aiorch/meter-lib/issues`

meter_lib-0.0.3/README.md

@@ -1,79 +0,0 @@
-## meter-lib — Usage Guide
-
-### Overview
-
-`meter-lib` is a lightweight helper library for sending metering events to the Litewave backend and for looking up a customer account by `tenant_id`.
-
-### Requirements
-
-- Python 3.10+
-
-### Installation
-
-```bash
-pip install meter-lib
-```
-
-### Parameters Required
-
-```
-tenant_id,
-device_id,
-meter_id,
-total_usage
-```
-
-### Quickstart
-
-```python
-from meter_lib import post_meter_usage
-
-tenant_id = "tenant_123"
-device_id = "device_456"
-meter_id = "pages.processed.rate.hourly"
-
-result = post_meter_usage(
-    tenant_id=tenant_id,
-    device_id=device_id,
-    meter_id=meter_id,
-    total_usage=24,  # integer units as defined by your meter
-)
-
-if result is None:
-    # Handle network error or non-2xx response
-    print("Failed to post meter usage event")
-else:
-    print("Event accepted:", result)
-```
-
-### Error Handling
-
-- `post_meter_usage` returns `None` for network errors or non-success HTTP statuses.
-- Prefer explicit checks for `None` and add retries or backoff in your application layer if needed.
-
-### API Reference
-
-#### post_meter_usage(tenant_id: str, device_id: str, meter_id: str, total_usage: int) -> dict | None
-
-- **Description**: Posts a metering event for a device and meter under a given tenant.
-- **Headers**:
-  - `x-tenant-id`: the tenant identifier (string)
-  - `x-device-id`: the device identifier (string)
-- **Payload (JSON)**:
-  - `meter_id` (string)
-  - `total_usage` (integer)
-  - `customer_id` (string) — auto-filled by the library.`
-- **Returns**: The backend JSON response (`dict`) on success, otherwise `None`.
-- **Timeout**: 10 seconds.
-- **Notes**:
-  - If the customer lookup fails, the call is skipped and `None` is returned.
-  - This function is synchronous and will block until the request completes or times out.
-
-### Troubleshooting
-
-- Confirm your `tenant_id`, `device_id`, and `meter_id` values are correct.
-
-### Support
-
-- Homepage: `https://github.com/aiorch/meter-lib`
-- Issues: `https://github.com/aiorch/meter-lib/issues`

meter_lib-0.0.3/meter_lib/__init__.py

@@ -1 +0,0 @@
-from .core import fetch_customer_id, post_meter_usage

meter_lib-0.0.3/meter_lib/core.py

@@ -1,56 +0,0 @@
-import requests
-
-def fetch_customer_id(tenant_id: str):
-    """
-    Fetch the customer account for a given tenant_id.
-    Returns a dict with customer info, or None if not found/error.
-    """
-    url = f"http://metering.metering.svc.cluster.local:8000/api/v1/customer-accounts/tenant/{tenant_id}"
-    try:
-        response = requests.get(url, timeout=10)
-        response.raise_for_status()
-        data = response.json()
-
-        # Handle list response
-        if isinstance(data, list) and len(data) > 0:
-            return data[0]
-        elif isinstance(data, dict):
-            return data
-        else:
-            print(f"No customer account found for tenant {tenant_id}")
-            return None
-
-    except requests.RequestException as e:
-        print(f"Error fetching {url}: {e}")
-        return None
-
-
-def post_meter_usage(tenant_id: str, device_id: str, meter_id: str, total_usage: int) :
-    """
-    Posts meter usage to the events API.
-    Uses tenant_id + device_id in headers and includes customer_id in payload.
-    """
-    customer_account = fetch_customer_id(tenant_id)
-    if not customer_account:
-        print("No customer account available, skipping meter usage post")
-        return None
-
-    url = "http://metering.metering.svc.cluster.local:8000/api/v1/events"
-    headers = {
-        "x-tenant-id": tenant_id,
-        "x-device-id": device_id,
-        "Content-Type": "application/json"
-    }
-    payload = {
-        "meter_id": meter_id,
-        "total_usage": total_usage,
-        "customer_id": customer_account["id"]
-    }
-
-    try:
-        response = requests.post(url, headers=headers, json=payload, timeout=10)
-        response.raise_for_status()
-        return response.json()
-    except requests.RequestException as e:
-        print(f" Error posting to {url}: {e}")
-        return None