这个项目能做什么
# odp-stockholm
一个用于瑞典斯德哥尔摩开放数据集的异步 Python 客户端。它与城市的 Open Data Platform API 通信,使 Python 应用程序无需手动编写 HTTP 请求即可拉取数据集。
## 功能
该软件包最初旨在仅获取停车数据,但代码库经过刻意组织,以便后续添加来自同一平台的其他数据集。README 目前记录了一个数据集:
- **残疾人停车位** (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` 钩子框架进行 lint 检查和测试(`poetry run prek install`, `poetry run prek run --all-files`)。测试使用 pytest,包括可以通过 `poetry run pytest --snapshot-update` 刷新的 syrupy 快照测试。
## 许可
基于 MIT 许可证发布,版权所有 Klaas Schoute (2023–2026)。
## 评估者注意事项
这是一个专注的数据访问库而非完整应用程序:其价值在于为市政开放数据源提供类型化、异步的访问方式,并为扩展至更多斯德哥尔摩数据集提供模板。它不隶属于且未获得斯德哥尔摩市的认可;用户需提供自己的 API 密钥并遵守平台的条款。
评论
0 评分人数达到10人后显示
登录后参与讨论。