Version 2.0.0 development

[gboeing]

Overview

This PR consolidates development work for OSMnx v2.0.0, targeted for release later in 2024.

Migrating to v2

See the migration guide at #1123.

Changes

See changelog for complete details.

This PR incorporates several other PRs prior to merging into the main branch:

• add type annotations throughout the package (add type annotations #1107)
• drop Python 3.8 support (cb0a773)
• improve docstrings and pull param/return types from function signatures (improve documentation #1116)
• improve logging and warnings (Improve logging and warnings #1125)
• improve error messages (Improve error messages #1131)
• remove previously deprecated, outdated functionality to streamline the API and make it more user friendly (Remove previously deprecated functionality #1113)
• rename private _downloader module -> _http and remove unnecessary private _api module (rename private _downloader module, remove unneeded _api module, and fix unreachable code #1114)
• rename some of the settings module's settings for clarity (rename settings module's default_accept_language, default_referer, and default_user_agent #1129 Rename settings memory, timeout, nominatim_endpoint, overpass_endpoint #1136)
• make optional function params keyword-only (make optional args keyword-only #1134)
• improve OSM XML file saving (Improve OSM XML file saving #1135)
• API streamlining and refactoring of modules (More API streamlining for v2 #1148)
• streamline features module (Refactor the features module #1157)
• update reference paper (Update reference paper for v2 #1168)

Also includes work done in #1139, #1144, #1145, #1147, #1149, #1153, #1155, #1160.

[codecov]

Codecov Report

Attention: Patch coverage is 98.61472% with 16 lines in your changes are missing coverage. Please review.

Project coverage is 98.31%. Comparing base (cbe05f1) to head (eeb98bf).
Report is 47 commits behind head on main.

❗ Current head eeb98bf differs from pull request most recent head a003557. Consider uploading reports for the commit a003557 to get more accurate results

Files	Patch %	Lines
osmnx/simplification.py	95.18%	4 Missing ⚠️
osmnx/plot.py	96.90%	3 Missing ⚠️
osmnx/convert.py	96.00%	2 Missing ⚠️
osmnx/stats.py	93.93%	2 Missing ⚠️
osmnx/utils.py	88.23%	2 Missing ⚠️
osmnx/distance.py	98.36%	1 Missing ⚠️
osmnx/routing.py	97.61%	1 Missing ⚠️
osmnx/truncate.py	95.45%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1106      +/-   ##
==========================================
+ Coverage   97.72%   98.31%   +0.58%     
==========================================
  Files          28       24       -4     
  Lines        2547     2368     -179     
==========================================
- Hits         2489     2328     -161     
+ Misses         58       40      -18     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.