Skip to content

docs: add status section and adding-a-reader guide - #14

Closed
TKaltofen wants to merge 4 commits into
mloda-ai:mainfrom
TomKaltofen:docs/status-and-adding-a-reader
Closed

docs: add status section and adding-a-reader guide#14
TKaltofen wants to merge 4 commits into
mloda-ai:mainfrom
TomKaltofen:docs/status-and-adding-a-reader

Conversation

@TKaltofen

Copy link
Copy Markdown
Collaborator

Summary

  • Add a Status section to the README stating what works today (paginated search, cached downloads with retries, unit plus property-based tests) and that the API may still shift during the Prototype Fund stage.
  • Trim template boilerplate in Related Repositories to two plain lines.
  • Add docs/adding-a-reader.md describing how to connect a new dataset: when no code is needed, when to subclass GovDataReader, the parse_*_bytes testability pattern, tests, and the tox gate.

Docs only, no code changes.

🤖 Generated with Claude Code

TKaltofen added 4 commits July 3, 2026 14:36
feat: GovData connector for M1 (population, elections, environment)
Update the mloda pin from >=0.8.0 to >=0.9.0 (latest release) and refresh
the lockfile. The 0.9.0 breaking changes (default input-feature option
forwarding, PROPERTY_MAPPING default enforcement, credential path changes)
do not touch the connector/reader APIs this plugin uses. Full tox gate
(pytest, ruff, mypy --strict, bandit) passes.
* feat: add paginated CKAN dataset search and a marimo demo notebook
Add an honest status section to the README, trim template boilerplate
in Related Repositories, and document how to connect a new dataset in
docs/adding-a-reader.md.
@TKaltofen

Copy link
Copy Markdown
Collaborator Author

Wrong target: this branch builds on fork-only work (population connector, pagination, demo notebook), so the diff pulled in all of it. Reopening as a fork-internal PR on TomKaltofen/mloda-plugin-govdata.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant