Skip to main content

A Python wrapper for the WeatherKit API

Project description

PyWeatherKit

A simple Python wrapper for Apple's WeatherKit REST API.

You need an Apple developer account to use this library and you should first follow the setup instructions in their documentation.

It has a simple interface for retrieving a raw dictionary of weather data from the API, and a method for retrieving simplified daily forecasts as Pythonic objects. Pull requests are welcome!

Install

pip install pyweatherkit

Simple Forecast Usage

from weatherkit.client import WKClient 
client = WKClient("YOUR TEAM ID", "YOUR SERVICE ID", "YOUR KEY ID", "PATH TO YOUR PRIVATE KEY FILE")
forecast = client.get_simple_forecast(latitude, longitude)
for day in forecast:
    print(f"{day.day_of_week}: {day.daytime_icon} with a high of {round(day.temperature_high)} and a low of {round(day.temperature_low)}")

Assuming you input all of the correct client authentication parameters and a valid latitude and longitude, this should result in something like:

Thursday: 🌤️ with a high of 38 and a low of 23
Friday: 🌧️ with a high of 45 and a low of 22
Saturday: 🌧️ with a high of 67 and a low of 40
...

Pulling Full Data Sets

from weatherkit.client import WKClient 
client = WKClient("YOUR TEAM ID", "YOUR SERVICE ID", "YOUR KEY ID", "PATH TO YOUR PRIVATE KEY FILE")
res = client.get_weather(44.50572, -73.24026)

You can also specify the language of the response, the timezone, and the specific datasets you need.

Historical Data Pull

Only available from dates after 08/01/2021 (as of 2023-03-23)

from weatherkit.client import WKClient
from datetime import datetime

# Set dates 
dailyStart = datetime.strptime("2022-11-29", "%Y-%m-%d")
dailyEnd = datetime.strptime("2022-11-30", "%Y-%m-%d")
currentAsOf = datetime.strptime("2022-11-29", "%Y-%m-%d")

client = WKClient("YOUR TEAM ID", "YOUR SERVICE ID", "YOUR KEY ID", "PATH TO YOUR PRIVATE KEY FILE")
res = client.get_weather(44.50572, -73.24026, dailyStart=dailyStart, dailyEnd=dailyEnd, currentAsOf=currentAsOf)

Test/Example Program

Try running simple_test.py from the same directory as this package.

python3 simple_test.py your_team_id your_service_id your_key_id your_key_path your_latitude your_longitude

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

PyWeatherKit-0.0.3.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

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

pyweatherkit-0.0.3-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file PyWeatherKit-0.0.3.tar.gz.

File metadata

  • Download URL: PyWeatherKit-0.0.3.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for PyWeatherKit-0.0.3.tar.gz
Algorithm Hash digest
SHA256 5a5041756a8ef294d31b2dc78a590dbea2ac66b950850a3d9e07062c3f992d7b
MD5 cdc5d4b10a98b489b653804dd12ef593
BLAKE2b-256 3f221dc40352bdedc145a3654c1b716cd2c0b54dc6757b286333368c5d0270c4

See more details on using hashes here.

File details

Details for the file pyweatherkit-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: pyweatherkit-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for pyweatherkit-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9fc8d95095409e289af2a3deb8c3dd316b553e601d72edb8906d0a84b85a0297
MD5 9415746c0593b9d96f8aa4833d622f36
BLAKE2b-256 132566613c9bb91f536036462eab96c59682e433ba626dc65ec02947d2e3df9b

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