squidink 0.0.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- squidink/__init__.py +3 -0
- squidink/py.typed +0 -0
- squidink-0.0.1.dist-info/METADATA +49 -0
- squidink-0.0.1.dist-info/RECORD +6 -0
- squidink-0.0.1.dist-info/WHEEL +4 -0
- squidink-0.0.1.dist-info/licenses/LICENSE +20 -0
squidink/__init__.py
ADDED
squidink/py.typed
ADDED
|
File without changes
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: squidink
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: A Python client for the Octopus Energy API.
|
|
5
|
+
Project-URL: Homepage, https://github.com/benmcroberts/squidink
|
|
6
|
+
Project-URL: Issues, https://github.com/benmcroberts/squidink/issues
|
|
7
|
+
Author-email: Benjamin McRoberts <squidinkpy@gmail.com>
|
|
8
|
+
License-Expression: MIT
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: api,energy,kraken,octopus-energy,smart-meter
|
|
11
|
+
Classifier: Development Status :: 1 - Planning
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Topic :: Home Automation
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
19
|
+
Classifier: Typing :: Typed
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
|
|
23
|
+
# squidink
|
|
24
|
+
|
|
25
|
+
A Python client for the [Octopus Energy API](https://developer.octopus.energy/).
|
|
26
|
+
|
|
27
|
+
> **Status:** Early development. The `0.0.x` line is a name-reservation placeholder
|
|
28
|
+
> while the public API takes shape. The first usable release will be `0.1.0`.
|
|
29
|
+
|
|
30
|
+
## Planned features
|
|
31
|
+
|
|
32
|
+
- Sync and async client (built on [`httpx`](https://www.python-httpx.org/))
|
|
33
|
+
- Typed response models (pydantic)
|
|
34
|
+
- Flexible credential storage (explicit args, environment variables, or OS keyring)
|
|
35
|
+
- REST coverage of accounts, meter points, consumption, products, and tariffs
|
|
36
|
+
- GraphQL support for Intelligent Octopus dispatch data and live smart meter
|
|
37
|
+
telemetry (later)
|
|
38
|
+
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pip install squidink
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
(Once `0.1.0` is published — the current `0.0.x` releases are placeholders.)
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
[MIT](LICENSE)
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
squidink/__init__.py,sha256=saNqnKb_UXdL2mj__8rpWs8LrTgR3_lZStPkJ_bhHSI,83
|
|
2
|
+
squidink/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
3
|
+
squidink-0.0.1.dist-info/METADATA,sha256=BIm8Z8BBVErc62a5uEJFZYAD9k4AAZqJS0DItAug8-E,1697
|
|
4
|
+
squidink-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
|
5
|
+
squidink-0.0.1.dist-info/licenses/LICENSE,sha256=Q2LaZU9lqXcjvJ8VT2Tv52LsBfa2rMNFHl5QlN_fDZ4,1057
|
|
6
|
+
squidink-0.0.1.dist-info/RECORD,,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Benjamin McRoberts
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF THE SOFTWARE.
|