Commit 5633e2c
chore!: remove the nadp module and the deprecated samples shim
Ahead of the 1.2.0 release (which allows breaking changes), remove two
deprecated modules and every reference to them except the changelog:
- `dataretrieval.nadp` — deprecated 2026-05-01. NADP is not a USGS data source;
retrieve NADP data directly from https://nadp.slh.wisc.edu/.
- `dataretrieval.samples` — the `get_usgs_samples` shim that only forwarded to
`waterdata.get_samples()`. Use `waterdata.get_samples()` directly.
Deleted: both modules, `tests/nadp_test.py`, and their reference doc pages
`docs/source/reference/{nadp,samples}.rst`. Updated references: the `nadp`
API-toctree entry, the two NADP rows in the data-portals table, the
`nadp`/`samples` entries in `dataretrieval/__init__` (imports, `__all__`, the
module-list docstring), the `nadp` mentions in the shared `exceptions`/`utils`
docstrings, and the `nadp_test` note in AGENTS.md. A NEWS.md entry records the
removal.
The modern `waterdata.get_samples()` / `get_samples_summary()` and their demo
notebooks are untouched — only the deprecated `samples` shim is removed.
(Rebased onto main: the `ngwmn` module + OGC engine added in #324 are kept; the
`samples.rst` autodoc page main added for the now-removed module is dropped.)
BREAKING CHANGE: `import dataretrieval.nadp` and `import dataretrieval.samples`
now raise ModuleNotFoundError; `samples.get_usgs_samples` is gone — use
`waterdata.get_samples()`.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Sjb14HkwuCydKSKMsaXsgd1 parent 5b4c1f0 commit 5633e2c
12 files changed
Lines changed: 6 additions & 352 deletions
File tree
- dataretrieval
- docs/source
- reference
- userguide
- tests
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
26 | 25 | | |
27 | 26 | | |
28 | 27 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
1 | 3 | | |
2 | 4 | | |
3 | 5 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
15 | | - | |
| 14 | + | |
16 | 15 | | |
17 | 16 | | |
18 | 17 | | |
| |||
58 | 57 | | |
59 | 58 | | |
60 | 59 | | |
61 | | - | |
62 | 60 | | |
63 | 61 | | |
64 | | - | |
65 | 62 | | |
66 | 63 | | |
67 | 64 | | |
| |||
70 | 67 | | |
71 | 68 | | |
72 | 69 | | |
73 | | - | |
74 | 70 | | |
75 | 71 | | |
76 | | - | |
77 | 72 | | |
78 | 73 | | |
79 | 74 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
267 | 267 | | |
268 | 268 | | |
269 | 269 | | |
270 | | - | |
| 270 | + | |
271 | 271 | | |
272 | 272 | | |
273 | 273 | | |
| |||
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
311 | 311 | | |
312 | 312 | | |
313 | 313 | | |
314 | | - | |
| 314 | + | |
315 | 315 | | |
316 | 316 | | |
317 | 317 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
12 | 11 | | |
13 | 12 | | |
14 | 13 | | |
15 | | - | |
16 | 14 | | |
17 | 15 | | |
18 | 16 | | |
| |||
This file was deleted.
This file was deleted.
0 commit comments