pgw-api 1.0.0__tar.gz → 1.2.0__tar.gz

pgw_api-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zackwag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pgw_api-1.2.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: pgw-api
+Version: 1.2.0
+Summary: Python API client for Philadelphia Gas Works (PGW)
+Author: zackwag
+License: MIT
+Project-URL: Homepage, https://github.com/zackwag/pgw-api
+Project-URL: Issues, https://github.com/zackwag/pgw-api/issues
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.9.0
+Dynamic: license-file
+
+# pgw-api
+
+Python API client for [Philadelphia Gas Works (PGW)](https://www.pgworks.com/). Fetches natural gas usage data (monthly, daily, and hourly) from the PGW customer portal.
+
+## Installation
+
+```bash
+pip install pgw-api
+```
+
+## Usage
+
+```python
+import asyncio
+import aiohttp
+from pgw_api import PGWApiClient
+
+async def main():
+    client = PGWApiClient("your-email@example.com", "your-password")
+
+    async with aiohttp.ClientSession(cookie_jar=aiohttp.CookieJar()) as session:
+        usage = await client.async_get_usage(session)
+
+        for entry in usage:
+            print(f"{entry.month:%B %Y}: {entry.ccf} CCF ({entry.cf} ft³)")
+            if entry.period_start and entry.period_end:
+                print(f"  Period: {entry.period_start} to {entry.period_end}")
+
+asyncio.run(main())
+```
+
+## API
+
+### `PGWApiClient(username, password)`
+
+Creates a client instance with PGW portal credentials.
+
+### `await client.async_get_usage(session)`
+
+Authenticates and returns a list of `GasUsage` objects sorted by month (newest first).
+
+### `await client.async_get_daily_usage(session, start, end)`
+
+Authenticates and returns a list of `DailyGasUsage` objects for the given date range (newest first). Requires a smart meter — most residential accounts only have monthly data and will return an empty list.
+
+```python
+from datetime import date
+
+daily = await client.async_get_daily_usage(session, date(2024, 1, 1), date(2024, 1, 31))
+for entry in daily:
+    print(f"{entry.date}: {entry.ccf} CCF")
+```
+
+### `await client.async_get_hourly_usage(session, usage_date)`
+
+Authenticates and returns a list of `HourlyGasUsage` objects for a single day (newest first). Requires a smart meter that reports interval data. Most residential accounts only have monthly data and will return an empty list.
+
+```python
+from datetime import date
+
+hourly = await client.async_get_hourly_usage(session, date(2024, 1, 15))
+for entry in hourly:
+    print(f"{entry.timestamp}: {entry.ccf} CCF")
+```
+
+### `await client.async_validate_credentials(session)`
+
+Validates credentials without fetching usage data. Returns `True` or raises `PGWAuthError`.
+
+### `GasUsage`
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `month` | `date` | First of the billing month |
+| `ccf` | `float` | Usage in hundreds of cubic feet |
+| `cf` | `float` | Usage in cubic feet (CCF × 100) |
+| `period_start` | `date \| None` | Meter read start date |
+| `period_end` | `date \| None` | Meter read end date |
+
+### `DailyGasUsage`
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `date` | `date` | Usage date |
+| `ccf` | `float` | Usage in hundreds of cubic feet |
+| `cf` | `float` | Usage in cubic feet (CCF × 100) |
+
+### `HourlyGasUsage`
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `timestamp` | `datetime` | Usage timestamp |
+| `ccf` | `float` | Usage in hundreds of cubic feet |
+| `cf` | `float` | Usage in cubic feet (CCF × 100) |
+
+### Exceptions
+
+- `PGWAuthError` — invalid credentials or expired session
+- `PGWConnectionError` — network or portal issues
+- `PGWError` — base exception class

pgw_api-1.2.0/README.md

@@ -0,0 +1,100 @@
+# pgw-api
+
+Python API client for [Philadelphia Gas Works (PGW)](https://www.pgworks.com/). Fetches natural gas usage data (monthly, daily, and hourly) from the PGW customer portal.
+
+## Installation
+
+```bash
+pip install pgw-api
+```
+
+## Usage
+
+```python
+import asyncio
+import aiohttp
+from pgw_api import PGWApiClient
+
+async def main():
+    client = PGWApiClient("your-email@example.com", "your-password")
+
+    async with aiohttp.ClientSession(cookie_jar=aiohttp.CookieJar()) as session:
+        usage = await client.async_get_usage(session)
+
+        for entry in usage:
+            print(f"{entry.month:%B %Y}: {entry.ccf} CCF ({entry.cf} ft³)")
+            if entry.period_start and entry.period_end:
+                print(f"  Period: {entry.period_start} to {entry.period_end}")
+
+asyncio.run(main())
+```
+
+## API
+
+### `PGWApiClient(username, password)`
+
+Creates a client instance with PGW portal credentials.
+
+### `await client.async_get_usage(session)`
+
+Authenticates and returns a list of `GasUsage` objects sorted by month (newest first).
+
+### `await client.async_get_daily_usage(session, start, end)`
+
+Authenticates and returns a list of `DailyGasUsage` objects for the given date range (newest first). Requires a smart meter — most residential accounts only have monthly data and will return an empty list.
+
+```python
+from datetime import date
+
+daily = await client.async_get_daily_usage(session, date(2024, 1, 1), date(2024, 1, 31))
+for entry in daily:
+    print(f"{entry.date}: {entry.ccf} CCF")
+```
+
+### `await client.async_get_hourly_usage(session, usage_date)`
+
+Authenticates and returns a list of `HourlyGasUsage` objects for a single day (newest first). Requires a smart meter that reports interval data. Most residential accounts only have monthly data and will return an empty list.
+
+```python
+from datetime import date
+
+hourly = await client.async_get_hourly_usage(session, date(2024, 1, 15))
+for entry in hourly:
+    print(f"{entry.timestamp}: {entry.ccf} CCF")
+```
+
+### `await client.async_validate_credentials(session)`
+
+Validates credentials without fetching usage data. Returns `True` or raises `PGWAuthError`.
+
+### `GasUsage`
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `month` | `date` | First of the billing month |
+| `ccf` | `float` | Usage in hundreds of cubic feet |
+| `cf` | `float` | Usage in cubic feet (CCF × 100) |
+| `period_start` | `date \| None` | Meter read start date |
+| `period_end` | `date \| None` | Meter read end date |
+
+### `DailyGasUsage`
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `date` | `date` | Usage date |
+| `ccf` | `float` | Usage in hundreds of cubic feet |
+| `cf` | `float` | Usage in cubic feet (CCF × 100) |
+
+### `HourlyGasUsage`
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `timestamp` | `datetime` | Usage timestamp |
+| `ccf` | `float` | Usage in hundreds of cubic feet |
+| `cf` | `float` | Usage in cubic feet (CCF × 100) |
+
+### Exceptions
+
+- `PGWAuthError` — invalid credentials or expired session
+- `PGWConnectionError` — network or portal issues
+- `PGWError` — base exception class

{pgw_api-1.0.0 → pgw_api-1.2.0}/pgw_api/__init__.py

@@ -2,10 +2,13 @@
 
 from .client import PGWApiClient
 from .exceptions import PGWAuthError, PGWConnectionError, PGWError
-from .models import GasUsage
+from .models import BillingSummary, DailyGasUsage, GasUsage, HourlyGasUsage
 
 __all__ = [
+    "BillingSummary",
+    "DailyGasUsage",
     "GasUsage",
+    "HourlyGasUsage",
     "PGWApiClient",
     "PGWAuthError",
     "PGWConnectionError",