Metadata-Version: 2.1
Name: usgs-riverdata
Version: 0.1.2
Summary: Pulls data from the USGS Water Data service
Home-page: https://github.com/wdfrench13/usgs-waterdata
License: Creative Commons Attribution Sharealike 3.0 Unported
Keywords: USGS,waterdata,river
Author: William French
Author-email: wdfrench13@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Project-URL: Repository, https://github.com/wdfrench13/usgs-waterdata
Description-Content-Type: text/markdown

## What is it?

**usgs-riverdata** is a Python package that exposes to the United State Geological Survey (USGS) waterdata api to python. The [USGS Waterdata](https://waterdata.usgs.gov/nwis/) system contains hydrologic data for United States rivers and tributaries.

## Usage

Import using 

```python
import usgs_riverdata
```

The core functionality of this library is the Gage class. 

Initializing an object of this class requires a [site code](http://help.waterdata.usgs.gov/codes-and-parameters/codes#search_station_nm). Each USGS data source has unique location code used to retrive data. The default data length is 7 days, this is configurable using an ISO-8601 Duration format, as specifed [here](https://waterservices.usgs.gov/rest/IV-Service.html#Specifying). Additional parameters are optional and specified [here](https://waterservices.usgs.gov/rest/IV-Service.html#Specifying).

## Dependencies
There are no outside dependencies. If Pandas is available, it will return data in a pandas.Dataframe.
