langchain/docs/integrations/openweathermap.md
Leonid Ganeline 1f11f80641
docs: cleaning (#5413)
# docs cleaning

Changed docs to consistent format (probably, we need an official doc
integration template):
- ClearML - added product descriptions; changed title/headers
- Rebuff  - added product descriptions; changed title/headers
- WhyLabs  - added product descriptions; changed title/headers
- Docugami - changed title/headers/structure
- Airbyte - fixed title
- Wolfram Alpha - added descriptions, fixed title
- OpenWeatherMap -  - added product descriptions; changed title/headers
- Unstructured - changed description

## Who can review?

Community members can review the PR once tests pass. Tag
maintainers/contributors who might be interested:

@hwchase17
@dev2049
2023-05-30 13:58:16 -07:00

45 lines
1.2 KiB
Markdown

# OpenWeatherMap
>[OpenWeatherMap](https://openweathermap.org/api/) provides all essential weather data for a specific location:
>- Current weather
>- Minute forecast for 1 hour
>- Hourly forecast for 48 hours
>- Daily forecast for 8 days
>- National weather alerts
>- Historical weather data for 40+ years back
This page covers how to use the `OpenWeatherMap API` within LangChain.
## Installation and Setup
- Install requirements with
```bash
pip install pyowm
```
- Go to OpenWeatherMap and sign up for an account to get your API key [here](https://openweathermap.org/api/)
- Set your API key as `OPENWEATHERMAP_API_KEY` environment variable
## Wrappers
### Utility
There exists a OpenWeatherMapAPIWrapper utility which wraps this API. To import this utility:
```python
from langchain.utilities.openweathermap import OpenWeatherMapAPIWrapper
```
For a more detailed walkthrough of this wrapper, see [this notebook](../modules/agents/tools/examples/openweathermap.ipynb).
### Tool
You can also easily load this wrapper as a Tool (to use with an Agent).
You can do this with:
```python
from langchain.agents import load_tools
tools = load_tools(["openweathermap-api"])
```
For more information on this, see [this page](../modules/agents/tools/getting_started.md)