Skip to content

Clean up README and drop unused requirements-dev.txt#286

Merged
thodson-usgs merged 2 commits into
DOI-USGS:mainfrom
thodson-usgs:clean-readme
May 23, 2026
Merged

Clean up README and drop unused requirements-dev.txt#286
thodson-usgs merged 2 commits into
DOI-USGS:mainfrom
thodson-usgs:clean-readme

Conversation

@thodson-usgs

Copy link
Copy Markdown
Collaborator

Summary

  • Drop requirements-dev.txt — the file isn't referenced by any CI workflow or script. Dev dependencies are already declared in pyproject.toml under the [test], [doc], and [nldi] extras and installed in CI via pip install .[test,nldi] / .[doc,nldi].
  • Streamline the README:
    • Move the announcements block to NEWS.md (link kept from the intro).
    • Drop the redundant legacy NWIS usage example; the NWIS module is deprecated and the modern waterdata examples already cover the same ground.
    • Move the API-key callout next to the Water Data section where it's actually relevant.
    • Tighten wording in the example intros and the logging blurb (consistent imperative voice, drop the puzzling "and collections" phrase, lower-case fix on "python").
    • Fix two broken GitHub links that still pointed at the retired USGS-python/dataretrieval org → DOI-USGS/dataretrieval-python.
    • Replace the "Documentation: available in source code docstrings" entry with a direct link to the existing Sphinx site at https://doi-usgs.github.io/dataretrieval-python/.

No functional or packaging changes — README and a stale dev-requirements file only.

Test plan

  • Render the README on GitHub and confirm the code blocks, headings, and links display correctly
  • Click each updated link (demos directory, issue tracker, documentation site) to confirm it resolves
  • Confirm CI still passes (workflows install via pip install .[test,nldi] / .[doc,nldi], not via the deleted file)

🤖 Generated with Claude Code

No CI workflow or script references this file; dev dependencies are already
declared in pyproject.toml under the [test], [doc], and [nldi] optional
extras and installed via `pip install .[test,nldi]` / `.[doc,nldi]`.
- Remove announcements block (now lives in NEWS.md)
- Drop the redundant legacy NWIS example
- Move the API-key callout into the Water Data section where it belongs
- Tighten wording in the usage examples and logging section
- Fix two broken USGS-python/dataretrieval links to the current
  DOI-USGS/dataretrieval-python org
- Point the Documentation entry at the actual Sphinx site instead of
  claiming docs are docstring-only
@thodson-usgs thodson-usgs marked this pull request as ready for review May 23, 2026 16:44
@thodson-usgs thodson-usgs merged commit 1c857e5 into DOI-USGS:main May 23, 2026
8 checks passed
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