Add Future Plans & Maintenance docs and public API contract test - #1153
Open
MaxGhenis wants to merge 3 commits into
Open
Add Future Plans & Maintenance docs and public API contract test#1153MaxGhenis wants to merge 3 commits into
MaxGhenis wants to merge 3 commits into
Conversation
Document the maintenance commitment, the stable public surfaces (CLI, runners import path, PolicyEngineRunner.run() DataFrame contract), and the Axiom backend roadmap on the documentation site and in the README. Pin the Python surfaces with a contract test so a rename or signature change fails CI. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Lead with the Axiom backend plans; state maintenance as plain operations facts rather than a continuity pledge, since most readers have no transition context. Same stable-surface list and contract test. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
MaxGhenis
changed the title
Pin PolicyEngineRunner as a class (not merely callable), exercise the documented zero-argument run(), and pin the CLI's stdin-to-stdout TAXSIM CSV contract through the installed console script. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Documents where the TAXSIM emulator is headed and what users can rely on, and pins the reliance surfaces in CI.
What this adds
tests/test_public_contract.py: pins the import path (from policyengine_taxsim.runners import PolicyEngineRunner), the constructor taking a TAXSIM-format DataFrame, andrun()returning a TAXSIM-format DataFrame withtaxsimid/year/fiitax. Renaming or reshaping any of these now fails CI. The CLI entry point already has its own pin intests/test_cli_entry_point.py.Verification
pytest tests/test_public_contract.pypasses locally against a real PolicyEngine run (2 passed).ruff format --check .clean.bun run buildsucceeds; the new section renders with all five nav tabs intact (verified in a local static serve ofdashboard/out).🤖 Generated with Claude Code