hot-dev 1.1.0__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.
@@ -0,0 +1,42 @@
1
+ name: CI
2
+
3
+ on:
4
+ pull_request:
5
+ push:
6
+ branches:
7
+ - main
8
+
9
+ jobs:
10
+ test:
11
+ name: Python ${{ matrix.python-version }}
12
+ runs-on: ubuntu-latest
13
+ strategy:
14
+ fail-fast: false
15
+ matrix:
16
+ python-version:
17
+ - "3.10"
18
+ - "3.11"
19
+ - "3.12"
20
+ - "3.13"
21
+
22
+ steps:
23
+ - name: Checkout
24
+ uses: actions/checkout@v4
25
+
26
+ - name: Set up Python
27
+ uses: actions/setup-python@v5
28
+ with:
29
+ python-version: ${{ matrix.python-version }}
30
+ cache: pip
31
+
32
+ - name: Install
33
+ run: python -m pip install -e ".[dev]"
34
+
35
+ - name: Lint
36
+ run: ruff check .
37
+
38
+ - name: Test
39
+ run: pytest
40
+
41
+ - name: Build
42
+ run: python -m build
@@ -0,0 +1,37 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ tags:
6
+ - "v*"
7
+
8
+ permissions:
9
+ contents: read
10
+
11
+ jobs:
12
+ publish:
13
+ name: Publish to PyPI
14
+ runs-on: ubuntu-latest
15
+ environment: pypi
16
+ permissions:
17
+ contents: read
18
+ id-token: write
19
+
20
+ steps:
21
+ - name: Checkout
22
+ uses: actions/checkout@v4
23
+
24
+ - name: Set up Python
25
+ uses: actions/setup-python@v5
26
+ with:
27
+ python-version: "3.13"
28
+ cache: pip
29
+
30
+ - name: Install build tools
31
+ run: python -m pip install build
32
+
33
+ - name: Build
34
+ run: python -m build
35
+
36
+ - name: Publish
37
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,8 @@
1
+ .venv/
2
+ __pycache__/
3
+ .pytest_cache/
4
+ .ruff_cache/
5
+ *.egg-info/
6
+ build/
7
+ dist/
8
+ .DS_Store
@@ -0,0 +1,43 @@
1
+ # AGENTS.md - hot-python
2
+
3
+ This repo contains the Python SDK for the Hot Dev API.
4
+
5
+ ## Package Shape
6
+
7
+ - PyPI distribution name: `hot-dev`
8
+ - Python import package: `hot`
9
+ - Source layout: `src/hot/`, with `py.typed` marker
10
+ - Runtime dependency: `httpx`
11
+ - Versioning follows the public API package version, starting at `1.0.0`.
12
+
13
+ ## Commands
14
+
15
+ ```bash
16
+ python -m pip install -e ".[dev]"
17
+ ruff check .
18
+ pytest
19
+ python -m build
20
+ ```
21
+
22
+ ## CI and Releases
23
+
24
+ - CI runs on pushes and pull requests to `main`: install, lint (`ruff`), test
25
+ (`pytest`), and build (`python -m build`) on Python 3.10–3.13.
26
+ - PyPI releases run from tags named `v<version>` matching the
27
+ `pyproject.toml` version.
28
+ - Publishing uses PyPI Trusted Publishing via OIDC against the `pypi` GitHub
29
+ Actions environment — no PyPI token secret is required, but the project
30
+ publisher must be configured on PyPI before the first tag push.
31
+
32
+ Release flow:
33
+
34
+ ```bash
35
+ # Bump the version in pyproject.toml.
36
+ git add pyproject.toml
37
+ git commit -m "release v<version>"
38
+ git tag v<version>
39
+ git push origin main v<version>
40
+ ```
41
+
42
+ Always update the SDK version in lockstep with new API surface area added to
43
+ the matching `@hot-dev/sdk` JavaScript release when possible.
hot_dev-1.1.0/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Hot Dev, LLC
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
hot_dev-1.1.0/PKG-INFO ADDED
@@ -0,0 +1,202 @@
1
+ Metadata-Version: 2.4
2
+ Name: hot-dev
3
+ Version: 1.1.0
4
+ Summary: Python SDK for the Hot Dev API
5
+ Project-URL: Homepage, https://hot.dev
6
+ Project-URL: Repository, https://github.com/hot-dev/hot-python
7
+ Project-URL: Issues, https://github.com/hot-dev/hot-python/issues
8
+ Author: Hot Dev, LLC
9
+ License-Expression: Apache-2.0
10
+ License-File: LICENSE
11
+ Keywords: agents,api,hot,hot-dev,sdk,streaming
12
+ Requires-Python: >=3.10
13
+ Requires-Dist: httpx>=0.28
14
+ Provides-Extra: dev
15
+ Requires-Dist: build>=1.2; extra == 'dev'
16
+ Requires-Dist: pytest>=8.0; extra == 'dev'
17
+ Requires-Dist: ruff>=0.8; extra == 'dev'
18
+ Description-Content-Type: text/markdown
19
+
20
+ # hot-dev
21
+
22
+ Official Python SDK for the [Hot Dev](https://hot.dev) API.
23
+
24
+ - PyPI distribution: `hot-dev`
25
+ - Import package: `hot`
26
+ - Tested on Python 3.10, 3.11, 3.12, 3.13
27
+
28
+ ## Install
29
+
30
+ ```bash
31
+ pip install hot-dev
32
+ ```
33
+
34
+ ## Quick Start
35
+
36
+ ```python
37
+ import os
38
+
39
+ from hot import HotClient
40
+
41
+ hot = HotClient(token=os.environ["HOT_API_KEY"])
42
+
43
+ # base_url defaults to https://api.hot.dev.
44
+ # For local development with `hot dev`, pass base_url="http://localhost:4681".
45
+
46
+ for event in hot.streams.subscribe_with_event(
47
+ {
48
+ "event_type": "team-agent:ask",
49
+ "event_data": {
50
+ "session_id": "web:chat:demo",
51
+ "user_id": "web:user:demo",
52
+ "user_name": "Demo User",
53
+ "question": "what is blocking launch?",
54
+ },
55
+ }
56
+ ):
57
+ if event["type"] == "stream:data":
58
+ print(event["data_type"], event.get("payload"))
59
+
60
+ if event["type"] == "run:stop":
61
+ print(event.get("run", {}).get("result"))
62
+ break
63
+ ```
64
+
65
+ The client closes its underlying HTTP connection cleanly when used as a context
66
+ manager:
67
+
68
+ ```python
69
+ with HotClient(token=os.environ["HOT_API_KEY"]) as hot:
70
+ event = hot.events.publish(
71
+ {
72
+ "event_type": "team-agent:ask",
73
+ "event_data": {"question": "what changed?"},
74
+ }
75
+ )
76
+ print(event["stream_id"])
77
+ ```
78
+
79
+ Authenticated clients should run server-side. Browser apps and public notebooks
80
+ should call your own backend route instead of exposing a Hot API key.
81
+
82
+ ## Async Usage
83
+
84
+ ```python
85
+ import os
86
+
87
+ from hot import AsyncHotClient
88
+
89
+ async with AsyncHotClient(token=os.environ["HOT_API_KEY"]) as hot:
90
+ event = await hot.events.publish(
91
+ {
92
+ "event_type": "team-agent:ask",
93
+ "event_data": {"question": "what changed?"},
94
+ }
95
+ )
96
+ print(event["stream_id"])
97
+ ```
98
+
99
+ Async streaming is supported the same way:
100
+
101
+ ```python
102
+ async with AsyncHotClient(token=os.environ["HOT_API_KEY"]) as hot:
103
+ async for event in hot.streams.subscribe_with_event(
104
+ {
105
+ "event_type": "team-agent:ask",
106
+ "event_data": {"question": "what changed?"},
107
+ }
108
+ ):
109
+ print(event["type"], event)
110
+ ```
111
+
112
+ ## Errors
113
+
114
+ Non-2xx API responses raise `HotApiError` with structured fields:
115
+
116
+ ```python
117
+ from hot import HotApiError
118
+
119
+ try:
120
+ hot.projects.get("missing-project")
121
+ except HotApiError as error:
122
+ print(error.status_code, error.code, error.request_id)
123
+ ```
124
+
125
+ ## Resources
126
+
127
+ `HotClient` mirrors the Hot API v1 resources:
128
+
129
+ - `hot.events` — publish, list, get, and inspect event runs
130
+ - `hot.streams` — subscribe to run streams and publish events atomically (reconnects automatically across the 5-minute SSE timeout; pass `reconnect=False` to opt out)
131
+ - `hot.runs` — list, inspect, and view run stats
132
+ - `hot.files` — upload, download, list, and delete files (including multipart uploads)
133
+ - `hot.projects` — create, list, update, activate, deactivate, and delete projects
134
+ - `hot.builds` — upload, download, deploy, and look up live/deployed builds
135
+ - `hot.context` — manage encrypted project context variables
136
+ - `hot.domains` — register, verify, list, and delete custom domains
137
+ - `hot.sessions` — create and revoke scoped sessions
138
+ - `hot.service_keys` — create and revoke scoped service keys
139
+ - `hot.org` — view usage and limits
140
+ - `hot.env` — read environment info and subscribe to environment events
141
+
142
+ Use `hot.request(...)` or `hot.request_raw(...)` as an escape hatch for API
143
+ endpoints that do not yet have a resource helper.
144
+
145
+ ## Customizing the HTTP Client
146
+
147
+ `HotClient` and `AsyncHotClient` accept an `httpx.Client` (or
148
+ `httpx.AsyncClient`) via the `client=` argument. Use this to configure retries,
149
+ proxies, or custom transports:
150
+
151
+ ```python
152
+ import httpx
153
+
154
+ from hot import HotClient
155
+
156
+ http_client = httpx.Client(
157
+ timeout=httpx.Timeout(connect=5.0, read=60.0, write=30.0, pool=5.0),
158
+ transport=httpx.HTTPTransport(retries=3),
159
+ )
160
+
161
+ hot = HotClient(token=os.environ["HOT_API_KEY"], client=http_client)
162
+ ```
163
+
164
+ When you pass your own client, the SDK does not close it on exit.
165
+
166
+ ## Casing Policy
167
+
168
+ Core API request and response payloads use the Hot API wire format:
169
+ `event_type`, `event_data`, `stream_id`, and so on. SDK-only options use Python
170
+ style names such as `base_url` and `timeout`.
171
+
172
+ The SDK never transforms user-owned payloads such as `event_data`.
173
+
174
+ ## Type Hints
175
+
176
+ The package ships with `py.typed`, so editors and type checkers will pick up
177
+ the public API. Request and response payloads are currently typed as plain
178
+ `dict[str, Any]` — keys follow the Hot API wire format documented above. Strict
179
+ `TypedDict` shapes generated from the Hot API OpenAPI spec are planned for a
180
+ future release.
181
+
182
+ ## Local Development
183
+
184
+ ```bash
185
+ python -m venv .venv
186
+ source .venv/bin/activate
187
+ python -m pip install -e ".[dev]"
188
+ ruff check .
189
+ pytest
190
+ python -m build
191
+ ```
192
+
193
+ ## Related
194
+
195
+ - [Hot Dev documentation](https://hot.dev/docs)
196
+ - [Python SDK docs](https://hot.dev/docs/api/python)
197
+ - [JavaScript / TypeScript SDK](https://www.npmjs.com/package/@hot-dev/sdk)
198
+ - [Hot Chat demo](https://github.com/hot-dev/hot-demos/tree/main/hot-chat)
199
+
200
+ ## License
201
+
202
+ Apache-2.0