sfnkit 0.1.0__tar.gz

sfnkit-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+.sfnkit/
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+dist/

sfnkit-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

sfnkit-0.1.0/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.5
+Name: sfnkit
+Version: 0.1.0
+Summary: Author AWS Step Functions workflows as decorated Python functions
+Project-URL: Homepage, https://github.com/execution-associates/sfnkit
+Project-URL: Repository, https://github.com/execution-associates/sfnkit
+Project-URL: Issues, https://github.com/execution-associates/sfnkit/issues
+Author: Execution Associates
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: aws,lambda,orchestration,serverless,step-functions,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.12
+Requires-Dist: boto3>=1.35
+Description-Content-Type: text/markdown
+
+# sfnkit
+
+Write AWS Step Functions workflows as plain Python. Steps are decorated functions that run as Lambda
+container images. The workflow body is ordinary Python, including `match`, `if` and `with` blocks,
+and is compiled into a state machine.
+
+```
+pip install sfnkit
+```
+
+Requires Python 3.12+. Deploying also needs Docker (to build the Lambda images) and AWS credentials
+that can create IAM roles.
+
+```python
+from sfnkit import step, workflow, attempt, Ok, Err, each, subworkflow, wait, fail, is_null
+from sfnkit import Lambda, Retry, Allow, Policy
+
+base = Policy(Allow("s3:GetObject", "arn:aws:s3:::data/*"))
+
+@step(compute=Lambda(memory=1024, timeout=120), deps=["httpx>=0.27"])
+def fetch(url: str) -> list[str]: ...
+
+@step(deps=["pyyaml"], retry=Retry(on=[ValueError], max_attempts=3))
+def parse(doc: str) -> dict: ...
+
+@workflow(iam=base)
+def pipeline(url: str, label: str = "run"):
+    docs = fetch(url)
+    rows = parse.map(docs, max_concurrency=10)          # Map state
+
+    with subworkflow("scoring"):                         # child state machine
+        score = score_rows(rows)
+
+    match score["tier"]:                                 # Choice state
+        case "gold" | "silver":
+            order = publish(rows)
+        case "review" if score["value"] > 0.5:
+            wait(seconds=300)
+            order = queue_for_review(rows)
+        case _:
+            fail("LowScore", "score below 0.5")
+
+    match attempt(charge, order):                        # Catch
+        case Ok(receipt):
+            pass
+        case Err("PaymentDeclined", cause):
+            receipt = refund(order, cause)
+
+    return {"receipt": receipt}
+```
+
+```
+sfnkit local  myapp.flows:pipeline --input '{"url": "https://..."}'
+sfnkit synth  myapp.flows:pipeline -o out/
+sfnkit deploy myapp.flows:pipeline --region us-west-2
+sfnkit run    myapp.flows:pipeline --input '{"url": "https://..."}'
+sfnkit destroy myapp.flows:pipeline
+```
+
+## How a workflow body becomes a state machine
+
+A step called inside a `@workflow` doesn't run. It returns a *ref* to its future output, and the call
+is recorded. Called anywhere else, a step is a normal Python function.
+
+A condition on a ref (`==`, `<`, `in`, `and`, `if x:`) is a *decision*. The tracer runs the workflow
+body once per combination of decisions and merges the runs into one graph:
+
+- **Calls that don't depend on each other** run in one Parallel state.
+- **Each decision** becomes a Choice state.
+- **A variable assigned in several branches** is merged automatically, so it can be used after the
+  `if`/`match` like normal Python.
+
+Because the body runs once per path, it must be deterministic and free of side effects. Paths are
+capped at `max_paths` (default 1024). Each `@workflow` is traced on its own, so splitting a large
+body into child workflows keeps the count down.
+
+## Control flow
+
+| Python | Step Functions |
+|---|---|
+| independent step calls | Parallel |
+| `if/elif/else`, `match` with literal, value and OR patterns and guards | Choice |
+| `step.map(items, **kw)`, `with each(items) as it:` | Map (inline), or Distributed with `distributed=True` |
+| `match attempt(fn, ...)` with `case Ok(v)` / `case Err(name, cause)` | Catch |
+| `with subworkflow("name"):`, calling another `@workflow` | child state machine (`startExecution.sync:2`) |
+| `wait(seconds=...)`, `wait(until=...)` | Wait. A barrier: everything before it runs first |
+| `fail(error, cause)` | Fail |
+
+**`attempt(fn, *args)`** runs a step, a workflow, or a plain function containing several steps.
+
+- **It catches only the error names its `match` handles.** A Python exception's name is its class
+  name, so `Err(errors.PaymentDeclined, c)` and `Err("PaymentDeclined", c)` match the same error.
+- **Errors no case handles fail the workflow,** just as they would without `attempt`.
+- **`case Err(error, cause):` catches everything.** `cause` is Lambda's error object: `errorMessage`,
+  `errorType` and `stackTrace`.
+
+**`each(items)`** takes items from a workflow input, a literal list, a step's output (or a field of
+it), or another inline map's results. A Distributed Map can also read straight from S3 with
+`S3Objects(bucket, prefix)` or `S3File(bucket, key, format="json"|"jsonl"|"csv")`. Inside the block,
+`it.item` is the current item and `it.result(x)` sets that item's result. After the block, `it.value`
+is the list of results.
+
+**Checked when the decorator runs**, because tracing would silently take the wrong branch otherwise:
+
+- `case None/True/False` and `is` compare by identity. Use `is_null(x)`.
+- List and dict patterns aren't supported. Neither are class patterns other than `Ok`/`Err`.
+- A bare exception name inside `Err(...)` captures every error instead of matching that exception.
+  Write the dotted name or a string.
+- `try/except` isn't supported; use `attempt`. Neither is `while`.
+- `return` must be the last statement of the workflow.
+
+**Not supported** in a workflow body: arithmetic on refs, `len()` (use `length(x)`), and iterating a
+ref (use `.map`/`each`). Do those in a step.
+
+## IAM
+
+Every step's role gets three layers:
+
+1. **The runtime baseline.** This is added automatically: its own logs, plus read and write on the
+   artifacts bucket under `runs/`.
+2. **The workflow's base set**, from `@workflow(iam=base)` or `subworkflow(..., iam=base)`. Steps
+   with no `iam=` inherit the nearest one.
+3. **The step's own `iam=`, which replaces the base set.**
+   - Write `iam=base + Allow(...)` to keep the base set and add to it.
+   - Write `iam=Policy(Allow(...))` for granular permissions with none of the base set.
+
+`Policy` objects compose with `+`, which takes their union and removes duplicates. A step that ends
+up under two different policies is deployed as two functions. A reusable `@workflow` uses its own
+`iam=`. Resources may be CloudFormation intrinsics, for example
+`{"Fn::Sub": "arn:${AWS::Partition}:s3:::${ArtifactsBucket}/fixtures/*"}`.
+
+## Data between steps
+
+Step arguments and results must be JSON-serializable. Step Functions caps each state's input and
+output at 256 KiB, so any value over `offload_threshold` (default 32 KiB) goes to the artifacts
+bucket. Step code only ever sees plain values.
+
+A condition is evaluated inside Step Functions, which can't read S3. So the step that produces a
+value also returns, inline, the specific fields conditions read (*facts*). Conditions can therefore
+branch on a value even when the rest of it went to S3.
+
+The wire format is in `src/sfnkit/runtime/protocol.py`.
+
+## Dependencies and images
+
+A step's image is built from the workflow's `deps` + the step's `deps` (+ `system_packages`,
+installed with `microdnf`), on `public.ecr.aws/lambda/python:<python>`. Steps with the same set
+share an image. Tags are content hashes, so an unchanged image isn't rebuilt or pushed again. Build
+contexts go in `<project>/.sfnkit/build/`.
+
+## Deploying
+
+`deploy` creates two stacks:
+
+- `<stack>-assets`: the ECR repository and the artifacts bucket.
+- `<stack>`: the functions, their roles, log groups and state machines.
+
+`destroy` deletes both, emptying the bucket first. The deploying credentials must be allowed to
+create IAM roles. Credentials from `sts get-session-token` can't call IAM without MFA, so use
+long-term or assumed-role credentials.
+
+## Adding a compute backend
+
+Every step runs through one interface, `sfnkit.compute.base.ComputeBackend`. To add one:
+
+1. Subclass `ComputeSpec` for the user-facing settings, e.g. `Fargate(cpu=..., memory=...)`.
+2. Implement four methods on the backend:
+   - `resources(fn, ctx)`: the CloudFormation resources that run it.
+   - `baseline_statements(fn, ctx)`: IAM its own role needs.
+   - `task_state(fn)`: the Task state. Put `PAYLOAD` where the envelope goes.
+   - `state_machine_statements(fn)`: IAM the state machine needs to start it.
+3. Register it with `register_backend` or the `sfnkit.compute` entry point.
+
+The compiler, CloudFormation assembly and deployer only call this interface. Containers can run the
+same image with the entrypoint `python -m sfnkit.runtime.container`, which reads the envelope and
+task token from the environment and reports the result with `SendTaskSuccess`/`SendTaskFailure`.
+`tests/core/test_compile.py` registers a fake ECS backend to prove nothing else needs to change.
+
+## Development
+
+Work happens in the isb sandbox described by `isb.yaml`:
+
+```
+isb up -d
+scripts/sandbox.sh -- 'uv sync && uv run pytest'                    # unit tests, no AWS
+scripts/sandbox.sh -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e AWS_DEFAULT_REGION \
+  -- 'uv run pytest -m aws'                                            # validate ASL with AWS
+scripts/sandbox.sh -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e AWS_DEFAULT_REGION \
+  -- 'PYTHONPATH=. uv run pytest -m e2e -s'                            # deploy, run, destroy
+```
+
+- **Golden ASL** lives in `tests/core/golden/`. Refresh it with `SFNKIT_UPDATE_GOLDEN=1` and
+  review the diff.
+- **The e2e test** deploys `examples/pipeline.py` under a random `sfnkit-e2e-*` stack name, runs
+  every path, and always tears down.

