submilli 0.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,17 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.pyc
4
+ .pytest_cache/
5
+ .mypy_cache/
6
+ .ruff_cache/
7
+ dist/
8
+ build/
9
+ *.egg-info/
10
+ .submilli-bin/
11
+
12
+ # Local only: model and service keys, the test server's home and token
13
+ .env
14
+ .submilli-test/
15
+ .submilli-test.log
16
+ .submilli-token
17
+ .benchmarks/
@@ -0,0 +1,30 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are recorded here. The format follows
4
+ [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses
5
+ [Semantic Versioning](https://semver.org/).
6
+
7
+ ## [Unreleased]
8
+
9
+ ## [0.1.0] - 2026-10-15
10
+
11
+ First release, for submilli-server 0.4.1.
12
+
13
+ ### Added
14
+
15
+ - `Submilli` and `AsyncSubmilli`, the same API, blocking and asyncio. The sync
16
+ client is generated from the async one.
17
+ - Sessions: `create` (with variables, harness secrets, and application tools),
18
+ `execute`, `run`, `rebind`, `last_run`, `delete`, and session-scoped Package
19
+ search and docs.
20
+ - Application tools: `runs.resume`, `runs.retrieve`, and `runs.complete`,
21
+ which answers a run's calls with a callback until it finishes.
22
+ `sessions.run` does the same from the first execute.
23
+ - Blueprint discovery: `prompt`, `search_packages`, `package_docs`,
24
+ `builtins`, and `builtin_docs`.
25
+ - One-off runs: `execute`.
26
+ - Typed results (`ExecuteResult`, `SuspendedRun`, `RunningRun`, `RunError`) and
27
+ typed errors for each refusal a caller can act on.
28
+ - `idempotency_key()`, which turns any call id into a valid `Idempotency-Key`.
29
+ - `submilli.schema.inline_refs`, for declaring tools from Pydantic schemas.
30
+ - Retries with backoff, only for requests that are safe to repeat.
submilli-0.1.0/LICENSE ADDED
@@ -0,0 +1,201 @@
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 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
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,228 @@
1
+ Metadata-Version: 2.5
2
+ Name: submilli
3
+ Version: 0.1.0
4
+ Summary: The Python SDK for submilli-server: run TypeScript programs under a Blueprint's policy, from any Python harness.
5
+ Project-URL: Homepage, https://github.com/submilli/submilli-python/tree/main/packages/submilli
6
+ Project-URL: Documentation, https://github.com/submilli/submilli-python/tree/main/packages/submilli#readme
7
+ Project-URL: Source, https://github.com/submilli/submilli-python
8
+ Project-URL: Changelog, https://github.com/submilli/submilli-python/blob/main/packages/submilli/CHANGELOG.md
9
+ Project-URL: HTTP API, https://submilli.ai/docs/reference/http-api
10
+ Author: Submilli
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ Keywords: agents,code-mode,llm,sandbox,sdk,submilli
14
+ Classifier: Development Status :: 3 - Alpha
15
+ Classifier: Framework :: AsyncIO
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3 :: Only
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Programming Language :: Python :: 3.14
24
+ Classifier: Typing :: Typed
25
+ Requires-Python: >=3.11
26
+ Requires-Dist: httpx<1,>=0.27
27
+ Description-Content-Type: text/markdown
28
+
29
+ # submilli
30
+
31
+ The Python SDK for [submilli-server](https://github.com/submilli/submilli-runtime). It runs
32
+ TypeScript programs under a Blueprint's policy, on behalf of a user, from any Python harness:
33
+ an agent framework, a job queue, or a script.
34
+
35
+ ```sh
36
+ pip install submilli
37
+ ```
38
+
39
+ It needs Python 3.11 or later and submilli-server 0.4.1 or later. For LangChain and
40
+ deepagents, [`langchain-submilli`](https://github.com/submilli/submilli-python/tree/main/packages/langchain-submilli)
41
+ builds on it.
42
+
43
+ ## Quick start
44
+
45
+ ```python
46
+ import asyncio
47
+
48
+ from submilli import AsyncSubmilli
49
+
50
+ PROGRAM = """
51
+ export function main(): string {
52
+ return `${1 + 1}`;
53
+ }
54
+ """
55
+
56
+
57
+ async def main() -> None:
58
+ async with AsyncSubmilli() as client:
59
+ session = await client.sessions.create("research", variables={"userId": "u_ada"})
60
+ result = await client.sessions.run(session.id, PROGRAM, idempotency_key="call-1")
61
+ print(result.result) # "2"
62
+
63
+
64
+ asyncio.run(main())
65
+ ```
66
+
67
+ `Submilli` has the same API without `await`:
68
+
69
+ ```python
70
+ from submilli import Submilli
71
+
72
+ with Submilli() as client:
73
+ session = client.sessions.create("research", variables={"userId": "u_ada"})
74
+ print(client.sessions.run(session.id, PROGRAM).result)
75
+ ```
76
+
77
+ The client reads the server's URL from `$SUBMILLI_SERVER` (default `http://127.0.0.1:8128`) and
78
+ its API token from `$SUBMILLI_SERVER_TOKEN`, or from `base_url=` and `token=`.
79
+
80
+ ## Sessions
81
+
82
+ A session binds a Blueprint to one user's variables and harness secrets. Programs in it run one
83
+ after another and share its files.
84
+
85
+ ```python
86
+ session = await client.sessions.create(
87
+ "research",
88
+ variables={"userId": "u_ada"},
89
+ secrets={"GITHUB_TOKEN": token}, # the Blueprint's `harness` secrets
90
+ )
91
+ state = await client.sessions.execute(session.id, code, idempotency_key=call_id)
92
+ await client.sessions.rebind(session.id, {"GITHUB_TOKEN": new_token})
93
+ last = await client.sessions.last_run(session.id) # the full console, or None
94
+ await client.sessions.delete(session.id)
95
+ ```
96
+
97
+ **Results, not exceptions.** A program that fails or is denied is a result:
98
+
99
+ ```python
100
+ result = await client.sessions.run(session.id, code)
101
+ if result.denied:
102
+ print(result.error.capability, result.error.source) # e.g. "http.get", "policy"
103
+ elif result.error:
104
+ print(result.error.kind, result.error.message) # e.g. "compile_error"
105
+ else:
106
+ print(result.result, result.console)
107
+ ```
108
+
109
+ **Idempotency.** Pass an `idempotency_key` with every execute that may be retried. When the
110
+ same request reaches the server twice, the program runs once and the retry gets the recorded
111
+ result. `idempotency_key(call_id)` turns any id, such as a model's tool call id, into a key the
112
+ server accepts.
113
+
114
+ ## Your tools in programs
115
+
116
+ A session can declare the application's own tools. Programs import them as `@tools`, typed from
117
+ their schemas, and the server checks each call against the Blueprint's `tools.call` capability:
118
+
119
+ ```python
120
+ from submilli import PendingCall, ToolResult
121
+
122
+ QUERY_ORDERS = {
123
+ "name": "query_orders",
124
+ "description": "Orders of one customer.",
125
+ "input_schema": {"type": "object", "properties": {"customer": {"type": "string"}}, "required": ["customer"]},
126
+ "output_schema": {"type": "object", "properties": {"count": {"type": "number"}}, "required": ["count"]},
127
+ }
128
+
129
+
130
+ async def answer(call: PendingCall) -> ToolResult:
131
+ orders = await db.orders(call.args["customer"])
132
+ return ToolResult.success(call.call_id, {"count": len(orders)})
133
+
134
+
135
+ session = await client.sessions.create("shop", variables={"userId": "u_ada"}, tools=[QUERY_ORDERS])
136
+ result = await client.sessions.run(session.id, PROGRAM, idempotency_key="call-1", on_tool_call=answer)
137
+ ```
138
+
139
+ ```ts
140
+ import tools from "@tools";
141
+
142
+ function main(): string {
143
+ return `${tools.query_orders({ customer: "c_42" }).count} orders`;
144
+ }
145
+ ```
146
+
147
+ - **The loop.** Each call stops the run on the server. `sessions.run` hands the call to
148
+ `on_tool_call`, sync or async, and resumes the run with the answer, until the program finishes.
149
+ The time a run waits doesn't count against its time limit.
150
+ - **Answers.** `ToolResult.success(call_id, value)` returns `value` to the program.
151
+ `ToolResult.failed(call_id, message)` throws `Error` there. `ToolResult.denied(call_id,
152
+ message)` throws `PermissionDeniedError`, reported with `source: "harness"`.
153
+ - **Pausing.** If `on_tool_call` raises, the exception propagates and the run keeps waiting on the
154
+ server, up to the Blueprint's `tool_call_timeout`. That is how a harness pauses for a person's
155
+ approval. Executing again with the same `idempotency_key` answers the run's current state, and
156
+ `sessions.run` carries on from the call it waits on.
157
+ - **Declarations.** `session.warnings` lists what programs won't see of the declared tools, such
158
+ as a Blueprint that grants no `tools.call`, or a tool whose result is typed `unknown`. The
159
+ server doesn't resolve `$ref`, so pass Pydantic schemas through `submilli.schema.inline_refs`.
160
+ - **Lower level.** `runs.resume`, `runs.retrieve`, and `runs.complete` drive a run yourself.
161
+ - **Restarts.** A suspended run is lost if the server restarts, and resuming it raises
162
+ `UnknownRunError`.
163
+
164
+ ## Discovery
165
+
166
+ What a model needs to write programs for a Blueprint:
167
+
168
+ ```python
169
+ prompt = await client.blueprints.prompt("research") # tool descriptions for a model
170
+ await client.blueprints.search_packages("research", "github")
171
+ docs = await client.blueprints.package_docs("research", "@submilli/jina") # docs.found, docs.text
172
+ await client.blueprints.builtins("research")
173
+ await client.blueprints.builtin_docs("research", ["Map", "Temporal"])
174
+ ```
175
+
176
+ `sessions.search_packages` and `sessions.package_docs` answer the same for one session, including
177
+ its `@tools`.
178
+
179
+ ## Errors
180
+
181
+ Every error is a `SubmilliError`:
182
+
183
+ | Error | When |
184
+ | --- | --- |
185
+ | `APIConnectionError`, `APITimeoutError` | The server couldn't be reached, or didn't answer in time |
186
+ | `AuthenticationError` | 401: the token is missing or wrong |
187
+ | `UnknownSessionError` | The session ended, usually after its idle timeout. Open a new one |
188
+ | `SessionRequiresSecretsError` | The server asks for the session's harness secrets again. `rebind` them; `.required` names them |
189
+ | `IdempotencyError` | The server refused the key and ran nothing. `.code` says why |
190
+ | `UnknownRunError` | The server no longer holds a suspended run |
191
+ | `RunNotSuspendedError`, `UnknownCallError` | A resume that no longer applies. `runs.complete` handles these |
192
+ | `UnknownBlueprintError` | No Blueprint of that name |
193
+ | `BadRequestError`, `ForbiddenError`, `NotFoundError`, `ConflictError`, `ServiceUnavailableError`, `InternalServerError` | Other refusals, by status |
194
+
195
+ Each `APIStatusError` carries `status_code`, `body`, the body's `code`, and the `execution_id`
196
+ it concerns, when there is one.
197
+
198
+ Harness secrets are kept encrypted with the server's secret-store key, so sessions keep them
199
+ across restarts. A server whose key changed refuses such a session with a `ConflictError`
200
+ ("cannot decrypt session secrets").
201
+
202
+ ## Retries and timeouts
203
+
204
+ A connection failure, or a 502, 503, or 504, is retried up to `max_retries` times (default 2),
205
+ with backoff, but only for requests that are safe to repeat: reads, deletes, rebinds, resumes,
206
+ and executes that carry an idempotency key. An execute without a key and `sessions.create` are
207
+ never retried. The default timeout is 330 seconds, because an execute may wait up to 300 seconds
208
+ for an earlier attempt with the same key.
209
+
210
+ ```python
211
+ client = AsyncSubmilli(timeout=60.0, max_retries=0, http_client=httpx.AsyncClient(...))
212
+ ```
213
+
214
+ ## Development
215
+
216
+ This package lives in the [submilli-python](https://github.com/submilli/submilli-python)
217
+ workspace, next to `langchain-submilli`. See the repository's README for setup, checks, and
218
+ releases. In `packages/submilli`:
219
+
220
+ ```sh
221
+ uv run pytest # unit tests, against a fake of the HTTP API
222
+ SUBMILLI_BIN=/path/to/bin uv run pytest tests/integration # starts its own submilli-server
223
+ uv run python scripts/generate_sync.py # after changing _async_client.py
224
+ ```
225
+
226
+ ## License
227
+
228
+ Apache-2.0.
@@ -0,0 +1,200 @@
1
+ # submilli
2
+
3
+ The Python SDK for [submilli-server](https://github.com/submilli/submilli-runtime). It runs
4
+ TypeScript programs under a Blueprint's policy, on behalf of a user, from any Python harness:
5
+ an agent framework, a job queue, or a script.
6
+
7
+ ```sh
8
+ pip install submilli
9
+ ```
10
+
11
+ It needs Python 3.11 or later and submilli-server 0.4.1 or later. For LangChain and
12
+ deepagents, [`langchain-submilli`](https://github.com/submilli/submilli-python/tree/main/packages/langchain-submilli)
13
+ builds on it.
14
+
15
+ ## Quick start
16
+
17
+ ```python
18
+ import asyncio
19
+
20
+ from submilli import AsyncSubmilli
21
+
22
+ PROGRAM = """
23
+ export function main(): string {
24
+ return `${1 + 1}`;
25
+ }
26
+ """
27
+
28
+
29
+ async def main() -> None:
30
+ async with AsyncSubmilli() as client:
31
+ session = await client.sessions.create("research", variables={"userId": "u_ada"})
32
+ result = await client.sessions.run(session.id, PROGRAM, idempotency_key="call-1")
33
+ print(result.result) # "2"
34
+
35
+
36
+ asyncio.run(main())
37
+ ```
38
+
39
+ `Submilli` has the same API without `await`:
40
+
41
+ ```python
42
+ from submilli import Submilli
43
+
44
+ with Submilli() as client:
45
+ session = client.sessions.create("research", variables={"userId": "u_ada"})
46
+ print(client.sessions.run(session.id, PROGRAM).result)
47
+ ```
48
+
49
+ The client reads the server's URL from `$SUBMILLI_SERVER` (default `http://127.0.0.1:8128`) and
50
+ its API token from `$SUBMILLI_SERVER_TOKEN`, or from `base_url=` and `token=`.
51
+
52
+ ## Sessions
53
+
54
+ A session binds a Blueprint to one user's variables and harness secrets. Programs in it run one
55
+ after another and share its files.
56
+
57
+ ```python
58
+ session = await client.sessions.create(
59
+ "research",
60
+ variables={"userId": "u_ada"},
61
+ secrets={"GITHUB_TOKEN": token}, # the Blueprint's `harness` secrets
62
+ )
63
+ state = await client.sessions.execute(session.id, code, idempotency_key=call_id)
64
+ await client.sessions.rebind(session.id, {"GITHUB_TOKEN": new_token})
65
+ last = await client.sessions.last_run(session.id) # the full console, or None
66
+ await client.sessions.delete(session.id)
67
+ ```
68
+
69
+ **Results, not exceptions.** A program that fails or is denied is a result:
70
+
71
+ ```python
72
+ result = await client.sessions.run(session.id, code)
73
+ if result.denied:
74
+ print(result.error.capability, result.error.source) # e.g. "http.get", "policy"
75
+ elif result.error:
76
+ print(result.error.kind, result.error.message) # e.g. "compile_error"
77
+ else:
78
+ print(result.result, result.console)
79
+ ```
80
+
81
+ **Idempotency.** Pass an `idempotency_key` with every execute that may be retried. When the
82
+ same request reaches the server twice, the program runs once and the retry gets the recorded
83
+ result. `idempotency_key(call_id)` turns any id, such as a model's tool call id, into a key the
84
+ server accepts.
85
+
86
+ ## Your tools in programs
87
+
88
+ A session can declare the application's own tools. Programs import them as `@tools`, typed from
89
+ their schemas, and the server checks each call against the Blueprint's `tools.call` capability:
90
+
91
+ ```python
92
+ from submilli import PendingCall, ToolResult
93
+
94
+ QUERY_ORDERS = {
95
+ "name": "query_orders",
96
+ "description": "Orders of one customer.",
97
+ "input_schema": {"type": "object", "properties": {"customer": {"type": "string"}}, "required": ["customer"]},
98
+ "output_schema": {"type": "object", "properties": {"count": {"type": "number"}}, "required": ["count"]},
99
+ }
100
+
101
+
102
+ async def answer(call: PendingCall) -> ToolResult:
103
+ orders = await db.orders(call.args["customer"])
104
+ return ToolResult.success(call.call_id, {"count": len(orders)})
105
+
106
+
107
+ session = await client.sessions.create("shop", variables={"userId": "u_ada"}, tools=[QUERY_ORDERS])
108
+ result = await client.sessions.run(session.id, PROGRAM, idempotency_key="call-1", on_tool_call=answer)
109
+ ```
110
+
111
+ ```ts
112
+ import tools from "@tools";
113
+
114
+ function main(): string {
115
+ return `${tools.query_orders({ customer: "c_42" }).count} orders`;
116
+ }
117
+ ```
118
+
119
+ - **The loop.** Each call stops the run on the server. `sessions.run` hands the call to
120
+ `on_tool_call`, sync or async, and resumes the run with the answer, until the program finishes.
121
+ The time a run waits doesn't count against its time limit.
122
+ - **Answers.** `ToolResult.success(call_id, value)` returns `value` to the program.
123
+ `ToolResult.failed(call_id, message)` throws `Error` there. `ToolResult.denied(call_id,
124
+ message)` throws `PermissionDeniedError`, reported with `source: "harness"`.
125
+ - **Pausing.** If `on_tool_call` raises, the exception propagates and the run keeps waiting on the
126
+ server, up to the Blueprint's `tool_call_timeout`. That is how a harness pauses for a person's
127
+ approval. Executing again with the same `idempotency_key` answers the run's current state, and
128
+ `sessions.run` carries on from the call it waits on.
129
+ - **Declarations.** `session.warnings` lists what programs won't see of the declared tools, such
130
+ as a Blueprint that grants no `tools.call`, or a tool whose result is typed `unknown`. The
131
+ server doesn't resolve `$ref`, so pass Pydantic schemas through `submilli.schema.inline_refs`.
132
+ - **Lower level.** `runs.resume`, `runs.retrieve`, and `runs.complete` drive a run yourself.
133
+ - **Restarts.** A suspended run is lost if the server restarts, and resuming it raises
134
+ `UnknownRunError`.
135
+
136
+ ## Discovery
137
+
138
+ What a model needs to write programs for a Blueprint:
139
+
140
+ ```python
141
+ prompt = await client.blueprints.prompt("research") # tool descriptions for a model
142
+ await client.blueprints.search_packages("research", "github")
143
+ docs = await client.blueprints.package_docs("research", "@submilli/jina") # docs.found, docs.text
144
+ await client.blueprints.builtins("research")
145
+ await client.blueprints.builtin_docs("research", ["Map", "Temporal"])
146
+ ```
147
+
148
+ `sessions.search_packages` and `sessions.package_docs` answer the same for one session, including
149
+ its `@tools`.
150
+
151
+ ## Errors
152
+
153
+ Every error is a `SubmilliError`:
154
+
155
+ | Error | When |
156
+ | --- | --- |
157
+ | `APIConnectionError`, `APITimeoutError` | The server couldn't be reached, or didn't answer in time |
158
+ | `AuthenticationError` | 401: the token is missing or wrong |
159
+ | `UnknownSessionError` | The session ended, usually after its idle timeout. Open a new one |
160
+ | `SessionRequiresSecretsError` | The server asks for the session's harness secrets again. `rebind` them; `.required` names them |
161
+ | `IdempotencyError` | The server refused the key and ran nothing. `.code` says why |
162
+ | `UnknownRunError` | The server no longer holds a suspended run |
163
+ | `RunNotSuspendedError`, `UnknownCallError` | A resume that no longer applies. `runs.complete` handles these |
164
+ | `UnknownBlueprintError` | No Blueprint of that name |
165
+ | `BadRequestError`, `ForbiddenError`, `NotFoundError`, `ConflictError`, `ServiceUnavailableError`, `InternalServerError` | Other refusals, by status |
166
+
167
+ Each `APIStatusError` carries `status_code`, `body`, the body's `code`, and the `execution_id`
168
+ it concerns, when there is one.
169
+
170
+ Harness secrets are kept encrypted with the server's secret-store key, so sessions keep them
171
+ across restarts. A server whose key changed refuses such a session with a `ConflictError`
172
+ ("cannot decrypt session secrets").
173
+
174
+ ## Retries and timeouts
175
+
176
+ A connection failure, or a 502, 503, or 504, is retried up to `max_retries` times (default 2),
177
+ with backoff, but only for requests that are safe to repeat: reads, deletes, rebinds, resumes,
178
+ and executes that carry an idempotency key. An execute without a key and `sessions.create` are
179
+ never retried. The default timeout is 330 seconds, because an execute may wait up to 300 seconds
180
+ for an earlier attempt with the same key.
181
+
182
+ ```python
183
+ client = AsyncSubmilli(timeout=60.0, max_retries=0, http_client=httpx.AsyncClient(...))
184
+ ```
185
+
186
+ ## Development
187
+
188
+ This package lives in the [submilli-python](https://github.com/submilli/submilli-python)
189
+ workspace, next to `langchain-submilli`. See the repository's README for setup, checks, and
190
+ releases. In `packages/submilli`:
191
+
192
+ ```sh
193
+ uv run pytest # unit tests, against a fake of the HTTP API
194
+ SUBMILLI_BIN=/path/to/bin uv run pytest tests/integration # starts its own submilli-server
195
+ uv run python scripts/generate_sync.py # after changing _async_client.py
196
+ ```
197
+
198
+ ## License
199
+
200
+ Apache-2.0.