Skip to content

doc: add deprecation warning #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SlowMo24 merged 11 commits into from
Jul 24, 2026
Merged

doc: add deprecation warning #187

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
88e1e2f
feat(client): add deprecation warning
SlowMo24 Jul 9, 2026
0cc36ee
Update README.md
SlowMo24 Jul 17, 2026
452833a
Apply suggestion from @matthiasschaub
SlowMo24 Jul 17, 2026
f18d21e
doc(warning): finalise
SlowMo24 Jul 17, 2026
e72bbb2
fix: import
SlowMo24 Jul 17, 2026
674c098
Merge branch 'master' into add-warning
SlowMo24 Jul 21, 2026
586e759
fix: lint
SlowMo24 Jul 21, 2026
1e1c19e
doc: update warning
SlowMo24 Jul 22, 2026
c6cbdd1
doc: update url
SlowMo24 Jul 24, 2026
e09fb0e
doc: update changelog
SlowMo24 Jul 24, 2026
a97315d
doc: update version
SlowMo24 Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# ohsome-py: A Python client for the ohsome API


> [!WARNING]
Comment thread
SlowMo24 marked this conversation as resolved.
Outdated
> The ohsome API v1 is reaching end of life in October 2026.
> This library currently only supports ohsome API v1.
> The fate of the ohsome-py library is not yet decided, a newer version MAY support ohsome-API V2.
> To move to Ohsome-API V2 independently please see the migration instructions at https://api.heigit.org/ohsome-api-staging/v2/docs.
Comment thread
SlowMo24 marked this conversation as resolved.
Outdated
Comment thread
SlowMo24 marked this conversation as resolved.
Outdated

[![status: active](https://github.com/GIScience/badges/raw/master/status/active.svg)](https://github.com/GIScience/badges#active)

The *ohsome-py* package helps you extract and analyse OpenStreetMap history data using the [ohsome API](https://docs.ohsome.org/ohsome-api/v1/) and Python. It handles queries to the [ohsome API](https://docs.ohsome.org/ohsome-api/v1/) and converts its responses to [Pandas](https://pandas.pydata.org/) and [GeoPandas](https://geopandas.org/) data frames to facilitate easy data handling and analysis.
Expand Down
11 changes: 11 additions & 0 deletions ohsome/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,19 @@
# -*- coding: utf-8 -*-

"""Ohsome API client for Python"""
import warnings

# The order of imports here must remain to prevent circular imports
from .exceptions import OhsomeException # noqa
from .response import OhsomeResponse # noqa
from .clients import OhsomeClient # noqa

warnings.warn(
message="Ohsome-API V1 is reaching end-of-life in October 2026. "
"The ohsome-py library currently only supports ohsome API v1. "
"This version of ohsome-py will stop working in October 2026. "
"The fate of the ohsome-py library is not yet decided, a newer version MAY support ohsome-API V2. "
"To move to Ohsome-API V2 independently please see the migration instructions at https://api.heigit.org/ohsome-api-staging/v2/docs.",
category=DeprecationWarning,
stacklevel=1,
)
Loading