Skip to content

docs(readme): fix license link, align tests w/ CI, add error handling#111

Merged
martinkersner merged 1 commit into
mainfrom
worktree-readme-improvements
Jun 30, 2026
Merged

docs(readme): fix license link, align tests w/ CI, add error handling#111
martinkersner merged 1 commit into
mainfrom
worktree-readme-improvements

Conversation

@martinkersner

Copy link
Copy Markdown
Member

Summary

README cleanup, branched from latest origin/main.

  • Fix broken License link (license.mdLICENSE).
  • Quickstart is now env-var-first (Datamaxi() reads DATAMAXI_API_KEY; verified in datamaxi/api.py).
  • Add data-coverage hook to intro; add "Discovery helpers" note under API Reference.
  • Trim Premium's ~40-param dump to common filters + link to docs for the full set.
  • Add Error Handling section (exception table + try/except example) and TOC entry.
  • Explain the requirements/ files in a table.
  • Tests: offline command now pytest tests/ -k "not integration" -q to match CI (old test_api.py-only command undercounted; missed test_call.py / test_query_params.py).

Doc-only change; no code touched.

Tests

  • uv run pytest tests/ -k "not integration" -q108 passed, 11 skipped, 119 deselected.
  • No known failures.

Notes

  • tox.ini removal (from the original review) was moot — it's not on origin/main, only untracked locally.
  • Python 3.10+ claim verified accurate against pyproject.toml (requires-python = ">=3.10").

@martinkersner martinkersner self-assigned this Jun 30, 2026
- fix broken License link (license.md -> LICENSE)
- explain requirements/ files; env-var-first quickstart
- offline test cmd now matches CI (-k "not integration")
- add Error Handling section + Discovery helpers note
- trim premium param dump to common filters + docs link
@martinkersner martinkersner force-pushed the worktree-readme-improvements branch from b0a103c to 6cdc25b Compare June 30, 2026 06:45
@martinkersner martinkersner merged commit be28f37 into main Jun 30, 2026
7 checks passed
@martinkersner martinkersner deleted the worktree-readme-improvements branch June 30, 2026 06:50
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