Skip to main content

A simple API key example package

Project description

📦 Weather Data Client

This package includes a function to fetch and preprocess historical weather data from Weatherunderground.com.

🔧 Setup

  1. Create a .env file with your API key:

    echo "API_KEY=your_actual_api_key_here" > .env
    
  2. Install the package:

    pip install .
    
  3. (Optional) Install dev dependencies:

    pip install .[dev]
    

📘 Usage

import getweatherunderground.client as gwu
import os
os.environ["API_KEY"] = "ADD_API_KEY"

df = gwu.get_weather_data(
    weather_station="RJAA",
    country_code="JP",
    startDate="20190201",
    endDate="20190301",
    timezone="US/Pacific"
)
print(df.head())
Dataframe Sample
Feature Type Example
Time datetime 2019-01-31 00:00:00
tempf float 32.0
dewPt int 32
rh int 100
wdir_cardinal string NNW
wspd float 9.0
gust int 0
pressure float 29.47
precip float 0.0
wx_phrase string Light Snow Shower

Parameters

Parameters can be obtained from https://www.wunderground.com/. For a desired location follow these steps.

  1. Search locations in the upper right. For example Manila, Philippines.
  2. Click the history tab and identify the weather station which would be the last parameter in the URL:
    https://www.wunderground.com/history/daily/ph/manila/RPLL
    
    Here it would be RPLL.
  3. The country code would be the third to the last parameter: PH
  4. Timezone would be what you want the data to be encoded in, for Manila it would be 'Asia/Manila'
  5. Start and end dates must be strings in the form of YYYYMMDD. The minimum window should be 1 month. i.e., 20201001 to 20201101.

Thus the arguments you would use would be: df = get_weather_data(weather_station="RPLL", country_code="PH", startDate="20201001", endDate="20201101", timezone="Asia/Manila")

📊 Weather Feature Descriptions

Column Description
Time The timestamp of the weather observation, converted from GMT to your specified timezone. This is usually reported in hourly intervals and used as the index for the DataFrame.
tempf Air temperature in degrees Fahrenheit at the time of observation.
dewPt Dew point in degrees Fahrenheit – the temperature at which air becomes saturated and dew can form. Used to assess humidity.
rh Relative Humidity in percentage (%). Indicates how much moisture is in the air compared to the maximum possible at that temperature.
wdir_cardinal Wind direction as a cardinal compass point (e.g., "N", "NE", "W"). Reflects the direction from which the wind is blowing.
wspd Wind speed in miles per hour (mph). Average wind speed during the observation window.
gust Wind gust in mph. Peak wind speed recorded during the observation window. May be missing or zero if conditions were calm.
pressure Atmospheric pressure in inches of mercury (inHg). Often used in weather forecasting (e.g., identifying high/low pressure systems).
precip Total precipitation during the hour in inches (rain, snow water equivalent, etc.). May be "0.0" if no measurable precipitation occurred.
wx_phrase Textual weather summary, e.g., "Partly Cloudy", "Rain Showers", "Snow", etc. Useful for quick human-readable interpretation of the weather conditions.

These fields provide a well-rounded snapshot of surface-level atmospheric conditions and are commonly used in:

  • Climate studies
  • Forecast verification
  • Event-driven analyses (e.g., during storm events)
  • Transportation or agriculture modeling

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

get_weather_api-0.1.5.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

get_weather_api-0.1.5-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file get_weather_api-0.1.5.tar.gz.

File metadata

  • Download URL: get_weather_api-0.1.5.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for get_weather_api-0.1.5.tar.gz
Algorithm Hash digest
SHA256 651b361b2bfb7ac4e0e5c0ee783a1fdefe174b3b653266429d3af328f21928ff
MD5 996b92a4a8f45d949ebba4c5a69ecd1c
BLAKE2b-256 782c79d877131b5c93fe3e3f662b86bdb8778dec6c169822846e4f05b1fdcc46

See more details on using hashes here.

File details

Details for the file get_weather_api-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for get_weather_api-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 535d0afb805bafcc8e46504e5b4522e580718f84f53c6ac3ea648bf128d7a45a
MD5 bf451393d39d28c790502ffe05122e34
BLAKE2b-256 e664d9febfa04b2c36886e44aa4471f9a4a6516e8dfa10dd536d876baeb30a6a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page