Release 5.0.0

.github/workflows/build.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v4

.github/workflows/publish_python.yml

@@ -1,4 +1,3 @@
-# workflow inspired by chezou/tabula-py
 name: Upload Python Package
 
 on:
@@ -14,7 +13,7 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v4
@@ -46,7 +45,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.8'
+        python-version: '3.9'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.pre-commit-config.yaml

@@ -3,9 +3,15 @@ repos:
     rev: 23.7.0
     hooks:
       - id: black
-        language_version: python3.8
+        language_version: python3.12
   - repo: https://github.com/pycqa/flake8
     rev: 6.0.0
     hooks:
       - id: flake8
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-requests]
+        args: [--config-file=setup.cfg]
 

CHANGELOG.md

@@ -4,6 +4,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+## [5.0.0] - 2026-02-18
+### Changed
+- **BC-Break**: Remove support for Python 3.8, new minimum version for osmapi is Python 3.9
+- **BC-Break**: Renamed all methods as `snake_case` instead of `CamelCase`(eg. `osmapi.node_get` instead of `osmapi.NodeGet`). The previous methods are still there, but all issue a `DeprecationWarning` when called.
+- While changing the public API of osmapi, the large `OsmApi.py` file was split into several smaller files.
+
+### Added
+- Add type hints and mypy checking to osmapi #186
+
+### Removed
+- Remove autochangeset feature in favor of Changeset context manager #187
+
 ## [4.3.0] - 2025-01-21
 ### Added
 - New `ConnectionApiError` when a connection or network error occurs (see issue #176, thanks [Mateusz Konieczny](https://github.com/matkoniecz))
@@ -367,7 +379,8 @@ Miroslav Šedivý
 - `Fixed` for any bug fixes.
 - `Security` to invite users to upgrade in case of vulnerabilities.
 
-[Unreleased]: https://github.com/metaodi/osmapi/compare/v4.3.0...HEAD
+[Unreleased]: https://github.com/metaodi/osmapi/compare/v5.0.0...HEAD
+[5.0.0]: https://github.com/metaodi/osmapi/compare/v4.3.0...v5.0.0
 [4.3.0]: https://github.com/metaodi/osmapi/compare/v4.2.0...v4.3.0
 [4.2.0]: https://github.com/metaodi/osmapi/compare/v4.1.0...v4.2.0
 [4.1.0]: https://github.com/metaodi/osmapi/compare/v4.0.0...v4.1.0

Makefile

@@ -21,6 +21,7 @@ format:  ## Format source code (black codestyle)
 lint:  ## Linting of source code
 	python -m black --check --diff osmapi examples tests *.py
 	python -m flake8 --statistics --show-source .
+	python -m mypy osmapi
 
 test:  ## Run tests (run in UTF-8 mode in Windows)
 	python -Xutf8 -m pytest --cov=osmapi tests/

README.md

@@ -9,7 +9,9 @@ osmapi
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 
 
-Python wrapper for the OSM API (requires Python >= 3.8)
+Python wrapper for the OSM API (requires Python >= 3.9).
+
+**NOTE**: Since version 5.0 of this library, all method names are in `snake_case`, the `CamelCase` versions are deprecated and will be removed in version 6.0.
 
 ## Installation
 
@@ -36,10 +38,11 @@ Check the [examples directory](https://github.com/metaodi/osmapi/tree/develop/ex
 
 ### Read from OpenStreetMap
 
+
 ```python
 >>> import osmapi
 >>> api = osmapi.OsmApi()
->>> print(api.NodeGet(123))
+>>> print(api.node_get(123))
 {'changeset': 532907, 'uid': 14298,
 'timestamp': '2007-09-29T09:19:17Z',
 'lon': 10.790009299999999, 'visible': True,
@@ -49,13 +52,14 @@ Check the [examples directory](https://github.com/metaodi/osmapi/tree/develop/ex
 
 ### Write to OpenStreetMap
 
+
 ```python
 >>> import osmapi
 >>> api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org", username = "metaodi", password = "*******")
->>> api.ChangesetCreate({"comment": "My first test"})
->>> print(api.NodeCreate({"lon":1, "lat":1, "tag": {}}))
+>>> api.changeset_create({"comment": "My first test"})
+>>> print(api.node_create({"lon":1, "lat":1, "tag": {}}))
 {'changeset': 532907, 'lon': 1, 'version': 1, 'lat': 1, 'tag': {}, 'id': 164684}
->>> api.ChangesetClose()
+>>> api.changeset_close()
 ```
 
 ### OAuth authentication
@@ -69,6 +73,8 @@ To use OAuth 2.0, you must register an application with an OpenStreetMap account
 or on the [production server](https://www.openstreetmap.org/oauth2/applications).
 Once this registration is done, you'll get a `client_id` and a `client_secret` that you can use to authenticate users.
 
+auth = OpenStreetMapDevAuth(
+
 Example code using [`cli-oauth2`](https://github.com/Zverik/cli-oauth2) on the development server, replace `OpenStreetMapDevAuth` with `OpenStreetMapAuth` to use the production server:
 
 ```python
@@ -87,9 +93,9 @@ api = osmapi.OsmApi(
     session=auth.session
 )
 
-with api.Changeset({"comment": "My first test"}) as changeset_id:
+with api.changeset({"comment": "My first test"}) as changeset_id:
     print(f"Part of Changeset {changeset_id}")
-    node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
+    node1 = api.node_create({"lon": 1, "lat": 1, "tag": {}})
     print(node1)
 ```
 
@@ -103,6 +109,7 @@ To credit the application that supplies changes to OSM, an `appid` can be provid
 This is a string identifying the application.
 If this is omitted "osmapi" is used.
 
+
 ```python
 api = osmapi.OsmApi(
     api="https://api06.dev.openstreetmap.org",

examples/changesets.py

@@ -1,14 +1,17 @@
 import osmapi
 from pprint import pprint
 
+
 api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org")
 
+
 try:
-    api.ChangesetGet(111111111111)
+    api.changeset_get(111111111111)
 except osmapi.ApiError as e:
     print(f"Error: {e}")
     if e.status == 404:
         print("Changeset not found")
 
+
 print("")
-pprint(api.ChangesetGet(12345))
+pprint(api.changeset_get(12345))

examples/error_handling.py

@@ -9,7 +9,6 @@
 import sys
 import urllib3
 
-
 load_dotenv(find_dotenv())
 
 # logging setup
@@ -43,7 +42,7 @@ def clear_screen():
 log.debug("Try to write data to OSM without a changeset")
 api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org")
 try:
-    node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
+    node1 = api.node_create({"lon": 1, "lat": 1, "tag": {}})
 except osmapi.NoChangesetOpenError as e:
     log.exception(e)
     log.debug("There is no open changeset")
@@ -55,7 +54,7 @@ def clear_screen():
 log.debug("Connect to wrong server...")
 api = osmapi.OsmApi(api="https://invalid.server.name")
 try:
-    api.ChangesetGet(123)
+    api.changeset_get(123)
 except osmapi.ConnectionApiError as e:
     log.exception(e)
     log.debug("Error connecting to server")
@@ -67,7 +66,7 @@ def clear_screen():
 log.debug("Request non-existent changeset id...")
 api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org")
 try:
-    api.ChangesetGet(111111111111)
+    api.changeset_get(111111111111)
 except osmapi.ElementNotFoundApiError as e:
     log.exception(e)
     log.debug("Changeset not found")
@@ -81,8 +80,8 @@ def clear_screen():
     s = requests.Session()
     s.auth = ("user", "pass")
     api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org", session=s)
-    with api.Changeset({"comment": "My first test"}) as changeset_id:
-        node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
+    with api.changeset({"comment": "My first test"}) as changeset_id:
+        node1 = api.node_create({"lon": 1, "lat": 1, "tag": {}})
 except osmapi.UnauthorizedApiError as e:
     log.exception(e)
     log.debug("Unauthorized to make this request")
@@ -93,8 +92,8 @@ def clear_screen():
 log.debug("Try to add data without authorization")
 try:
     api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org")
-    with api.Changeset({"comment": "My first test"}) as changeset_id:
-        node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
+    with api.changeset({"comment": "My first test"}) as changeset_id:
+        node1 = api.node_create({"lon": 1, "lat": 1, "tag": {}})
 except osmapi.UsernamePasswordMissingError as e:
     log.exception(e)
     log.debug("Username/Password or authorization missing")
@@ -117,13 +116,13 @@ def clear_screen():
 
 try:
     api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org", session=auth.session)
-    with api.Changeset({"comment": "My first test"}) as changeset_id:
+    with api.changeset({"comment": "My first test"}) as changeset_id:
         log.debug(f"Part of Changeset {changeset_id}")
-        node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
+        node1 = api.node_create({"lon": 1, "lat": 1, "tag": {}})
         log.debug(node1)
 
     # get all the info from the closed changeset
-    changeset = api.ChangesetGet(changeset_id)
+    changeset = api.changeset_get(changeset_id)
     log.debug(changeset)
     exit_code = 0
 except osmapi.ConnectionApiError as e:

examples/log_output.py

@@ -19,5 +19,5 @@
 
 
 api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org")
-node1 = api.NodeGet("1111")
+node1 = api.node_get("1111")
 log.debug(pformat(node1))

examples/notes.py

@@ -1,47 +1,51 @@
 import osmapi
+from oauthcli import OpenStreetMapDevAuth
 from dotenv import load_dotenv, find_dotenv
 import os
 from pprint import pprint
 
 load_dotenv(find_dotenv())
-user = os.getenv("OSM_USER")
-pw = os.getenv("OSM_PASS")
 
-api = osmapi.OsmApi(
-    api="https://api06.dev.openstreetmap.org", username=user, password=pw
-)
-empty_notes = api.NotesGet(
+# load secrets for OAuth
+client_id = os.getenv("OSM_OAUTH_CLIENT_ID")
+client_secret = os.getenv("OSM_OAUTH_CLIENT_SECRET")
+
+auth = OpenStreetMapDevAuth(
+    client_id, client_secret, ["write_api", "write_notes"]
+).auth_code()
+
+api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org", session=auth.session)
+empty_notes = api.notes_get(
     -93.8472901, 35.9763601, -80, 36.176360100000004, limit=1, closed=0
 )
 pprint(empty_notes)
 
 
 # create note and then search for it
-note = api.NoteCreate(
+note = api.note_create(
     {
         "lat": 47.3383501,
         "lon": 8.5339522,
         "text": "test note",
     }
 )
-test_notes = api.NotesGet(8.527504, 47.337063, 8.540679, 47.341673, limit=1, closed=0)
+test_notes = api.notes_get(8.527504, 47.337063, 8.540679, 47.341673, limit=1, closed=0)
 pprint(test_notes)
 
-
-api.NoteComment(note["id"], "Another comment")
-api.NoteClose(note["id"], "Close this test note")
-
+api.note_comment(note["id"], "Another comment")
+api.note_close(note["id"], "Close this test note")
 
 # try to close an already closed note
 try:
-    api.NoteClose(note["id"], "Close the note again")
+    api.note_close(note["id"], "Close the note again")
 except osmapi.NoteAlreadyClosedApiError:
     print("")
     print(f"The note {note['id']} has already been closed")
 
+
 # try to comment on closed note
 try:
-    api.NoteComment(note["id"], "Just a comment")
-except osmapi.NoteAlreadyClosedApiError:
+    api.note_comment(note["id"], "Just a comment")
+except (osmapi.NoteAlreadyClosedApiError, osmapi.errors.ApiError):
     print("")
     print(f"The note {note['id']} is closed, comment no longer possible")

examples/oauth2.py

@@ -45,8 +45,9 @@
 oauth_session.auth = auth
 
 # use the custom session
+
 api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org", session=oauth_session)
-with api.Changeset({"comment": "My first test"}) as changeset_id:
+with api.changeset({"comment": "My first test"}) as changeset_id:
     print(f"Part of Changeset {changeset_id}")
-    node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
+    node1 = api.node_create({"lon": 1, "lat": 1, "tag": {}})
     print(node1)

examples/oauth2_backend.py

@@ -94,9 +94,9 @@ def make_osm_change(oauth_session):
     api = osmapi.OsmApi(
         api="https://api06.dev.openstreetmap.org", session=oauth_session
     )
-    with api.Changeset({"comment": "My first test"}) as changeset_id:
+    with api.changeset({"comment": "My first test"}) as changeset_id:
         print(f"Part of Changeset {changeset_id}")
-        node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
+        node1 = api.node_create({"lon": 1, "lat": 1, "tag": {}})
         print(node1)
 
 

examples/timeout.py

@@ -16,18 +16,20 @@
 
 
 # Use a normal timeout (30s is the default value)
+
 normal_timeout_api = osmapi.OsmApi(
     api="https://api06.dev.openstreetmap.org", session=auth.session, timeout=30
 )
-changeset_id = normal_timeout_api.ChangesetCreate({"comment": "My first test"})
+changeset_id = normal_timeout_api.changeset_create({"comment": "My first test"})
 print(f"Create new changeset {changeset_id}")
 
 # Deliberately using a very small timeout to show what happens when a timeout occurs
+
 low_timeout_api = osmapi.OsmApi(
     api="https://api06.dev.openstreetmap.org", session=auth.session, timeout=0.00001
 )
 try:
-    changeset_id = low_timeout_api.ChangesetCreate({"comment": "My first test"})
+    changeset_id = low_timeout_api.changeset_create({"comment": "My first test"})
     print(f"Create new changeset {changeset_id}")
 except osmapi.errors.TimeoutApiError as e:
     print(f"Timeout error occured: {str(e)}")

examples/write_to_osm.py

@@ -16,13 +16,13 @@
 
 
 api = osmapi.OsmApi(api="https://api06.dev.openstreetmap.org", session=auth.session)
-with api.Changeset({"comment": "My first test"}) as changeset_id:
+with api.changeset({"comment": "My first test"}) as changeset_id:
     print(f"Part of Changeset {changeset_id}")
-    node1 = api.NodeCreate({"lon": 1, "lat": 1, "tag": {}})
+    node1 = api.node_create({"lon": 1, "lat": 1, "tag": {}})
     print(node1)
-    node2 = api.NodeCreate({"lon": 2, "lat": 2, "tag": {}})
+    node2 = api.node_create({"lon": 2, "lat": 2, "tag": {}})
     print(node2)
-    way = api.WayCreate(
+    way = api.way_create(
         {
             "nd": [
                 node1["id"],