lib: document + test the public library API (SPEC §2)#16
Merged
Conversation
The engine is embeddable without the CLI or the file store. Add a README 'Use as a library' section with a verified runnable example, and a test that drives a machine end-to-end through the public surface only (load+validate, register + create root with external esvs, deliver typed event + run to quiescence, advance the clock, read status/config/esvs, snapshot/restore) and pins harel.__all__. Closes #13.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #13. Implements the Python side of fruwehq/harel#15 (programmatic API is a normative MUST).
What
externalesvs → deliver typed event + run to quiescence → read status/config/esvs → advance clock → snapshot/restore). Verified to run.tests/test_library_api.py: drives a machine end-to-end through the public surface only and asserts every §2-minimum capability, plus pins the exportedharel.__all__surface so it can't silently regress.No submodule bump needed — the §2 wording already landed via the P1 bump. ruff + mypy clean; full suite green (137 tests).