From 4a9bf03309c65eca9b7ab6f0c4658e8511275edc Mon Sep 17 00:00:00 2001 From: Adam Mansur Date: Mon, 24 Jan 2022 09:18:38 -0800 Subject: [PATCH] Standardized name of web services in docs --- CHANGELOG.md | 2 +- README.md | 7 ++++--- docs/user-guide.md | 2 +- pyncei/__init__.py | 2 +- pyncei/bot.py | 11 +++++++---- setup.py | 5 ++--- 6 files changed, 16 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e379ba4..598a3c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). \[1.0\] --------------- +------- ### Added diff --git a/README.md b/README.md index 84e825e..41e8923 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ pyncei ====== -This module provides tools to request data from the [Climate Data Online -webservices](http://www.ncdc.noaa.gov/cdo-web/webservices/v2#gettingStarted) +This module provides tools to access data from NOAA’s [Climate Data +Online Web Services v2 +API](http://www.ncdc.noaa.gov/cdo-web/webservices/v2#gettingStarted) provided by NOAA’s National Centers for Environmental information (formerly the National Center for Climate Data). @@ -32,7 +33,7 @@ return a GeoDataFrame when coordinates are provided by NCEI. Getting started --------------- -To use the NCEI webservices, you’ll need a token. The token is a +To use the NCEI web services, you’ll need a token. The token is a 32-character string provided by NCEI; users can request one [here](https://www.ncdc.noaa.gov/cdo-web/token). Pass the token to `NCEIBot` to get started: diff --git a/docs/user-guide.md b/docs/user-guide.md index 84f0b60..634f16c 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -25,7 +25,7 @@ GeoDataFrame when coordinates are provided by NCEI. Getting started --------------- -To use the NCEI webservices, you’ll need a token. The token is a +To use the NCEI web services, you’ll need a token. The token is a 32-character string provided by NCEI; users can request one [here](https://www.ncdc.noaa.gov/cdo-web/token). Pass the token to :py:class:`~pyncei.bot.NCEIBot` to get started: diff --git a/pyncei/__init__.py b/pyncei/__init__.py index 1cdd5a9..1bfe3b6 100644 --- a/pyncei/__init__.py +++ b/pyncei/__init__.py @@ -1,4 +1,4 @@ -"""Queries NCEI v2 webservices""" +"""Access data from NOAA's Climate Data Online Web Services v2 API""" from .bot import NCEIBot, NCEIResponse __version__ = "1.0" diff --git a/pyncei/bot.py b/pyncei/bot.py index d806327..dbd5b11 100644 --- a/pyncei/bot.py +++ b/pyncei/bot.py @@ -1,4 +1,4 @@ -"""Python bindings for the NCEI Climate Data Online webservices""" +"""Tools to access data from NOAA's Climate Data Online Web Services v2 API""" from copy import copy import csv @@ -24,13 +24,16 @@ class NCEIBot: - """Contains functions to request data from the NCEI webservices + """Contains functions to request data from the NCEI web services Attributes: - wait (float): Time in seconds between requests. NCEI + wait (float): time in seconds between requests. NCEI allows a maximum of five queries per second. - validate_params (bool): Whether to validate query parameters before + validate_params (bool): whether to validate query parameters before making a GET request. Defaults to False. + max_retries (int): number of times to retry requests that fail + because of temporary connectivity or server lapses. Retries + use an exponential backoff. Defaults to 12. The get functions described below use a common set of keyword arguments. The sortorder, limit, offset, and max arguments can be used in diff --git a/setup.py b/setup.py index 24ea7e5..460ee58 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ long_description = ( "pyncei provides tools to request data from the [Climate Data Online" - " v2 webservices](http://www.ncdc.noaa.gov/cdo-web/webservices/v2#gettingStarted)" + " Web Services v2 API](http://www.ncdc.noaa.gov/cdo-web/webservices/v2#gettingStarted)" " provided by NOAA's National Centers for Environmental information (formerly" " the National Center for Climate Data)." "\n\n" @@ -23,8 +23,7 @@ name="pyncei", maintainer="Adam Mansur", maintainer_email="mansura@si.edu", - description="Python bindings for NOAA's National Centers" - " for Environomental Information webservices", + description="Access data from NOAA's Climate Data Online Web Services v2 API", long_description=long_description, long_description_content_type="text/markdown", version="1.0",