Improve package quality and user-readiness

- Fix .github/wokflows/ typo -> .github/workflows/
- Fix publish.yml YAML indentation (was unparseable)
- Add CI test workflow across Python 3.8-3.12
- Remove redundant setup.py (pyproject.toml is the standard)
- Add tqdm to pyproject.toml dependencies (was missing)
- Add Python version classifiers and dev dependencies
- Add setuptools package discovery config
- Fix hardcoded end date default to use today's date dynamically
- Fix LICENSE copyright holder (was Pangeo Data -> Shahab Shojaee)
- Fix README clone URL (was NWIS_Data_Downloader -> NWIS-Data-Downloader)
- Add test suite with 20 unit tests (mocked, no network)
- Add CHANGELOG.md
- Add py.typed marker for type checker support

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: bluerror2710

.github/wokflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: twine upload dist/*

.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v --tb=short

.github/workflows/tests.yml

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-12-12
+
+### Added
+- Initial release
+- `fetch_usgs_daily` — Fetch raw NWIS daily JSON data with retry and rate-limit handling
+- `usgs_json_to_df` — Convert USGS JSON responses into tidy Pandas DataFrames
+- `fetch_batch_usgs_data` — Multi-site batch fetch with progress bars and filtering
+- `get_usgs_parameters` — Dynamic USGS parameter code discovery
+- `search_parameters` — Keyword search across parameter catalogs
+- PyPI publishing workflow
+- Example usage script

CHANGELOG.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Pangeo Data
+Copyright (c) 2024 Shahab Shojaee
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -27,8 +27,8 @@ pip install nwis-data-downloader
 Or install from source:
 
 ```bash
-git clone https://github.com/bluerrror/NWIS_Data_Downloader.git
-cd NWIS_Data_Downloader
+git clone https://github.com/Bluerrror/NWIS-Data-Downloader.git
+cd NWIS-Data-Downloader
 pip install -e .
 ```
 

README.md

@@ -2,36 +2,48 @@
 requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
-
 [project]
 name = "nwis-data-downloader"
 version = "0.1.0"
-description = "A Python package for downloading USGS NWIS hydrological data"
+description = "A lightweight Python toolkit for downloading, processing, and filtering USGS NWIS daily water data"
 readme = "README.md"
 requires-python = ">=3.8"
 license = { text = "MIT" }
 authors = [
-{ name = "Shahab Shojaee" }
+    { name = "Shahab Shojaee" }
 ]
 
-
-keywords = ["hydrology", "USGS", "NWIS", "water", "data"]
-
+keywords = ["hydrology", "USGS", "NWIS", "water", "data", "streamflow", "sediment"]
 
 classifiers = [
-"Programming Language :: Python :: 3",
-"License :: OSI Approved :: MIT License",
-"Operating System :: OS Independent"
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Hydrology",
 ]
 
-
 dependencies = [
-"requests",
-"pandas"
+    "requests>=2.25.0",
+    "pandas>=1.3.0",
+    "tqdm>=4.62.0",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov",
+]
 
 [project.urls]
 Homepage = "https://github.com/Bluerrror/NWIS-Data-Downloader"
 Repository = "https://github.com/Bluerrror/NWIS-Data-Downloader"
-Issues = "https://github.com/Bluerrror/NWIS-Data-Downloader/issues"
+Issues = "https://github.com/Bluerrror/NWIS-Data-Downloader/issues"
+
+[tool.setuptools.packages.find]
+include = ["usgs_data_fetcher*"]