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

meter_lib-0.0.3/PKG-INFO

@@ -0,0 +1,97 @@
+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

@@ -0,0 +1,79 @@
+## 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.2 → meter_lib-0.0.3}/pyproject.toml

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

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

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

meter_lib-0.0.2/PKG-INFO

@@ -1,19 +0,0 @@
-Metadata-Version: 2.4
-Name: meter-lib
-Version: 0.0.2
-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

meter_lib-0.0.2/README.md

@@ -1 +0,0 @@
-# meter-lib