Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aoirint/aoirint_jmapy
気象庁天気予報データの非公式Pythonラッパー
https://github.com/aoirint/aoirint_jmapy
Last synced: about 2 months ago
JSON representation
気象庁天気予報データの非公式Pythonラッパー
- Host: GitHub
- URL: https://github.com/aoirint/aoirint_jmapy
- Owner: aoirint
- License: mit
- Created: 2022-05-27T02:22:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-10T04:19:07.000Z (6 months ago)
- Last Synced: 2024-11-20T17:05:56.659Z (about 2 months ago)
- Language: Python
- Homepage: https://pypi.org/project/aoirint-jmapy/
- Size: 57.6 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# aoirint_jmapy
Unofficial JMA weather forecast API wrapper in Python
気象庁天気予報データの非公式Pythonラッパー
2022-05-27時点のAPIに対応
- 気象庁の天気予報ページ:
- 気象庁ホームページ コンテンツの利用規約:
## Install
```shell
pip3 install aoirint_jmapy
```
## Usage
### 東京都 東京地方のデータを見る例
```python
from aoirint_jmapy import JmaApi, Telops
# UserAgentに含めるため、あなたのアプリケーション名、バージョンを設定することを推奨
# UserAgentは次のようになります: MyWeatherApp 0.1.0 / aoirint_jmapy 20220527.4
# アプリケーションを一般に配布する場合、不具合等により不特定多数の端末から
# 気象庁のサーバに負荷をかけることがないように、自分でキャッシュサーバを立てること等を推奨
# jma_url以下のパスを揃えると切り替えできる
jma = JmaApi(
jma_url='https://www.jma.go.jp',
app_name='MyWeatherApp',
app_version='0.1.0',
)
# 東京都
forecast = jma.forecast(area_id='130000')
print(forecast)
## 東京地方
print(forecast[0])
### 3日間予報
print(forecast[0].timeSeries[0])
### 週間予報
print(forecast[0].timeSeries[1])
### 3日間天気概況
overview_forecast = jma.overview_forecast(area_id='130000')
print(overview_forecast.text)
### 週間天気概況
overview_week = jma.overview_week(area_id='130000')
print(overview_week.text)
# WeatherCodeを対応するテキストにする（Third party contentsの項を参照）
weather_code = '101'
print(Telops[weather_code][3]) # 晴時々曇
```
### area_idを調べる
- ※ 単一の地点のみでいい場合、気象庁の天気予報ページから手動で選択して実際のリクエストURLから抽出する方が簡単
```python
# エリアリスト
area = jma.area()
## センターリスト（気象台リスト）
print(area.centers)
### 北海道地方: center_id=010100
#### 宗谷地方: area_id=011000
#### 上川・留萌地方: area_id=012000
print(area.centers['010100'])
### 関東甲信地方: center_id=010300
#### 東京都: area_id=130000
#### 神奈川県: area_id=140000
print(area.centers['010300'])
```
### Supported data url list
- https://www.jma.go.jp/bosai/common/const/area.json
- https://www.jma.go.jp/bosai/forecast/const/forecast_area.json
- https://www.jma.go.jp/bosai/forecast/const/en_amedas.json
- https://www.jma.go.jp/bosai/forecast/const/anniversary.json
- https://www.jma.go.jp/bosai/forecast/const/week_area.json
- https://www.jma.go.jp/bosai/forecast/const/week_area05.json
- https://www.jma.go.jp/bosai/forecast/const/week_area_name.json
- https://www.jma.go.jp/bosai/forecast/data/overview_forecast/{area_id}.json
- https://www.jma.go.jp/bosai/forecast/data/overview_week/{area_id}.json
- https://www.jma.go.jp/bosai/forecast/data/forecast/{area_id}.json
- https://www.jma.go.jp/bosai/warning/data/warning/{area_id}.json
## Third party contents
「晴」「曇後雨」などのテキストは、API中で`weatherCode`という数値IDで識別されます。
この数値IDに対応するテキストはAPIから取得できず、JavaScriptコードとして埋め込まれています。
利便性のため、この辞書をダンプしたものをライブラリに同梱し、コード中から参照できるようにしています。
- `aoirint_jmapy/static/const_telops.json`
- データの出典: 気象庁ホームページ
- 気象庁ホームページ コンテンツの利用規約:
### Update const_telops.json
を開く。
開発者ツールで以下を実行、出力をコピーして貼り付けする。
```js
console.log(JSON.stringify(Forecast.Const.TELOPS))
```
## Development
### Environment
```shell
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
```
### Lock dependencies
```shell
pip3 install pip-tools
pip-compile requirements.in
pip-compile requirements.test.in
```
### Test
```shell
# Download some JMA API response for test
./get_testdata.sh
pip3 install -r requirements.test.txt
mypy aoirint_jmapy/
pytest tests/
```
### Release
GitHub Releaseを作成するとGitHub Actionsにより自動でPyPIにリリースされる。