Clean up README and drop unused requirements-dev.txt#286
Merged
Conversation
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
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
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.
Summary
requirements-dev.txt— the file isn't referenced by any CI workflow or script. Dev dependencies are already declared inpyproject.tomlunder the[test],[doc], and[nldi]extras and installed in CI viapip install .[test,nldi]/.[doc,nldi].NEWS.md(link kept from the intro).waterdataexamples already cover the same ground.USGS-python/dataretrievalorg →DOI-USGS/dataretrieval-python.No functional or packaging changes — README and a stale dev-requirements file only.
Test plan
pip install .[test,nldi]/.[doc,nldi], not via the deleted file)🤖 Generated with Claude Code