Metadata-Version: 2.1
Name: rossby
Version: 0.0.2
Summary: A wrapper for the U.S. National Weather Service API
Home-page: https://github.com/nat5142/rossby
Author: Nicholas Tulli
Author-email: nat5142@psu.edu
License: UNKNOWN
Keywords: national weather service nws noaa api wrapper
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests (>=2.20)
Requires-Dist: addict (==2.2.0)

## **Rossby**
A wrapper for the National Weather Service API

---

#### Info

Everything that is used to construct this wrapper is contained in
the directory you are currently in. There are 3 files that wrap the
entire API:

- `rossby.py`
- `api_config.py`
- `default_response.py`

All of the endpoints can be found in the file `api_config.py`,
variable `api_endpoints`. Each key in this dictionary variable
defines the name of a base endpoint that can be called on a
`Rossby()` object. Subsequent key-value pairs represent the unique
methods that can be called on the base endpoint.


----------------------------------

##### Getting Started

Try this example to see how Rossby works:

```python
from rossby import Rossby


rossby = Rossby()

kunv = rossby.stations.by_id(station_id='KUNV')

print(kunv.geometry)
print(kunv.geometry.coordinates)  # equivalent to kunv.geometry['coordinates']

office = rossby.offices.by_id(office_id='CTP')

print(office.address)
print(office.address.streetAddress)
print(office.responsibleCounties)

# NOTE: use dir(<response>) to see the attributes on a given endpoint, i.e.:
print(dir(office))
```


