satay 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.
Files changed (57) hide show
  1. satay-0.1.0/.gitignore +47 -0
  2. satay-0.1.0/LICENSE +202 -0
  3. satay-0.1.0/PKG-INFO +168 -0
  4. satay-0.1.0/README.md +143 -0
  5. satay-0.1.0/pyproject.toml +131 -0
  6. satay-0.1.0/src/satay/__init__.py +112 -0
  7. satay-0.1.0/src/satay/_studio_assets/assets/index-BhyW4Wc4.js +10 -0
  8. satay-0.1.0/src/satay/_studio_assets/assets/index-vwLg8ReS.css +1 -0
  9. satay-0.1.0/src/satay/_studio_assets/index.html +13 -0
  10. satay-0.1.0/src/satay/api/__init__.py +38 -0
  11. satay-0.1.0/src/satay/api/app.py +138 -0
  12. satay-0.1.0/src/satay/api/context.py +138 -0
  13. satay-0.1.0/src/satay/api/decorators.py +101 -0
  14. satay-0.1.0/src/satay/api/fork.py +239 -0
  15. satay-0.1.0/src/satay/api/primitives.py +281 -0
  16. satay-0.1.0/src/satay/api/registry.py +94 -0
  17. satay-0.1.0/src/satay/api/run_handle.py +167 -0
  18. satay-0.1.0/src/satay/api/runner.py +268 -0
  19. satay-0.1.0/src/satay/blobs/__init__.py +173 -0
  20. satay-0.1.0/src/satay/cli/__init__.py +13 -0
  21. satay-0.1.0/src/satay/cli/main.py +132 -0
  22. satay-0.1.0/src/satay/config.py +275 -0
  23. satay-0.1.0/src/satay/control/__init__.py +120 -0
  24. satay-0.1.0/src/satay/control/api.py +145 -0
  25. satay-0.1.0/src/satay/control/commands.py +559 -0
  26. satay-0.1.0/src/satay/control/redaction.py +33 -0
  27. satay-0.1.0/src/satay/control/security.py +128 -0
  28. satay-0.1.0/src/satay/control/server.py +210 -0
  29. satay-0.1.0/src/satay/control/views.py +504 -0
  30. satay-0.1.0/src/satay/demo.py +489 -0
  31. satay-0.1.0/src/satay/devstack/__init__.py +32 -0
  32. satay-0.1.0/src/satay/devstack/appload.py +226 -0
  33. satay-0.1.0/src/satay/devstack/cli.py +87 -0
  34. satay-0.1.0/src/satay/devstack/lock.py +128 -0
  35. satay-0.1.0/src/satay/devstack/orchestrator.py +307 -0
  36. satay-0.1.0/src/satay/executor/__init__.py +259 -0
  37. satay-0.1.0/src/satay/journal/__init__.py +121 -0
  38. satay-0.1.0/src/satay/journal/codec.py +567 -0
  39. satay-0.1.0/src/satay/journal/events.py +182 -0
  40. satay-0.1.0/src/satay/journal/store.py +557 -0
  41. satay-0.1.0/src/satay/journal/timeline.py +109 -0
  42. satay-0.1.0/src/satay/py.typed +0 -0
  43. satay-0.1.0/src/satay/redaction.py +162 -0
  44. satay-0.1.0/src/satay/replay/__init__.py +33 -0
  45. satay-0.1.0/src/satay/replay/driver.py +76 -0
  46. satay-0.1.0/src/satay/replay/engine.py +1115 -0
  47. satay-0.1.0/src/satay/replay/failures.py +53 -0
  48. satay-0.1.0/src/satay/replay/identity.py +132 -0
  49. satay-0.1.0/src/satay/replay/nondeterminism.py +61 -0
  50. satay-0.1.0/src/satay/testing/__init__.py +38 -0
  51. satay-0.1.0/src/satay/testing/clock.py +104 -0
  52. satay-0.1.0/src/satay/testing/faults.py +81 -0
  53. satay-0.1.0/src/satay/testing/fixtures.py +82 -0
  54. satay-0.1.0/src/satay/testing/rng.py +60 -0
  55. satay-0.1.0/src/satay/testing/settle.py +98 -0
  56. satay-0.1.0/src/satay/timers/__init__.py +364 -0
  57. satay-0.1.0/src/satay/versioning/__init__.py +160 -0