sfnkit-0.1.0/README.md

@@ -0,0 +1,195 @@
+# sfnkit
+
+Write AWS Step Functions workflows as plain Python. Steps are decorated functions that run as Lambda
+container images. The workflow body is ordinary Python, including `match`, `if` and `with` blocks,
+and is compiled into a state machine.
+
+```
+pip install sfnkit
+```
+
+Requires Python 3.12+. Deploying also needs Docker (to build the Lambda images) and AWS credentials
+that can create IAM roles.
+
+```python
+from sfnkit import step, workflow, attempt, Ok, Err, each, subworkflow, wait, fail, is_null
+from sfnkit import Lambda, Retry, Allow, Policy
+
+base = Policy(Allow("s3:GetObject", "arn:aws:s3:::data/*"))
+
+@step(compute=Lambda(memory=1024, timeout=120), deps=["httpx>=0.27"])
+def fetch(url: str) -> list[str]: ...
+
+@step(deps=["pyyaml"], retry=Retry(on=[ValueError], max_attempts=3))
+def parse(doc: str) -> dict: ...
+
+@workflow(iam=base)
+def pipeline(url: str, label: str = "run"):
+    docs = fetch(url)
+    rows = parse.map(docs, max_concurrency=10)          # Map state
+
+    with subworkflow("scoring"):                         # child state machine
+        score = score_rows(rows)
+
+    match score["tier"]:                                 # Choice state
+        case "gold" | "silver":
+            order = publish(rows)
+        case "review" if score["value"] > 0.5:
+            wait(seconds=300)
+            order = queue_for_review(rows)
+        case _:
+            fail("LowScore", "score below 0.5")
+
+    match attempt(charge, order):                        # Catch
+        case Ok(receipt):
+            pass
+        case Err("PaymentDeclined", cause):
+            receipt = refund(order, cause)
+
+    return {"receipt": receipt}
+```
+
+```
+sfnkit local  myapp.flows:pipeline --input '{"url": "https://..."}'
+sfnkit synth  myapp.flows:pipeline -o out/
+sfnkit deploy myapp.flows:pipeline --region us-west-2
+sfnkit run    myapp.flows:pipeline --input '{"url": "https://..."}'
+sfnkit destroy myapp.flows:pipeline
+```
+
+## How a workflow body becomes a state machine
+
+A step called inside a `@workflow` doesn't run. It returns a *ref* to its future output, and the call
+is recorded. Called anywhere else, a step is a normal Python function.
+
+A condition on a ref (`==`, `<`, `in`, `and`, `if x:`) is a *decision*. The tracer runs the workflow
+body once per combination of decisions and merges the runs into one graph:
+
+- **Calls that don't depend on each other** run in one Parallel state.
+- **Each decision** becomes a Choice state.
+- **A variable assigned in several branches** is merged automatically, so it can be used after the
+  `if`/`match` like normal Python.
+
+Because the body runs once per path, it must be deterministic and free of side effects. Paths are
+capped at `max_paths` (default 1024). Each `@workflow` is traced on its own, so splitting a large
+body into child workflows keeps the count down.
+
+## Control flow
+
+| Python | Step Functions |
+|---|---|
+| independent step calls | Parallel |
+| `if/elif/else`, `match` with literal, value and OR patterns and guards | Choice |
+| `step.map(items, **kw)`, `with each(items) as it:` | Map (inline), or Distributed with `distributed=True` |
+| `match attempt(fn, ...)` with `case Ok(v)` / `case Err(name, cause)` | Catch |
+| `with subworkflow("name"):`, calling another `@workflow` | child state machine (`startExecution.sync:2`) |
+| `wait(seconds=...)`, `wait(until=...)` | Wait. A barrier: everything before it runs first |
+| `fail(error, cause)` | Fail |
+
+**`attempt(fn, *args)`** runs a step, a workflow, or a plain function containing several steps.
+
+- **It catches only the error names its `match` handles.** A Python exception's name is its class
+  name, so `Err(errors.PaymentDeclined, c)` and `Err("PaymentDeclined", c)` match the same error.
+- **Errors no case handles fail the workflow,** just as they would without `attempt`.
+- **`case Err(error, cause):` catches everything.** `cause` is Lambda's error object: `errorMessage`,
+  `errorType` and `stackTrace`.
+
+**`each(items)`** takes items from a workflow input, a literal list, a step's output (or a field of
+it), or another inline map's results. A Distributed Map can also read straight from S3 with
+`S3Objects(bucket, prefix)` or `S3File(bucket, key, format="json"|"jsonl"|"csv")`. Inside the block,
+`it.item` is the current item and `it.result(x)` sets that item's result. After the block, `it.value`
+is the list of results.
+
+**Checked when the decorator runs**, because tracing would silently take the wrong branch otherwise:
+
+- `case None/True/False` and `is` compare by identity. Use `is_null(x)`.
+- List and dict patterns aren't supported. Neither are class patterns other than `Ok`/`Err`.
+- A bare exception name inside `Err(...)` captures every error instead of matching that exception.
+  Write the dotted name or a string.
+- `try/except` isn't supported; use `attempt`. Neither is `while`.
+- `return` must be the last statement of the workflow.
+
+**Not supported** in a workflow body: arithmetic on refs, `len()` (use `length(x)`), and iterating a
+ref (use `.map`/`each`). Do those in a step.
+
+## IAM
+
+Every step's role gets three layers:
+
+1. **The runtime baseline.** This is added automatically: its own logs, plus read and write on the
+   artifacts bucket under `runs/`.
+2. **The workflow's base set**, from `@workflow(iam=base)` or `subworkflow(..., iam=base)`. Steps
+   with no `iam=` inherit the nearest one.
+3. **The step's own `iam=`, which replaces the base set.**
+   - Write `iam=base + Allow(...)` to keep the base set and add to it.
+   - Write `iam=Policy(Allow(...))` for granular permissions with none of the base set.
+
+`Policy` objects compose with `+`, which takes their union and removes duplicates. A step that ends
+up under two different policies is deployed as two functions. A reusable `@workflow` uses its own
+`iam=`. Resources may be CloudFormation intrinsics, for example
+`{"Fn::Sub": "arn:${AWS::Partition}:s3:::${ArtifactsBucket}/fixtures/*"}`.
+
+## Data between steps
+
+Step arguments and results must be JSON-serializable. Step Functions caps each state's input and
+output at 256 KiB, so any value over `offload_threshold` (default 32 KiB) goes to the artifacts
+bucket. Step code only ever sees plain values.
+
+A condition is evaluated inside Step Functions, which can't read S3. So the step that produces a
+value also returns, inline, the specific fields conditions read (*facts*). Conditions can therefore
+branch on a value even when the rest of it went to S3.
+
+The wire format is in `src/sfnkit/runtime/protocol.py`.
+
+## Dependencies and images
+
+A step's image is built from the workflow's `deps` + the step's `deps` (+ `system_packages`,
+installed with `microdnf`), on `public.ecr.aws/lambda/python:<python>`. Steps with the same set
+share an image. Tags are content hashes, so an unchanged image isn't rebuilt or pushed again. Build
+contexts go in `<project>/.sfnkit/build/`.
+
+## Deploying
+
+`deploy` creates two stacks:
+
+- `<stack>-assets`: the ECR repository and the artifacts bucket.
+- `<stack>`: the functions, their roles, log groups and state machines.
+
+`destroy` deletes both, emptying the bucket first. The deploying credentials must be allowed to
+create IAM roles. Credentials from `sts get-session-token` can't call IAM without MFA, so use
+long-term or assumed-role credentials.
+
+## Adding a compute backend
+
+Every step runs through one interface, `sfnkit.compute.base.ComputeBackend`. To add one:
+
+1. Subclass `ComputeSpec` for the user-facing settings, e.g. `Fargate(cpu=..., memory=...)`.
+2. Implement four methods on the backend:
+   - `resources(fn, ctx)`: the CloudFormation resources that run it.
+   - `baseline_statements(fn, ctx)`: IAM its own role needs.
+   - `task_state(fn)`: the Task state. Put `PAYLOAD` where the envelope goes.
+   - `state_machine_statements(fn)`: IAM the state machine needs to start it.
+3. Register it with `register_backend` or the `sfnkit.compute` entry point.
+
+The compiler, CloudFormation assembly and deployer only call this interface. Containers can run the
+same image with the entrypoint `python -m sfnkit.runtime.container`, which reads the envelope and
+task token from the environment and reports the result with `SendTaskSuccess`/`SendTaskFailure`.
+`tests/core/test_compile.py` registers a fake ECS backend to prove nothing else needs to change.
+
+## Development
+
+Work happens in the isb sandbox described by `isb.yaml`:
+
+```
+isb up -d
+scripts/sandbox.sh -- 'uv sync && uv run pytest'                    # unit tests, no AWS
+scripts/sandbox.sh -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e AWS_DEFAULT_REGION \
+  -- 'uv run pytest -m aws'                                            # validate ASL with AWS
+scripts/sandbox.sh -e AWS_ACCESS_KEY_ID -e AWS_SECRET_ACCESS_KEY -e AWS_DEFAULT_REGION \
+  -- 'PYTHONPATH=. uv run pytest -m e2e -s'                            # deploy, run, destroy
+```
+
+- **Golden ASL** lives in `tests/core/golden/`. Refresh it with `SFNKIT_UPDATE_GOLDEN=1` and
+  review the diff.
+- **The e2e test** deploys `examples/pipeline.py` under a random `sfnkit-e2e-*` stack name, runs
+  every path, and always tears down.