Об этом проекте
# odp-stockholm
Асинхронный Python-клиент для открытых наборов данных Стокгольма, Швеция. Он взаимодействует с API Open Data Platform города, чтобы 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
```
Клиент используется как асинхронный контекстный менеджер. В задокументированном примере создается экземпляр `ParkingStockholm` с API-ключом и вызывается метод `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, включая snapshot-тесты syrupy, которые можно обновить с помощью `poetry run pytest --snapshot-update`.
## Лицензирование
Выпущено под лицензией MIT, авторское право Klaas Schoute (2023–2026).
## Примечания для оценивающих
Это специализированная библиотека для доступа к данным, а не полноценное приложение: ее ценность заключается в предоставлении типизированного асинхронного доступа к муниципальному источнику открытых данных и шаблона, который можно расширить на другие наборы данных Стокгольма. Проект не связан с администрацией города Стокгольм и не одобрен ею; пользователи предоставляют собственный API-ключ и соблюдают условия платформы.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.