Skip to content

Commit 4d38689

Browse files
authored
Document design goal
1 parent 1d79719 commit 4d38689

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Typed Python interface to AWS Simple Workflow service
1010
* next-page calls are run concurrently and on-demand
1111
* Better execution filtering
1212

13+
The most interesting part is state construction: given an execution history, this
14+
library can build a full state of the execution and all of its tasks with all details;
15+
see [`swf_typed.build_state`](
16+
https://python-swf-typed.readthedocs.io/en/latest/swf_typed._state.html#swf_typed.build_state
17+
). The rest of the API simply mirror's SWF's.
18+
1319
### See also
1420
* [py-swf](https://pypi.org/project/py-swf/) - typed and object-oriented interface layer
1521
* [mypy-boto3-swf](https://pypi.org/project/mypy-boto3-swf/) - type-annotated layer

0 commit comments

Comments
 (0)