Optionally include additional metadata with nwis_client get requests

[jarq6c]

This PR adds an include_expanded_metadata switch to nwis_client.iv.IVDataService.get. This is a boolean switch that adds the following columns to the resulting dataframe: ['siteName', 'srs', 'latitude', 'longitude', 'siteTypeCd', 'hucCd', 'countyCd', 'stateCd']. These data were always present in the raw json, but were previously ignored. This addition should benefit any geospatial applications.

Additions

• New include_expanded_metadata parameter. Default is set to False.

Removals

• Removed infer_datetime option per pandas``UserWarning from datetime conversions.

Changes

• No change in overall behavior.

Testing

1. Added two new tests for get_raw and get using the new parameter.

Notes

Todos

Checklist

• PR has an informative and human-readable title
• PR is well outlined and documented. See #12 for an example
• Changes are limited to a single goal (no scope creep)
• Code can be automatically merged (no conflicts)
• Code follows project standards (see CONTRIBUTING.md)
• Passes all existing automated tests
• Any change in functionality is tested
• New functions are documented (with a description, list of inputs, and expected output) using numpy docstring formatting
• Placeholder code is flagged / future todos are captured in comments
• Reviewers requested with the Reviewers tool ➡️

[jarq6c]

Appears 3.7 error is unrelated.

Edit: 3.7 is EOL in 2023-06-27. Should probably drop it and add 3.10.

[aaraney]

Thanks for introducing this, @jarq6c! The code looks good to me, I really only have a question and I think we can get this on its way.

For the added optional columns, what are your thoughts on using camelcase and expanding abbreviations in their names? My thinking is to preserve naming conventions from the hydrotools canonical format. Here are the transformations I am thinking:

siteTypeCd -> site_type_code
hucCd -> huc_code
countyCd -> county_code
stateCd -> state_code
siteName -> site_name
srs

Thoughts?

[jarq6c]

Agreed and updated column names.

[aaraney]

Thanks for making the changes, @jarq6c! This looks good to me!

[jarq6c]

Deployed:
https://pypi.org/project/hydrotools.nwis-client/3.3.1/