Transport NSW

🚀 運輸 NSW API クライアント（MCP 実装）

このプロジェクトは、直接的な HTTP リクエストを使用して運輸 NSW API とやり取りする Model Context Protocol (MCP) サービスの実装です。

📚 概要

このプロジェクトは、運輸 NSW の API 用に Model Context Protocol サービスを実装しています。

📦 インストール

1. このリポジトリをクローンします。
2. uv（高速 Python パッケージマネージャー）を使用して依存関係をインストールします。

   uv venv
   uv sync
   

3. .env ファイルを作成し、API キーを追加します。

   OPEN_TRANSPORT_API_KEY=your_api_key_here
   

4. （オプション）MCP チェックツールを実行します。

   uv run mcp dev api.py
   

   そして、サーバー http://localhost:5173（ポートは異なる場合があります）にアクセスします。

✨ 主な機能

• 停留所検索 API：名前または座標で輸送の停留所を検索します。
• 警報 API：輸送の中断や警報情報を取得します。
• 出発監視 API：輸送の停留所のリアルタイムの出発情報を取得します。
• MCP 実装：Model Context Protocol サービスとして構造化されています。

💻 使用例

基本的な使用法

輸送停留所の検索

from api import find_transport_stops

# 名前で検索
stops = find_transport_stops(stop_name="Central Station")

# 座標（中央駅エリア）で検索
central_station = '151.206290:-33.884080:EPSG:4326'
stops = find_transport_stops(coord=central_station, radius=500)

輸送警報の取得

from api import get_transport_alerts

# すべての現在の警報を取得
alerts = get_transport_alerts()

# 特定の日付の警報を取得
date_alerts = get_transport_alerts(date='22-03-2025')

# 列車の警報を取得（mot_type=1）
train_alerts = get_transport_alerts(mot_type=1)

リアルタイム出発情報の監視

from api import get_departure_monitor

# 中央駅の出発情報を取得
departures = get_departure_monitor("200060")  # 中央駅の ID

# 特定の時間の出発情報を取得
from datetime import datetime
time_departures = get_departure_monitor("200060", time="15:30")

# 列車の出発情報のみを取得
train_departures = get_departure_monitor("200060", mot_type=1)  # 1 = 列車

高度な使用法

デモスクリプトの実行

このプロジェクトには、すべての API 機能を示す包括的なデモスクリプトが含まれています。

# 完全なデモを実行
python demo.py

# 特定の部分を実行
python demo.py --stops       # 停留所検索デモ
python demo.py --alerts      # 輸送警報デモ
python demo.py --departures  # 出発監視デモ

🔧 テスト

ローカルテスト

pytest を使用して完全なテストスイートを実行します。

uv run pytest

カバレッジレポート付きのテストを実行します。

uv run pytest --cov=api

継続的インテグレーション

GitHub Actions は、メインブランチへの各プッシュとプルリクエストに対して自動的にテストを実行します。ワークフローは以下の通りです。

1. Python 3.10 環境を設定します。
2. uv とプロジェクトの依存関係をインストールします。
3. カバレッジレポート付きのテストを実行します。

この機能を使用するには、以下の手順を実行します。

1. OPEN_TRANSPORT_API_KEY を GitHub リポジトリのシークレットとして追加します。
2. コードを GitHub にプッシュします。

🛠️ MCP 統合

このプロジェクトは、Model Context Protocol 仕様に準拠しており、AI モデルが標準化されたインターフェイスを介して運輸 NSW データにアクセスできるようにします。

📦 パッケージ管理

このプロジェクトは、Rust で書かれた最新の Python パッケージマネージャーである uv を使用しています。依存関係は以下の方法で管理されます。

• pyproject.toml：プロジェクトの依存関係を定義します。
• uv.lock：依存関係のバージョンをロックして、再現可能な環境を確保します。