satay-0.1.0/.gitignore ADDED
@@ -0,0 +1,47 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ build/
6
+ dist/
7
+
8
+ # Environments
9
+ .venv/
10
+ venv/
11
+
12
+ # Tooling caches
13
+ .mypy_cache/
14
+ .pytest_cache/
15
+ .ruff_cache/
16
+
17
+ # Coverage
18
+ .coverage
19
+ .coverage.*
20
+ htmlcov/
21
+ coverage.xml
22
+
23
+ # Satay project-local data dir (ADR-0017), and the one `make demo` writes to
24
+ .satay/
25
+ .satay-demo/
26
+
27
+ # Agent worktrees land in .claude/worktrees/ and must never be committed.
28
+ .claude/
29
+
30
+ # Scratch space for throwaway working files. Nothing in the build references it,
31
+ # and an unignored scratch dir is a well-worn route for stray output — or a
32
+ # credential pasted somewhere "temporary" — to reach a commit.
33
+ scratchpad/
34
+
35
+ # Studio frontend (ADR-0013/0018): source lives in studio/; the built bundle is
36
+ # vendored to src/satay/_studio_assets/ and IS committed (served by the V5 process).
37
+ studio/node_modules/
38
+ studio/dist/
39
+ studio/.svelte-kit/
40
+ studio/*.tsbuildinfo
41
+ studio/vite.config.ts.timestamp-*
42
+
43
+ # Editor / OS
44
+ .DS_Store
45
+ *.swp
46
+ .idea/
47
+ .vscode/
satay-0.1.0/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 The Satay Runtime Authors
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
satay-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,168 @@
1
+ Metadata-Version: 2.5
2
+ Name: satay
3
+ Version: 0.1.0
4
+ Summary: Satay Runtime — a local-first durable-execution runtime for async Python workflows.
5
+ Project-URL: Homepage, https://github.com/leejianrong/satay-runtime
6
+ Project-URL: Repository, https://github.com/leejianrong/satay-runtime
7
+ Author-email: Jian <leejianrong2@gmail.com>
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ Keywords: asyncio,durable-execution,event-sourcing,replay,workflow
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
17
+ Classifier: Typing :: Typed
18
+ Requires-Python: >=3.12
19
+ Provides-Extra: studio
20
+ Requires-Dist: fastapi>=0.110; extra == 'studio'
21
+ Requires-Dist: pydantic>=2.6; extra == 'studio'
22
+ Requires-Dist: typer>=0.12; extra == 'studio'
23
+ Requires-Dist: uvicorn>=0.29; extra == 'studio'
24
+ Description-Content-Type: text/markdown
25
+
26
+ # Satay Runtime
27
+
28
+ Satay is a **local-first durable-execution runtime** for async Python. You write
29
+ ordinary `async def` workflows and tasks; Satay records every durable call to an
30
+ append-only journal and, on crash, **replays the workflow from the top** — reusing
31
+ recorded results and re-executing only what never finished. No external
32
+ infrastructure: it runs in one process over SQLite.
33
+
34
+ ```python
35
+ import satay
36
+
37
+ @satay.task()
38
+ async def charge(amount: int) -> str: ...
39
+
40
+ @satay.workflow
41
+ async def checkout(order):
42
+ receipt = await charge(order["total"])
43
+ return receipt
44
+ ```
45
+
46
+ The debugger — **Satay Studio**, a local web UI over an HTTP read API — ships in the
47
+ optional `satay[studio]` extra, so applications that embed Satay never carry the
48
+ FastAPI/uvicorn/JS stack into production.
49
+
50
+ **Documentation: [leejianrong.github.io/satay-runtime](https://leejianrong.github.io/satay-runtime/)**
51
+ — the tutorial, the cookbook, the Studio guide, and the honest account of what the runtime
52
+ does not do.
53
+
54
+ ## Status
55
+
56
+ **The MVP is built and the full suite is green (V1–V8).** Trust the code over the docs:
57
+ `docs/` describes the intended full system, and where docs and code disagree the code
58
+ wins. `uv run pytest -q` prints the current test count.
59
+
60
+ What works today:
61
+
62
+ - **Durable core + replay.** Workflows replay from the top against an append-only
63
+ SQLite journal (`PRAGMA user_version` schema, forward-only migrations, WAL); recorded
64
+ results are reused and only unfinished work re-executes.
65
+ - **Execution guarantees.** Retries with capped exponential backoff and jittered delays
66
+ off an injected clock, at-least-once task execution, runtime-derived idempotency keys
67
+ readable inside a task body, replay nondeterminism detection (strict by default — a
68
+ divergent replay raises rather than returning a plausible wrong answer), and a separate
69
+ `effect_safety` policy that guards retryable side-effecting tasks.
70
+ - **Time and events.** Durable `sleep`, `wait_for_event`/`send_event` over a persistent
71
+ inbox, and a timer + event poll loop with FIFO delivery and event-wins-over-timeout.
72
+ `async with satay.run_app() as store:` gives a plain script that loop — journal open,
73
+ worker running, both torn down on exit — with no `satay dev` and no optional extra.
74
+ - **Composition.** `map`, `gather`, and `start_child`, each item a keyed durable call, so
75
+ a crash mid-fan-out resumes with completed items reused and only unresolved items re-run.
76
+ - **Control plane.** An HTTP control + read API (start, cancel, send event, fork; run
77
+ list, timeline, tree, task detail, compare) with a redactor applied to every read and a
78
+ loopback/token security guard.
79
+ - **Studio.** The Satay Studio SPA ships as a built bundle served by the same process.
80
+ - **Forking and versioning.** Fork a run from a prefix, compare two runs call-by-call, and
81
+ a code-version stamp with a strict/warn/off mismatch policy on resume.
82
+ - **`satay dev`.** One command brings up the lock, store, worker, and Studio server, and
83
+ tears them down in reverse.
84
+ - **Payload spill.** Encoded payloads over 256 KiB spill to content-addressed blob files
85
+ transparently on write and rehydrate on read.
86
+
87
+ Deliberate MVP gaps, so the honesty survives contact:
88
+
89
+ - **No blob GC.** No run deletion and no compaction; blobs accumulate under `./.satay/`
90
+ and removal is manual (ADR-0004). A future GC has to be reference-aware, since forks
91
+ share blobs with their source run.
92
+ - **Fan-out is fail-fast only.** No collect / `return_exceptions` mode for
93
+ `map`/`gather`/`start_child`; the first failure raises and sibling results are discarded
94
+ (ADR-0020).
95
+ - **`satay runs show` is frozen at the V1 event subset** (ADR-0016). Timer, event,
96
+ cancellation, and fork events render as bare type lines; Studio covers the rest.
97
+ - **Fork only accepts terminal runs** (ADR-0004) — completed, failed, or cancelled.
98
+ - **One process, one writer.** No PostgreSQL backend, no multi-worker or distributed
99
+ execution. The cross-process data-dir lock is POSIX `flock` and only `satay dev` takes it.
100
+ - **Async only.** Sync (non-async) workflows and tasks are unsupported.
101
+ - **Nondeterminism detection is runtime-only** and compares the durable-call schedule,
102
+ not arguments; there is no static analysis of workflow bodies, and no automatic
103
+ migration of long-running workflows across code versions.
104
+ - **Windows is best-effort** and SQLite on network filesystems is unsupported (ADR-0019).
105
+
106
+ See `docs/` for the specs and `CLAUDE.md` for the build brief.
107
+
108
+ ## Requirements
109
+
110
+ - Python **3.12 or 3.13**
111
+ - [`uv`](https://docs.astral.sh/uv/) for environment and dependency management
112
+ - Linux/macOS first-class; Windows best-effort (SQLite on local disk only)
113
+
114
+ ## Dev quickstart
115
+
116
+ ```bash
117
+ uv sync # create the venv, install deps + dev group
118
+ uv run ruff check . # lint
119
+ uv run ruff format --check . # format check
120
+ uv run mypy src # type-check (strict)
121
+ uv run pytest tests/unit -q # unit tests
122
+ ```
123
+
124
+ The integration and e2e tests that cover Studio and the HTTP API need the `studio` extra;
125
+ without it they skip themselves and the reported count silently drops:
126
+
127
+ ```bash
128
+ uv sync --extra studio # then run the full suite
129
+ uv run pytest -q
130
+ ```
131
+
132
+ Or via the Makefile:
133
+
134
+ ```bash
135
+ make dev # uv sync
136
+ make check # ruff + mypy
137
+ make test # unit tests
138
+ make ci # everything CI runs
139
+ ```
140
+
141
+ Install the pre-push hook (runs the cheap gates before every push):
142
+
143
+ ```bash
144
+ make install-hooks # or: ./scripts/install-hooks.sh
145
+ ```
146
+
147
+ ## Layout
148
+
149
+ ```
150
+ src/satay/ runtime core (pure Python, near-zero dependencies)
151
+ api/ author decorators, primitives, run handle, TaskContext
152
+ replay/ replay engine, identity, nondeterminism
153
+ journal/ event model + Store seam + codec
154
+ executor/ TaskExecutor seam + LocalTaskExecutor
155
+ timers/ timer + event poll loop
156
+ control/ HTTP control + read API (satay[studio])
157
+ versioning/ code-version stamper
158
+ blobs/ payload spill
159
+ devstack/ `satay dev` orchestrator (satay[studio])
160
+ testing/ fault injection, manual clock, seeded RNG, fixtures
161
+ cli/ core argparse CLI (`satay runs show`)
162
+ tests/{unit,integration,e2e}/
163
+ docs/ specs + ADRs
164
+ ```
165
+
166
+ ## License
167
+
168
+ Apache-2.0. See [LICENSE](LICENSE).
satay-0.1.0/README.md ADDED
@@ -0,0 +1,143 @@
1
+ # Satay Runtime
2
+
3
+ Satay is a **local-first durable-execution runtime** for async Python. You write
4
+ ordinary `async def` workflows and tasks; Satay records every durable call to an
5
+ append-only journal and, on crash, **replays the workflow from the top** — reusing
6
+ recorded results and re-executing only what never finished. No external
7
+ infrastructure: it runs in one process over SQLite.
8
+
9
+ ```python
10
+ import satay
11
+
12
+ @satay.task()
13
+ async def charge(amount: int) -> str: ...
14
+
15
+ @satay.workflow
16
+ async def checkout(order):
17
+ receipt = await charge(order["total"])
18
+ return receipt
19
+ ```
20
+
21
+ The debugger — **Satay Studio**, a local web UI over an HTTP read API — ships in the
22
+ optional `satay[studio]` extra, so applications that embed Satay never carry the
23
+ FastAPI/uvicorn/JS stack into production.
24
+
25
+ **Documentation: [leejianrong.github.io/satay-runtime](https://leejianrong.github.io/satay-runtime/)**
26
+ — the tutorial, the cookbook, the Studio guide, and the honest account of what the runtime
27
+ does not do.
28
+
29
+ ## Status
30
+
31
+ **The MVP is built and the full suite is green (V1–V8).** Trust the code over the docs:
32
+ `docs/` describes the intended full system, and where docs and code disagree the code
33
+ wins. `uv run pytest -q` prints the current test count.
34
+
35
+ What works today:
36
+
37
+ - **Durable core + replay.** Workflows replay from the top against an append-only
38
+ SQLite journal (`PRAGMA user_version` schema, forward-only migrations, WAL); recorded
39
+ results are reused and only unfinished work re-executes.
40
+ - **Execution guarantees.** Retries with capped exponential backoff and jittered delays
41
+ off an injected clock, at-least-once task execution, runtime-derived idempotency keys
42
+ readable inside a task body, replay nondeterminism detection (strict by default — a
43
+ divergent replay raises rather than returning a plausible wrong answer), and a separate
44
+ `effect_safety` policy that guards retryable side-effecting tasks.
45
+ - **Time and events.** Durable `sleep`, `wait_for_event`/`send_event` over a persistent
46
+ inbox, and a timer + event poll loop with FIFO delivery and event-wins-over-timeout.
47
+ `async with satay.run_app() as store:` gives a plain script that loop — journal open,
48
+ worker running, both torn down on exit — with no `satay dev` and no optional extra.
49
+ - **Composition.** `map`, `gather`, and `start_child`, each item a keyed durable call, so
50
+ a crash mid-fan-out resumes with completed items reused and only unresolved items re-run.
51
+ - **Control plane.** An HTTP control + read API (start, cancel, send event, fork; run
52
+ list, timeline, tree, task detail, compare) with a redactor applied to every read and a
53
+ loopback/token security guard.
54
+ - **Studio.** The Satay Studio SPA ships as a built bundle served by the same process.
55
+ - **Forking and versioning.** Fork a run from a prefix, compare two runs call-by-call, and
56
+ a code-version stamp with a strict/warn/off mismatch policy on resume.
57
+ - **`satay dev`.** One command brings up the lock, store, worker, and Studio server, and
58
+ tears them down in reverse.
59
+ - **Payload spill.** Encoded payloads over 256 KiB spill to content-addressed blob files
60
+ transparently on write and rehydrate on read.
61
+
62
+ Deliberate MVP gaps, so the honesty survives contact:
63
+
64
+ - **No blob GC.** No run deletion and no compaction; blobs accumulate under `./.satay/`
65
+ and removal is manual (ADR-0004). A future GC has to be reference-aware, since forks
66
+ share blobs with their source run.
67
+ - **Fan-out is fail-fast only.** No collect / `return_exceptions` mode for
68
+ `map`/`gather`/`start_child`; the first failure raises and sibling results are discarded
69
+ (ADR-0020).
70
+ - **`satay runs show` is frozen at the V1 event subset** (ADR-0016). Timer, event,
71
+ cancellation, and fork events render as bare type lines; Studio covers the rest.
72
+ - **Fork only accepts terminal runs** (ADR-0004) — completed, failed, or cancelled.
73
+ - **One process, one writer.** No PostgreSQL backend, no multi-worker or distributed
74
+ execution. The cross-process data-dir lock is POSIX `flock` and only `satay dev` takes it.
75
+ - **Async only.** Sync (non-async) workflows and tasks are unsupported.
76
+ - **Nondeterminism detection is runtime-only** and compares the durable-call schedule,
77
+ not arguments; there is no static analysis of workflow bodies, and no automatic
78
+ migration of long-running workflows across code versions.
79
+ - **Windows is best-effort** and SQLite on network filesystems is unsupported (ADR-0019).
80
+
81
+ See `docs/` for the specs and `CLAUDE.md` for the build brief.
82
+
83
+ ## Requirements
84
+
85
+ - Python **3.12 or 3.13**
86
+ - [`uv`](https://docs.astral.sh/uv/) for environment and dependency management
87
+ - Linux/macOS first-class; Windows best-effort (SQLite on local disk only)
88
+
89
+ ## Dev quickstart
90
+
91
+ ```bash
92
+ uv sync # create the venv, install deps + dev group
93
+ uv run ruff check . # lint
94
+ uv run ruff format --check . # format check
95
+ uv run mypy src # type-check (strict)
96
+ uv run pytest tests/unit -q # unit tests
97
+ ```
98
+
99
+ The integration and e2e tests that cover Studio and the HTTP API need the `studio` extra;
100
+ without it they skip themselves and the reported count silently drops:
101
+
102
+ ```bash
103
+ uv sync --extra studio # then run the full suite
104
+ uv run pytest -q
105
+ ```
106
+
107
+ Or via the Makefile:
108
+
109
+ ```bash
110
+ make dev # uv sync
111
+ make check # ruff + mypy
112
+ make test # unit tests
113
+ make ci # everything CI runs
114
+ ```
115
+
116
+ Install the pre-push hook (runs the cheap gates before every push):
117
+
118
+ ```bash
119
+ make install-hooks # or: ./scripts/install-hooks.sh
120
+ ```
121
+
122
+ ## Layout
123
+
124
+ ```
125
+ src/satay/ runtime core (pure Python, near-zero dependencies)
126
+ api/ author decorators, primitives, run handle, TaskContext
127
+ replay/ replay engine, identity, nondeterminism
128
+ journal/ event model + Store seam + codec
129
+ executor/ TaskExecutor seam + LocalTaskExecutor
130
+ timers/ timer + event poll loop
131
+ control/ HTTP control + read API (satay[studio])
132
+ versioning/ code-version stamper
133
+ blobs/ payload spill
134
+ devstack/ `satay dev` orchestrator (satay[studio])
135
+ testing/ fault injection, manual clock, seeded RNG, fixtures
136
+ cli/ core argparse CLI (`satay runs show`)
137
+ tests/{unit,integration,e2e}/
138
+ docs/ specs + ADRs
139
+ ```
140
+
141
+ ## License
142
+
143
+ Apache-2.0. See [LICENSE](LICENSE).