squidink 0.0.1__tar.gz
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-0.0.1/.gitignore +22 -0
- squidink-0.0.1/.idea/.gitignore +10 -0
- squidink-0.0.1/.idea/inspectionProfiles/profiles_settings.xml +6 -0
- squidink-0.0.1/.idea/misc.xml +6 -0
- squidink-0.0.1/.idea/modules.xml +8 -0
- squidink-0.0.1/.idea/squidink.iml +10 -0
- squidink-0.0.1/.idea/vcs.xml +6 -0
- squidink-0.0.1/.idea/workspace.xml +262 -0
- squidink-0.0.1/LICENSE +20 -0
- squidink-0.0.1/PKG-INFO +49 -0
- squidink-0.0.1/README.md +27 -0
- squidink-0.0.1/pyproject.toml +37 -0
- squidink-0.0.1/src/squidink/__init__.py +3 -0
- squidink-0.0.1/src/squidink/py.typed +0 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Build artifacts
|
|
2
|
+
build/
|
|
3
|
+
dist/
|
|
4
|
+
*.egg-info/
|
|
5
|
+
__pycache__/
|
|
6
|
+
*.py[cod]
|
|
7
|
+
|
|
8
|
+
# Virtual environments
|
|
9
|
+
.venv/
|
|
10
|
+
venv/
|
|
11
|
+
env/
|
|
12
|
+
|
|
13
|
+
# Tooling caches
|
|
14
|
+
.pytest_cache/
|
|
15
|
+
.ruff_cache/
|
|
16
|
+
.mypy_cache/
|
|
17
|
+
|
|
18
|
+
# Editor
|
|
19
|
+
.vscode/
|
|
20
|
+
|
|
21
|
+
# OS
|
|
22
|
+
.DS_Store
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<module type="PYTHON_MODULE" version="4">
|
|
3
|
+
<component name="NewModuleRootManager">
|
|
4
|
+
<content url="file://$MODULE_DIR$">
|
|
5
|
+
<excludeFolder url="file://$MODULE_DIR$/.venv" />
|
|
6
|
+
</content>
|
|
7
|
+
<orderEntry type="jdk" jdkName="Python 3.9 (squidink)" jdkType="Python SDK" />
|
|
8
|
+
<orderEntry type="sourceFolder" forTests="false" />
|
|
9
|
+
</component>
|
|
10
|
+
</module>
|
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<project version="4">
|
|
3
|
+
<component name="AutoImportSettings">
|
|
4
|
+
<option name="autoReloadType" value="ALL" />
|
|
5
|
+
</component>
|
|
6
|
+
<component name="ChangeListManager">
|
|
7
|
+
<list default="true" id="c4886694-ff03-45a4-9761-1831a21afb10" name="Changes" comment="" />
|
|
8
|
+
<option name="SHOW_DIALOG" value="false" />
|
|
9
|
+
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
|
10
|
+
<option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
|
|
11
|
+
<option name="LAST_RESOLUTION" value="IGNORE" />
|
|
12
|
+
</component>
|
|
13
|
+
<component name="Git.Settings">
|
|
14
|
+
<option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
|
|
15
|
+
</component>
|
|
16
|
+
<component name="GitHubPullRequestSearchHistory">{
|
|
17
|
+
"lastFilter": {
|
|
18
|
+
"state": "OPEN",
|
|
19
|
+
"assignee": "benmcroberts"
|
|
20
|
+
}
|
|
21
|
+
}</component>
|
|
22
|
+
<component name="GithubPullRequestsUISettings">{
|
|
23
|
+
"selectedUrlAndAccountId": {
|
|
24
|
+
"url": "https://github.com/benmcroberts/squidink.git",
|
|
25
|
+
"accountId": "33b92ebb-2084-4fc9-b235-475ec3807931"
|
|
26
|
+
}
|
|
27
|
+
}</component>
|
|
28
|
+
<component name="ProjectColorInfo">{
|
|
29
|
+
"associatedIndex": 7,
|
|
30
|
+
"fromUser": false
|
|
31
|
+
}</component>
|
|
32
|
+
<component name="ProjectId" id="3EkrxMkwLJgBDxacKTx9BumDNDW" />
|
|
33
|
+
<component name="ProjectViewState">
|
|
34
|
+
<option name="hideEmptyMiddlePackages" value="true" />
|
|
35
|
+
<option name="showLibraryContents" value="true" />
|
|
36
|
+
</component>
|
|
37
|
+
<component name="PropertiesComponent"><![CDATA[{
|
|
38
|
+
"keyToString": {
|
|
39
|
+
"RunOnceActivity.ShowReadmeOnStart": "true",
|
|
40
|
+
"RunOnceActivity.TerminalTabsStorage.copyFrom.TerminalArrangementManager.252": "true",
|
|
41
|
+
"RunOnceActivity.git.unshallow": "true",
|
|
42
|
+
"RunOnceActivity.typescript.service.memoryLimit.init": "true",
|
|
43
|
+
"codeWithMe.voiceChat.enabledByDefault": "false",
|
|
44
|
+
"git-widget-placeholder": "main",
|
|
45
|
+
"last_opened_file_path": "/Users/benmcroberts/Developer/Python/squidink",
|
|
46
|
+
"node.js.detected.package.eslint": "true",
|
|
47
|
+
"node.js.detected.package.tslint": "true",
|
|
48
|
+
"node.js.selected.package.eslint": "(autodetect)",
|
|
49
|
+
"node.js.selected.package.tslint": "(autodetect)",
|
|
50
|
+
"nodejs_package_manager_path": "npm",
|
|
51
|
+
"vue.rearranger.settings.migration": "true"
|
|
52
|
+
}
|
|
53
|
+
}]]></component>
|
|
54
|
+
<component name="RunManager">
|
|
55
|
+
<configuration default="true" type="DjangoTestsConfigurationType">
|
|
56
|
+
<module name="squidink" />
|
|
57
|
+
<option name="ENV_FILES" value="" />
|
|
58
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
59
|
+
<option name="PARENT_ENVS" value="true" />
|
|
60
|
+
<envs>
|
|
61
|
+
<env name="PYTHONUNBUFFERED" value="1" />
|
|
62
|
+
</envs>
|
|
63
|
+
<option name="SDK_HOME" value="" />
|
|
64
|
+
<option name="WORKING_DIRECTORY" value="" />
|
|
65
|
+
<option name="IS_MODULE_SDK" value="false" />
|
|
66
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
67
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
68
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
69
|
+
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
|
|
70
|
+
<option name="RUN_TOOL" value="" />
|
|
71
|
+
<option name="TARGET" value="" />
|
|
72
|
+
<option name="SETTINGS_FILE" value="" />
|
|
73
|
+
<option name="CUSTOM_SETTINGS" value="false" />
|
|
74
|
+
<option name="USE_OPTIONS" value="false" />
|
|
75
|
+
<option name="OPTIONS" value="" />
|
|
76
|
+
<method v="2" />
|
|
77
|
+
</configuration>
|
|
78
|
+
<configuration default="true" type="PythonConfigurationType" factoryName="Python">
|
|
79
|
+
<module name="squidink" />
|
|
80
|
+
<option name="ENV_FILES" value="" />
|
|
81
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
82
|
+
<option name="PARENT_ENVS" value="true" />
|
|
83
|
+
<envs>
|
|
84
|
+
<env name="PYTHONUNBUFFERED" value="1" />
|
|
85
|
+
</envs>
|
|
86
|
+
<option name="SDK_HOME" value="" />
|
|
87
|
+
<option name="WORKING_DIRECTORY" value="" />
|
|
88
|
+
<option name="IS_MODULE_SDK" value="false" />
|
|
89
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
90
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
91
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
92
|
+
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
|
|
93
|
+
<option name="RUN_TOOL" value="" />
|
|
94
|
+
<option name="SCRIPT_NAME" value="" />
|
|
95
|
+
<option name="PARAMETERS" value="" />
|
|
96
|
+
<option name="SHOW_COMMAND_LINE" value="false" />
|
|
97
|
+
<option name="EMULATE_TERMINAL" value="false" />
|
|
98
|
+
<option name="MODULE_MODE" value="false" />
|
|
99
|
+
<option name="REDIRECT_INPUT" value="false" />
|
|
100
|
+
<option name="INPUT_FILE" value="" />
|
|
101
|
+
<method v="2" />
|
|
102
|
+
</configuration>
|
|
103
|
+
<configuration name="main" type="PythonConfigurationType" factoryName="Python" nameIsGenerated="true">
|
|
104
|
+
<module name="squidink" />
|
|
105
|
+
<option name="ENV_FILES" value="" />
|
|
106
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
107
|
+
<option name="PARENT_ENVS" value="true" />
|
|
108
|
+
<envs>
|
|
109
|
+
<env name="PYTHONUNBUFFERED" value="1" />
|
|
110
|
+
</envs>
|
|
111
|
+
<option name="SDK_HOME" value="" />
|
|
112
|
+
<option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
|
|
113
|
+
<option name="IS_MODULE_SDK" value="true" />
|
|
114
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
115
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
116
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
117
|
+
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
|
|
118
|
+
<option name="RUN_TOOL" value="" />
|
|
119
|
+
<option name="SCRIPT_NAME" value="$PROJECT_DIR$/main.py" />
|
|
120
|
+
<option name="PARAMETERS" value="" />
|
|
121
|
+
<option name="SHOW_COMMAND_LINE" value="false" />
|
|
122
|
+
<option name="EMULATE_TERMINAL" value="false" />
|
|
123
|
+
<option name="MODULE_MODE" value="false" />
|
|
124
|
+
<option name="REDIRECT_INPUT" value="false" />
|
|
125
|
+
<option name="INPUT_FILE" value="" />
|
|
126
|
+
<method v="2" />
|
|
127
|
+
</configuration>
|
|
128
|
+
<configuration default="true" type="Python.Celery" factoryName="Python.Celery.App">
|
|
129
|
+
<module name="squidink" />
|
|
130
|
+
<option name="ENV_FILES" value="" />
|
|
131
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
132
|
+
<option name="PARENT_ENVS" value="true" />
|
|
133
|
+
<option name="SDK_HOME" value="" />
|
|
134
|
+
<option name="WORKING_DIRECTORY" value="" />
|
|
135
|
+
<option name="IS_MODULE_SDK" value="false" />
|
|
136
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
137
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
138
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
139
|
+
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
|
|
140
|
+
<option name="RUN_TOOL" value="" />
|
|
141
|
+
<method v="2" />
|
|
142
|
+
</configuration>
|
|
143
|
+
<configuration default="true" type="Python.Celery" factoryName="Python.Celery.Task">
|
|
144
|
+
<module name="squidink" />
|
|
145
|
+
<option name="ENV_FILES" value="" />
|
|
146
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
147
|
+
<option name="PARENT_ENVS" value="true" />
|
|
148
|
+
<option name="SDK_HOME" value="" />
|
|
149
|
+
<option name="WORKING_DIRECTORY" value="" />
|
|
150
|
+
<option name="IS_MODULE_SDK" value="false" />
|
|
151
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
152
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
153
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
154
|
+
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
|
|
155
|
+
<option name="RUN_TOOL" value="" />
|
|
156
|
+
<method v="2" />
|
|
157
|
+
</configuration>
|
|
158
|
+
<configuration default="true" type="Python.FlaskServer">
|
|
159
|
+
<module name="squidink" />
|
|
160
|
+
<option name="ENV_FILES" value="" />
|
|
161
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
162
|
+
<option name="PARENT_ENVS" value="true" />
|
|
163
|
+
<option name="SDK_HOME" value="" />
|
|
164
|
+
<option name="WORKING_DIRECTORY" value="" />
|
|
165
|
+
<option name="IS_MODULE_SDK" value="false" />
|
|
166
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
167
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
168
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
169
|
+
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
|
|
170
|
+
<option name="RUN_TOOL" value="" />
|
|
171
|
+
<option name="launchJavascriptDebuger" value="false" />
|
|
172
|
+
<method v="2" />
|
|
173
|
+
</configuration>
|
|
174
|
+
<configuration default="true" type="Tox" factoryName="Tox">
|
|
175
|
+
<module name="squidink" />
|
|
176
|
+
<option name="ENV_FILES" value="" />
|
|
177
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
178
|
+
<option name="PARENT_ENVS" value="true" />
|
|
179
|
+
<option name="SDK_HOME" value="" />
|
|
180
|
+
<option name="WORKING_DIRECTORY" value="" />
|
|
181
|
+
<option name="IS_MODULE_SDK" value="false" />
|
|
182
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
183
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
184
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
185
|
+
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
|
|
186
|
+
<option name="RUN_TOOL" value="" />
|
|
187
|
+
<method v="2" />
|
|
188
|
+
</configuration>
|
|
189
|
+
<configuration default="true" type="docs" factoryName="Docutils task">
|
|
190
|
+
<module name="squidink" />
|
|
191
|
+
<option name="ENV_FILES" value="" />
|
|
192
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
193
|
+
<option name="PARENT_ENVS" value="true" />
|
|
194
|
+
<option name="SDK_HOME" value="" />
|
|
195
|
+
<option name="WORKING_DIRECTORY" value="" />
|
|
196
|
+
<option name="IS_MODULE_SDK" value="false" />
|
|
197
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
198
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
199
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
200
|
+
<option name="RUN_TOOL" value="" />
|
|
201
|
+
<option name="docutils_input_file" value="" />
|
|
202
|
+
<option name="docutils_output_file" value="" />
|
|
203
|
+
<option name="docutils_params" value="" />
|
|
204
|
+
<option name="docutils_task" value="" />
|
|
205
|
+
<option name="docutils_open_in_browser" value="false" />
|
|
206
|
+
<method v="2" />
|
|
207
|
+
</configuration>
|
|
208
|
+
<configuration default="true" type="docs" factoryName="Sphinx task">
|
|
209
|
+
<module name="squidink" />
|
|
210
|
+
<option name="ENV_FILES" value="" />
|
|
211
|
+
<option name="INTERPRETER_OPTIONS" value="" />
|
|
212
|
+
<option name="PARENT_ENVS" value="true" />
|
|
213
|
+
<option name="SDK_HOME" value="" />
|
|
214
|
+
<option name="WORKING_DIRECTORY" value="" />
|
|
215
|
+
<option name="IS_MODULE_SDK" value="false" />
|
|
216
|
+
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
217
|
+
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
218
|
+
<option name="DEBUG_JUST_MY_CODE" value="false" />
|
|
219
|
+
<option name="RUN_TOOL" value="" />
|
|
220
|
+
<option name="docutils_input_file" value="" />
|
|
221
|
+
<option name="docutils_output_file" value="" />
|
|
222
|
+
<option name="docutils_params" value="" />
|
|
223
|
+
<option name="docutils_task" value="" />
|
|
224
|
+
<option name="docutils_open_in_browser" value="false" />
|
|
225
|
+
<method v="2" />
|
|
226
|
+
</configuration>
|
|
227
|
+
</component>
|
|
228
|
+
<component name="SharedIndexes">
|
|
229
|
+
<attachedChunks>
|
|
230
|
+
<set>
|
|
231
|
+
<option value="bundled-js-predefined-d6986cc7102b-3bd3a6803838-JavaScript-PY-261.22158.340" />
|
|
232
|
+
<option value="bundled-python-sdk-b63d5a1f7c97-b61e75351b1f-com.jetbrains.pycharm.pro.sharedIndexes.bundled-PY-261.22158.340" />
|
|
233
|
+
</set>
|
|
234
|
+
</attachedChunks>
|
|
235
|
+
</component>
|
|
236
|
+
<component name="TaskManager">
|
|
237
|
+
<task active="true" id="Default" summary="Default task">
|
|
238
|
+
<changelist id="c4886694-ff03-45a4-9761-1831a21afb10" name="Changes" comment="" />
|
|
239
|
+
<created>1780733653291</created>
|
|
240
|
+
<option name="number" value="Default" />
|
|
241
|
+
<option name="presentableId" value="Default" />
|
|
242
|
+
<updated>1780733653291</updated>
|
|
243
|
+
<workItem from="1780733654306" duration="736000" />
|
|
244
|
+
<workItem from="1780734819856" duration="1649000" />
|
|
245
|
+
</task>
|
|
246
|
+
<servers />
|
|
247
|
+
</component>
|
|
248
|
+
<component name="TypeScriptGeneratedFilesManager">
|
|
249
|
+
<option name="version" value="3" />
|
|
250
|
+
</component>
|
|
251
|
+
<component name="Vcs.Log.Tabs.Properties">
|
|
252
|
+
<option name="TAB_STATES">
|
|
253
|
+
<map>
|
|
254
|
+
<entry key="MAIN">
|
|
255
|
+
<value>
|
|
256
|
+
<State />
|
|
257
|
+
</value>
|
|
258
|
+
</entry>
|
|
259
|
+
</map>
|
|
260
|
+
</option>
|
|
261
|
+
</component>
|
|
262
|
+
</project>
|
squidink-0.0.1/LICENSE
ADDED
|
@@ -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.
|
squidink-0.0.1/PKG-INFO
ADDED
|
@@ -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)
|
squidink-0.0.1/README.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# squidink
|
|
2
|
+
|
|
3
|
+
A Python client for the [Octopus Energy API](https://developer.octopus.energy/).
|
|
4
|
+
|
|
5
|
+
> **Status:** Early development. The `0.0.x` line is a name-reservation placeholder
|
|
6
|
+
> while the public API takes shape. The first usable release will be `0.1.0`.
|
|
7
|
+
|
|
8
|
+
## Planned features
|
|
9
|
+
|
|
10
|
+
- Sync and async client (built on [`httpx`](https://www.python-httpx.org/))
|
|
11
|
+
- Typed response models (pydantic)
|
|
12
|
+
- Flexible credential storage (explicit args, environment variables, or OS keyring)
|
|
13
|
+
- REST coverage of accounts, meter points, consumption, products, and tariffs
|
|
14
|
+
- GraphQL support for Intelligent Octopus dispatch data and live smart meter
|
|
15
|
+
telemetry (later)
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pip install squidink
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
(Once `0.1.0` is published — the current `0.0.x` releases are placeholders.)
|
|
24
|
+
|
|
25
|
+
## License
|
|
26
|
+
|
|
27
|
+
[MIT](LICENSE)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "squidink"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "A Python client for the Octopus Energy API."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.11"
|
|
11
|
+
license = "MIT"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
13
|
+
authors = [
|
|
14
|
+
{ name = "Benjamin McRoberts", email = "squidinkpy@gmail.com"},
|
|
15
|
+
]
|
|
16
|
+
keywords = ["octopus-energy", "energy", "smart-meter", "api", "kraken"]
|
|
17
|
+
classifiers = [
|
|
18
|
+
"Development Status :: 1 - Planning",
|
|
19
|
+
"Intended Audience :: Developers",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3.11",
|
|
22
|
+
"Programming Language :: Python :: 3.12",
|
|
23
|
+
"Programming Language :: Python :: 3.13",
|
|
24
|
+
"Topic :: Home Automation",
|
|
25
|
+
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
26
|
+
"Typing :: Typed",
|
|
27
|
+
]
|
|
28
|
+
|
|
29
|
+
[project.urls]
|
|
30
|
+
Homepage = "https://github.com/benmcroberts/squidink"
|
|
31
|
+
Issues = "https://github.com/benmcroberts/squidink/issues"
|
|
32
|
+
|
|
33
|
+
[tool.hatch.version]
|
|
34
|
+
path = "src/squidink/__init__.py"
|
|
35
|
+
|
|
36
|
+
[tool.hatch.build.targets.wheel]
|
|
37
|
+
packages = ["src/squidink"]
|
|
File without changes
|