Metadata-Version: 2.4
Name: squidink
Version: 0.0.2
Summary: A Python client for the Octopus Energy API.
Project-URL: Homepage, https://github.com/benmcroberts/squidink
Project-URL: Issues, https://github.com/benmcroberts/squidink/issues
Author-email: Benjamin McRoberts <squidinkpy@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: api,energy,kraken,octopus-energy,smart-meter
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Home Automation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: httpx>=0.27
Requires-Dist: pydantic>=2
Provides-Extra: pandas
Requires-Dist: pandas>=2; extra == 'pandas'
Description-Content-Type: text/markdown

# squidink

A Python client for the [Octopus Energy API](https://developer.octopus.energy/).

> **Status:** Early development. The `0.0.x` line is a name-reservation placeholder
> while the public API takes shape. The first usable release will be `0.1.0`.

## Planned features

- Sync and async client (built on [`httpx`](https://www.python-httpx.org/))
- Typed response models (pydantic)
- Flexible credential storage (explicit args, environment variables, or OS keyring)
- REST coverage of accounts, meter points, consumption, products, and tariffs
- GraphQL support for Intelligent Octopus dispatch data and live smart meter
  telemetry (later)

## Installation

```bash
pip install squidink
```

(Once `0.1.0` is published — the current `0.0.x` releases are placeholders.)

## License

[MIT](LICENSE)
