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.

Installation

pip install get-weather-api

📘 Usage

from get_weather.client import get_weather_data
import os
os.environ["API_KEY"] = "API_KEY"

df = get_weather_data(
    weather_station="RJAA",
    country_code="JP",
    startDate="20190201",
    endDate="20190301",
    timezone="US/Pacific"
)
print(df.head())

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.

🔧 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]
    

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.2.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.2-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: get_weather_api-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 dba18f3c86c91fa66c14bac4c3cc22cf38ad6cc84592c939371a84ac4dab2bc6
MD5 34c927743c8bcf9585f3b308e450753f
BLAKE2b-256 7fbf0b1f6adf94ed84508eee4454c562af48418b605d31b488f978344009a0a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for get_weather_api-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 32935b184ea0d27cba90a47553b28847a376709aec2acfbfada23249f2fb8916
MD5 fab2dae491ad8be8d363972e2f9e3cc8
BLAKE2b-256 a9d453370684748c6374dfa2e1f21b7ec5b301e46bc1ac611a0ca0534aeb0843

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