Skip to main content

Caiyun Weather API Python SDK

Project description

Caiyun Weather API Python SDK

[!NOTE]

This project is not officially supported by ColorfulClouds Technology.

It's open sourced under MIT License and designed as a debug tool for our internal systems instead of online services, or third party technology support.

Install

Python 3.12+ is required.

pip install cy-weather-api

Usage

Request Caiyun API

NOTE: TAkhjf8d1nlSlspN is test token, no one can ensure its availability.

from cy_weather_api import CyWeatherAPIClient

client = CyWeatherAPIClient(token="TAkhjf8d1nlSlspN")

api_result = client.fetch(lng=101.8551, lat=26.6832, lang="zh_CN", alert=True)
print(api_result.result.hourly.description)

api_result = client.fetch(lng=-0.2008, lat=51.5024, lang="en_GB")
print(api_result.result.hourly.description)

api_result = client.fetch(lng=73.9808, lat=40.7648, lang="en_US")
print(api_result.result.hourly.description)

Output sample:

晴,今天晚间20点钟后转小雨,其后多云
clear weather over the next 24 hours
clear weather, overcast after 20 o'clock this afternoon, followed by cloudy

Use our dataclass models

The default HTTP client is httpx, you can use other HTTP client to request API, and pass the response dict to our models (based on dataclass):

from cy_weather_api import CyWeatherResponse

data = {
    "status": "ok",
    "api_version": "v2.6",
    "api_status": "active",
    "lang": "en_US",
    "unit": "metric",
    "tzshift": 28800,
    "timezone": "Asia/Shanghai",
    "server_time": 1589125757,
    "location": [39.888888, 116.674501],
    "result": {"forecast_keypoint": "test forecast_keypoint", "primary": 0},
}
result = CyWeatherResponse.from_dict(data)

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

cy_weather_api-0.2.2.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

cy_weather_api-0.2.2-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file cy_weather_api-0.2.2.tar.gz.

File metadata

  • Download URL: cy_weather_api-0.2.2.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.4.30

File hashes

Hashes for cy_weather_api-0.2.2.tar.gz
Algorithm Hash digest
SHA256 c589d7c288e85ccdc961fc3de41e29dad77c15bddd8aa5163bbb9cf9963cecbe
MD5 fe06dcac33280a75a9bb81dbbd7e8871
BLAKE2b-256 bc0967b542492d515b1cbe668f7c2edbe2f931bde8999bcebcbf7fd92d0fbf4e

See more details on using hashes here.

File details

Details for the file cy_weather_api-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for cy_weather_api-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0b8b414f8899bd81ae67b08f067073a34c6853d19014c530882cd916e7002bbd
MD5 5536238db469604f3cf9470f8e084841
BLAKE2b-256 5df352b6971b64e56b9555dc2478e6034f176b12fd4d3a09fa25c3b878c8842d

See more details on using hashes here.

Supported by

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