Merge pull request #85 from jaluebbe/dev/oauth2_migration

Migrated Python API to oauth2. Included some fiexes and optimisations mentioned by the community. Moved from setup.py to pyproject.toml .

Author: jaluebbe

README.md

@@ -3,37 +3,67 @@
 This repository contains API client implementations for the OpenSky Network in
 Python and Java as well as the sources for the [documentation](https://openskynetwork.github.io/opensky-api/). By using the OpenSky API, you agree with our [terms of use](https://opensky-network.org/about/terms-of-use). We may block AWS and other hyperscalers due to generalized abuse from these IPs.
 
-Note that these implementations are not actively maintained and serve mostly as examples. Java and Python are written for legacy accounts and authenticated usage will stop working without modifications from March 18, 2026.
+Note that the Java implementation is not actively maintained and serves mostly as an example. The Python implementation has been updated to support OAuth2 authentication as required from March 18, 2026.
 
 For actively maintained libraries, check our [Data Tools](https://opensky-network.org/data/tools) page, which includes many third-party and community tools. 
 
 ## Python API
 
-* depends on the python-requests library (http://docs.python-requests.org/)
-* both compatible with Python 2 and 3 (tested with 2.7 and 3.5)
+* Requires Python 3.10 or later
+* Depends on the [requests](http://docs.python-requests.org/) library
+* Authentication uses the OAuth2 client credentials flow (see [Authentication](#authentication))
 
 ### Installation
 
+Install directly from GitHub using pip (recommended):
+
 ```
-sudo python setup.py install
+pip install "git+https://github.com/openskynetwork/opensky-api.git#subdirectory=python"
 ```
 
-or with pip (recommended)
+Or clone the repository and install locally:
 
 ```
-pip install -e /path/to/repository/python
+git clone https://github.com/openskynetwork/opensky-api.git
+pip install -e opensky-api/python
 ```
 
+### Authentication
+
+Since March 18, 2026, basic authentication with username and password is no longer supported.
+Authentication now uses the OAuth2 client credentials flow.
+
+1. Log in to your OpenSky account and visit the [Account](https://opensky-network.org/my-opensky/account) page.
+2. Create a new API client and download the credentials file (`credentials.json`).
+3. Pass the credentials to the API client as shown below.
+
+Without credentials, requests are made anonymously with reduced rate limits.
+
 ### Usage
 
-```
+Anonymous access (reduced rate limits):
+
+```python
 from opensky_api import OpenSkyApi
+
 api = OpenSkyApi()
 s = api.get_states()
 print(s)
 ```
 
-will output something like this:
+Authenticated access using a credentials file:
+
+```python
+from opensky_api import OpenSkyApi, TokenManager
+
+api = OpenSkyApi(token_manager=TokenManager.from_json_file("credentials.json"))
+s = api.get_states()
+print(s)
+```
+
+The token is refreshed automatically before it expires, so no manual token management is required.
+
+Example output:
 
 ```
 {

python/MANIFEST.in

@@ -0,0 +1,68 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+# Example usage of the OpenSky Network API client.
+#
+# Retrieves all aircraft currently over Germany and prints a summary,
+# then shows which of your own receivers are currently active.
+#
+# Author: Jannis Lübbe <luebbe@opensky-network.org>
+# URL:    http://github.com/openskynetwork/opensky-api
+#
+import os
+
+from opensky_api import OpenSkyApi, TokenManager
+
+# Use credentials file if available, otherwise fall back to anonymous access.
+# Anonymous access has reduced rate limits and no access to own sensor data.
+_CREDENTIALS_PATH = "credentials.json"
+
+
+def fmt_alt(value):
+    """Format an altitude value, omitting the unit if the value is None."""
+    return f"{value}m" if value is not None else "None"
+
+
+def main():
+    if os.path.exists(_CREDENTIALS_PATH):
+        tm = TokenManager.from_json_file(_CREDENTIALS_PATH)
+        print("Authenticated with credentials file.")
+    else:
+        tm = None
+        print("No credentials file found, using anonymous access (reduced rate limits).")
+
+    with OpenSkyApi(token_manager=tm) as api:
+        # Get all aircraft currently over Germany (bounding box)
+        print("\n--- Aircraft over Germany ---")
+        states = api.get_states(bbox=(47.2, 55.1, 5.9, 15.1))
+        if states and states.states:
+            for s in states.states:
+                print(
+                    f"{s.icao24:8s}  {s.callsign or '?':10s}  {s.origin_country:20s}  "
+                    f"baro={fmt_alt(s.baro_altitude)}  "
+                    f"geo={fmt_alt(s.geo_altitude)}  "
+                    f"{'on ground' if s.on_ground else 'airborne'}"
+                )
+        else:
+            print("No states received.")
+
+        # Show which own receivers are currently active and delivering data.
+        # Requires authentication.
+        if tm is not None:
+            print("\n--- Own receivers ---")
+            my_states = api.get_my_states()
+            if my_states and my_states.states:
+                active_serials = set()
+                for s in my_states.states:
+                    if s.sensors:
+                        active_serials.update(s.sensors)
+                if active_serials:
+                    print(f"Active serials providing data: {sorted(active_serials)}")
+                else:
+                    print("No sensor information available in state vectors.")
+            else:
+                print("No states received from own receivers.")
+
+
+if __name__ == "__main__":
+    main()