このプロジェクトについて

# odp-stockholm スウェーデン・ストックホルム市のオープンデータセット向けの非同期Pythonクライアントです。市が提供するOpen Data Platform APIと通信することで、PythonアプリケーションがHTTPリクエストを手書きすることなくデータセットをプルできるようにします。 ## 機能 このパッケージは元々駐車データのみを取得するために構築されましたが、後で同じプラットフォームの他のデータセットを追加できるよう、コードベースが意図的に整理されています。現在、READMEでは以下の1つのデータセットについて説明しています: - **障害者用駐車場** (rörelsehindrade förare med särskilt tillstånd) — 約2045箇所。 ## 要件とアクセス データの利用にはAPIキーが必要であり、プラットフォームのウェブサイトからリクエストできます。本プロジェクトはPython 3.12以降をターゲットとしており、PyPIで `odp-stockholm` として配布されています。 ## インストールと使用方法 ```bash pip install odp-stockholm ``` クライアントは非同期コンテキストマネージャーとして使用されます。ドキュメントの例では、APIキーを使用して `ParkingStockholm` をインスタンス化し、`disabled_parkings(limit=10)` を呼び出して、返された場所を出力しています。 ## データセットのフィールド リクエストは `limit` パラメータ(デフォルト10)を受け付けます。返されるレコードには以下が含まれます: - `location_id`、`location_type`、駐車スペースの `number` - `street`、`address`、`district` - `parking_rate` および `parking_rules`(ストックホルム市の駐車規則へのURL) - `valid_from` および `valid_to`(後者は `None` の場合があります) - 浮動小数点数のリストとしての `coordinates` ## 開発セットアップ 本プロジェクトは依存関係管理にPoetryを使用しており、VS Code Dev ContainerまたはGitHub CodeSpaceで開くことができます。コミットは `prek` フックフレームワーク(`poetry run prek install`、`poetry run prek run --all-files`)を通じてリンティングとテストが行われます。テストにはpytestを使用しており、`poetry run pytest --snapshot-update` で更新可能なsyrupyスナップショットテストが含まれています。 ## ライセンス MITライセンスの下でリリースされており、著作権はKlaas Schoute (2023–2026) に帰属します。 ## 評価者への注意 これはフルアプリケーションではなく、特化したデータアクセスライブラリです。その価値は、自治体のオープンデータソースへの型定義された非同期アクセスを提供すること、および他のストックホルム市のデータセットに拡張可能なテンプレートを提供することにあります。本プロジェクトはストックホルム市と提携または承認されたものではありません。ユーザーは自身のAPIキーを提供し、プラットフォームの利用規約に従う必要があります。