Skip to content

Commit

Permalink
Standardized name of web services in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adamancer committed Jan 24, 2022
1 parent 650c910 commit 4a9bf03
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 13 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion pyncei/__init__.py
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
11 changes: 7 additions & 4 deletions pyncei/bot.py
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
5 changes: 2 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -23,8 +23,7 @@
name="pyncei",
maintainer="Adam Mansur",
maintainer_email="[email protected]",
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",
Expand Down

0 comments on commit 4a9bf03

Please sign in to comment.