Metadata-Version: 2.4
Name: southern-company-api
Version: 0.7.0
Summary: Control Southern company websites with this api
License: MIT
License-File: LICENSE
Author: Luke
Author-email: conway220@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Requires-Dist: PyJWT (>=2.0,<3.0)
Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
Project-URL: Bug Tracker, https://github.com/Lash-L/southern-company-api/issues
Project-URL: Changelog, https://github.com/Lash-L/southern-company-api/blob/main/CHANGELOG.md
Project-URL: Repository, https://github.com/Lash-L/southern-company-api
Description-Content-Type: text/markdown

# Southern Company API

<p align="center">
  <a href="https://github.com/Lash-L/southern_company_api/actions/workflows/ci.yml?query=branch%3Amain">
    <img src="https://img.shields.io/github/actions/workflow/status/Lash-L/southern_company_api/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
  </a>
  <a href="https://codecov.io/gh/Lash-L/southern_company_api">
    <img src="https://img.shields.io/codecov/c/github/Lash-L/southern_company_api.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
  </a>
</p>
<p align="center">
  <a href="https://python-poetry.org/">
    <img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
  </a>
  <a href="https://github.com/ambv/black">
    <img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
  </a>
  <a href="https://github.com/pre-commit/pre-commit">
    <img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
  </a>
</p>
<p align="center">
  <a href="https://pypi.org/project/southern-company-api/">
    <img src="https://img.shields.io/pypi/v/southern-company-api.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
  </a>
  <img src="https://img.shields.io/pypi/pyversions/southern-company-api.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
  <img src="https://img.shields.io/pypi/l/southern-company-api.svg?style=flat-square" alt="License">
</p>

Control Southern company websites with this api

## Supported utilities

| Utility                                         | Class                | Auth method    |
| ----------------------------------------------- | -------------------- | -------------- |
| Georgia Power, Alabama Power, Mississippi Power | `SouthernCompanyAPI` | JWT            |
| Nicor Gas (LDC=7)                               | `NicorGasAPI`        | Cookie session |

## Usage

### Southern Company electric utilities (Georgia Power, Alabama Power, Mississippi Power)

```python
import asyncio
import aiohttp
from southern_company_api import SouthernCompanyAPI

async def main():
    async with aiohttp.ClientSession() as session:
        api = SouthernCompanyAPI("username", "password", session)
        await api.connect()
        for account in await api.accounts:
            usage = await account.get_daily_data(start, end, await api.jwt)
            print(usage)

asyncio.run(main())
```

### Nicor Gas

```python
import asyncio
import aiohttp
from southern_company_api import NicorGasAPI

async def main():
    async with aiohttp.ClientSession() as session:
        api = NicorGasAPI("username", "password", session)
        await api.connect()
        history = await api.get_usage_history()

        for period in history.billing_periods:
            print(period.date, period.therms, "therms")

        for day in history.daily_usage:
            print(day.date.date(), day.therms, "therms", day.cost, "cost")

        print("Projected bill:", history.projected_bill.low_amount,
              "–", history.projected_bill.high_amount)

asyncio.run(main())
```

#### Nicor Gas data types

| Type                 | Fields                                                                                                         |
| -------------------- | -------------------------------------------------------------------------------------------------------------- |
| `NicorBillingPeriod` | `date`, `meter_reading`, `reading_details`, `ccfs`, `therms`, `days_used`                                      |
| `NicorDailyUsage`    | `date`, `therms`, `cost`, `avg_temp`, `day_of_week`, `is_weekend`, `read_type`, `meter_read`, `billing_period` |
| `NicorProjectedBill` | `usage`, `low_amount`, `high_amount`                                                                           |
| `NicorMeterInfo`     | `meter_number`, `meter_status`, `next_read_date`                                                               |

All `date` fields are timezone-aware UTC `datetime` objects. The `parse_aspnet_date` helper
converts the ASP.NET `/Date(ms)/` format used in the portal.

## Installation

Install this via pip (or your favourite package manager):

`pip install southern-company-api`

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Lash-L"><img src="https://avatars.githubusercontent.com/u/20257911?v=4?s=80" width="80px;" alt="Luke"/><br /><sub><b>Luke</b></sub></a><br /><a href="https://github.com/Lash-L/southern_company_api/commits?author=Lash-L" title="Code">💻</a> <a href="#ideas-Lash-L" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/Lash-L/southern_company_api/commits?author=Lash-L" title="Documentation">📖</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-end -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## Credits

This package was created with
[Copier](https://copier.readthedocs.io/) and the
[browniebroke/pypackage-template](https://github.com/browniebroke/pypackage-template)
project template.

