pyopensky 2.12__tar.gz → 2.15__tar.gz

{pyopensky-2.12 → pyopensky-2.15}/.github/workflows/run_tests.yml

@@ -36,31 +36,19 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up uv
-        if: ${{ matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest' }}
-        run: curl -LsSf https://astral.sh/uv/install.sh | sh
-
-      - name: Set up uv
-        if: ${{ matrix.os == 'windows-latest' }}
-        run: irm https://astral.sh/uv/install.ps1 | iex
-        shell: powershell
-
-      - name: Cache folder for uv
-        uses: actions/cache@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
         with:
-          path: /tmp/.uv-cache
-          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-          restore-keys: |
-            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
-            uv-${{ runner.os }}
+          enable-cache: true
 
       - name: Cache folder for data
         uses: actions/cache@v4
         id: cache-folder
         with:
           path: |
-            ${{ github.workspace }}/cache_opensky
-          key: opensky-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            cache_opensky
+          enableCrossOsArchive: true
+          key: opensky-${{ hashFiles('uv.lock') }}
 
       - name: Install the project
         run: uv sync --all-extras --dev --python ${{ matrix.python-version }}
@@ -71,7 +59,7 @@ jobs:
           uv run ruff format --check
 
       - name: Run tests
-        if: ${{ matrix.python-version == '3.12' || steps.cache-folder.outputs.cache-hit == 'true' }}
+        if: ${{ (matrix.python-version == '3.12' && matrix.os == 'ubuntu-latest') || steps.cache-folder.outputs.cache-hit == 'true' }}
         env:
           OPENSKY_USERNAME: ${{ secrets.OPENSKY_USERNAME }}
           OPENSKY_PASSWORD: ${{ secrets.OPENSKY_PASSWORD }}

{pyopensky-2.12 → pyopensky-2.15}/.gitignore

@@ -25,6 +25,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+.idea/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

{pyopensky-2.12 → pyopensky-2.15}/PKG-INFO

@@ -1,9 +1,10 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pyopensky
-Version: 2.12
+Version: 2.15
 Summary: A Python interface for OpenSky database
 Project-URL: Repository, https://github.com/open-aviation/pyopensky/
 Author-email: Xavier Olive <git@xoolive.org>, Junzi Sun <j.sun-1@tudelft.nl>
+License-Expression: MIT
 Requires-Python: >=3.9
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: httpx>=0.27.2
@@ -11,6 +12,7 @@ Requires-Dist: minio>=7.2.8
 Requires-Dist: pandas>=2.2.2
 Requires-Dist: pyarrow>=17.0.0
 Requires-Dist: pyjwt>=2.9.0
+Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: tqdm>=4.66.5
 Requires-Dist: trino[sqlalchemy]>=0.329.0
 Requires-Dist: typing-extensions>=4.12.2

{pyopensky-2.12 → pyopensky-2.15}/docs/source/credentials.rst

@@ -20,9 +20,13 @@ is created, including the following content:
     [default]
     username =
     password =
+    client_id =
+    client_secret =
 
-If you use the same login for the OpenSky website (therefore the REST API) and 
-for Trino (it will be unified one day), just fill it here.
+
+The username and password is used to access the Trino database, while the
+client ID and client secret are used to access the OpenSky REST API. 
+Log in to your OpenSky account and visit the `Account <https://opensky-network.org/my-opensky/account>`_ page in order to create a new API client and retrieve your ``client_id`` and ``client_secret``.
 
 You will identify the folder where the ``settings.conf`` file is located:
 
@@ -32,26 +36,6 @@ You will identify the folder where the ``settings.conf`` file is located:
 
     print(opensky_config_dir)
 
-
-Different credentials per service
----------------------------------
-
-If you want to specify different credentials for the REST API and for the Trino 
-database, use the following sections in the configuration file.
-
-.. code::
-
-    [opensky]  # REST API
-    username =
-    password =
-
-    [trino]  # Trino database
-    username =
-    password =
-
-If these sections are commented, the library will use the credentials from the
-[default] section.
-
 Fallback configuration
 ----------------------
 
@@ -61,5 +45,5 @@ following steps are performed in order:
 - try to get the credentials from the `traffic <https://traffic-viz.github.io>`_
   configuration file;
 - get the credentials from ``$OPENSKY_USERNAME`` and ``$OPENSKY_PASSWORD``
-  environment variables;
-- open a browser and log in on a dedicated webpage.
+  environment variables (``$OPENSKY_CLIENT_ID`` and ``$OPENSKY_CLIENT_SECRET`` for the API client);
+- open a browser and log in on a dedicated webpage (for Trino).

{pyopensky-2.12 → pyopensky-2.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyopensky"
-version = "2.12"
+version = "2.15"
 description = "A Python interface for OpenSky database"
 authors = [
   { name = "Xavier Olive", email = "git@xoolive.org" },
@@ -16,6 +16,7 @@ dependencies = [
   "pandas >= 2.2.2",
   "pyarrow >= 17.0.0",
   "pyjwt >= 2.9.0",
+  "python-dotenv>=1.0.1",
   "tqdm >= 4.66.5",
   "trino[sqlalchemy] >= 0.329.0",
   "typing-extensions >= 4.12.2",

{pyopensky-2.12 → pyopensky-2.15}/src/pyopensky/config.py

@@ -6,33 +6,33 @@ import os
 from pathlib import Path
 from typing import TypedDict
 
+import dotenv
 from appdirs import user_cache_dir, user_config_dir
 
 import pandas as pd
 
 _log = logging.getLogger(__name__)
+dotenv.load_dotenv()
 
 
 DEFAULT_CONFIG = """
 [default]
 username =
 password =
+client_id =
+client_secret =
 
 # Uncomment the following if you have access to the s3 server
+# [s3]
 # secret_key =
 # access_key =
 
-# If you need a different account on Trino, uncomment the following
-# [trino]
-# username =
-# password =
-
 [cache]
 ## You may set a different cache folder here if you have a preferred space
 ## for storing possibly large files.
 ## Default settings:
 ## - $HOME/.cache/opensky (Linux)
-## - $HOME/Library/Caches/opensky (MacOS)
+## - $HOME/Library/Caches/opensky (MacOS) (unless XDG_CONFIG_HOME is set)
 ## - C:\\Users\\<username>\\AppData\\Local\\opensky\\Cache (Windows)
 ##
 # path =
@@ -44,7 +44,10 @@ password =
 purge = 90 days
 """
 
-opensky_config_dir = Path(user_config_dir("pyopensky"))
+if (xdg_config := os.environ.get("XDG_CONFIG_HOME")) is not None:
+    opensky_config_dir = Path(xdg_config) / "pyopensky"
+else:
+    opensky_config_dir = Path(user_config_dir("pyopensky"))
 opensky_config = configparser.ConfigParser()
 
 if (opensky_config_file := opensky_config_dir / "settings.conf").exists():
@@ -57,7 +60,10 @@ else:
         opensky_config_dir.mkdir(parents=True)
     opensky_config_file.write_text(DEFAULT_CONFIG)
 
-traffic_config_dir = Path(user_config_dir("traffic"))
+if xdg_config is not None:
+    traffic_config_dir = Path(xdg_config) / "traffic"
+else:
+    traffic_config_dir = Path(user_config_dir("traffic"))
 traffic_config = configparser.ConfigParser()
 
 if (traffic_config_file := traffic_config_dir / "traffic.conf").exists():
@@ -139,6 +145,16 @@ NAME_RESOLUTION: dict[str, Resolution] = {
         traffic_category="opensky",
         traffic_name="password",
     ),
+    "client_id": dict(
+        environment_variable="OPENSKY_CLIENT_ID",
+        opensky_category="default",
+        opensky_name="client_id",
+    ),
+    "client_secret": dict(
+        environment_variable="OPENSKY_CLIENT_SECRET",
+        opensky_category="default",
+        opensky_name="client_secret",
+    ),
     "trino_username": dict(
         environment_variable="OPENSKY_TRINO_USERNAME",
         opensky_category="trino",

{pyopensky-2.12 → pyopensky-2.15}/src/pyopensky/rest.py

@@ -1,22 +1,31 @@
 from __future__ import annotations
 
+import datetime
 import logging
 import time
 from datetime import timedelta
 from json import JSONDecodeError
-from typing import Any, cast
+from typing import Any, TypedDict, cast
 
 import httpx
 
 import pandas as pd
 
 from .api import HasBounds
-from .config import password, username
+from .config import client_id, client_secret, password, username
 from .time import timelike, to_datetime
 
 _log = logging.getLogger(__name__)
 
 
+class TokenDict(TypedDict):
+    access_token: str
+    expires_in: int
+    token_type: str
+    # Added for convenience, not in the API response
+    expiration: datetime.datetime
+
+
 class REST:
     """Wrapper to OpenSky REST API.
 
@@ -53,12 +62,54 @@ class REST:
     def __init__(self) -> None:
         self.username = username
         self.password = password
-        self.auth = cast(tuple[str, str], (username, password))
+        self.client_id = client_id
+        self.client_secret = client_secret
+        # self.auth = cast(tuple[str, str], (username, password))
+        self._token: None | TokenDict = None
 
         self.client = httpx.Client()
 
+    @property
+    def token(self) -> None | TokenDict:
+        """Returns the OpenSky token for the current user."""
+
+        if self._token is not None:
+            now = datetime.datetime.now(tz=datetime.timezone.utc)
+            if "expiration" in self._token and self._token["expiration"] > now:
+                return self._token
+
+        if self.client_id is None or self.client_secret is None:
+            return None
+
+        now = datetime.datetime.now(tz=datetime.timezone.utc)
+        url = "https://auth.opensky-network.org/auth/realms/opensky-network/protocol/openid-connect/token"
+        c = self.client.post(
+            url=url,
+            data=dict(
+                grant_type="client_credentials",
+                client_id=self.client_id,
+                client_secret=self.client_secret,
+            ),
+        )
+        c.raise_for_status()
+        self._token = c.json()
+        assert self._token is not None
+        if "access_token" not in self._token:
+            raise RuntimeError("No access token found in response")
+        self._token["expiration"] = now + timedelta(
+            seconds=self._token["expires_in"]
+        )
+        return self._token
+
+    @property
+    def headers(self) -> dict[str, str]:
+        """Returns the headers to use for OpenSky requests."""
+        if self.token is None:
+            return {}
+        return {"Authorization": f"Bearer {self.token['access_token']}"}
+
     def get(self, query: str, retry: int = 5) -> Any:
-        c = self.client.get(query, auth=self.auth)
+        c = self.client.get(query, headers=self.headers)
         try:
             if limit := c.headers.get("X-Rate-Limit-Remaining", None):
                 limit = int(limit)
@@ -95,7 +146,7 @@ class REST:
     async def async_get(
         self, client: httpx.AsyncClient, query: str, retry: int = 5
     ) -> pd.DataFrame:
-        c = await client.get(query, auth=self.auth)
+        c = await client.get(query, headers=self.headers)
         try:
             if limit := c.headers.get("X-Rate-Limit-Remaining", None):
                 limit = int(limit)
@@ -170,7 +221,7 @@ class REST:
 
         """
 
-        what = "own" if (own and self.auth is not None) else "all"
+        what = "own" if (own and self.headers != {}) else "all"
 
         if bounds is not None:
             if isinstance(bounds, str):
@@ -275,13 +326,13 @@ class REST:
 
         return df
 
-    def routes(self, callsign: str) -> tuple[str, str]:
-        """Returns the route associated to a callsign."""
-        json = self.get(
-            f"https://opensky-network.org/api/routes?callsign={callsign}"
-        )
+    # def routes(self, callsign: str) -> tuple[str, str]:
+    #     """Returns the route associated to a callsign."""
+    #     json = self.get(
+    #         f"https://opensky-network.org/api/routes?callsign={callsign}"
+    #     )
 
-        return tuple(json["route"])
+    #     return tuple(json["route"])
 
     def aircraft(
         self,

{pyopensky-2.12 → pyopensky-2.15}/src/pyopensky/schema.py

@@ -208,23 +208,40 @@ class Base(DeclarativeBase):
 class StateVectorsData4(Base):
     __tablename__ = "state_vectors_data4"
 
+    # The time at which the state vector was valid.
     time: Mapped[pd.Timestamp]
+    # The unique 24-bit transponder ID assigned to the aircraft.
     icao24: Mapped[Address]
+    # The last known latitude and longitude (WGS84 format).
     lat: Mapped[float]
     lon: Mapped[float]
+    # Speed over ground in meters per second.
     velocity: Mapped[float]
+    # The direction of movement in degrees from geographic north.
     heading: Mapped[float]
+    # Vertical speed in meters per second
+    # (positive = ascending, negative = descending).
     vertrate: Mapped[float]
+    # The flight identifier broadcast by the aircraft.
     callsign: Mapped[Callsign]
+    # Indicates if the aircraft is on the ground (true) or airborne (false).
     onground: Mapped[bool]
+    # Special ATC indicators: alert squawk.
     alert: Mapped[bool]
+    # Special ATC indicators: special position indicator.
     spi: Mapped[bool]
+    # The 4-digit octal transponder code assigned by ATC.
     squawk: Mapped[str]
+    # Barometric altitude measured by the aircraft in meters.
     baroaltitude: Mapped[float]
+    # Geometric altitude determined by GNSS (GPS).
     geoaltitude: Mapped[float]
+    # The timestamp of the last recorded position update.
     lastposupdate: Mapped[float]
+    # The last time OpenSky received a signal from the aircraft.
     lastcontact: Mapped[float]
     serials: Mapped[List[int]] = mapped_column(ARRAY(Integer))  # TODO
+    # The start of the hour this data belongs to.
     hour: Mapped[pd.Timestamp] = mapped_column(primary_key=True)
 
 

{pyopensky-2.12 → pyopensky-2.15}/src/pyopensky/trino.py

@@ -132,6 +132,7 @@ class Trino(OpenSkyDBAPI):
                 user=trino_username,
                 catalog="minio",
                 schema="osky",
+                source="pyopensky",
             ),
             connect_args=dict(
                 auth=JWTAuthentication(token)

{pyopensky-2.12 → pyopensky-2.15}/src/pyopensky/tzdata.py

@@ -12,6 +12,8 @@ from pathlib import Path
 
 import httpx
 
+rk = "Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Shell Folders"
+
 
 def download_tzdata_windows(
     year: int = 2022,
@@ -19,9 +21,24 @@ def download_tzdata_windows(
     name: str = "tzdata",
     base_dir: None | Path = None,
 ) -> None:
-    folder = (
-        base_dir if base_dir else Path(os.path.expanduser("~")) / "Downloads"
-    )
+    # This module only exists in Windows
+    from winreg import HKEY_CURRENT_USER, OpenKey, QueryValueEx  # type: ignore
+
+    if base_dir is None:
+        conda_env_path = os.getenv("CONDA_PREFIX", None)
+        if conda_env_path:
+            base_dir = Path(conda_env_path) / "Lib" / "site-packages" / "tzdata"
+        else:
+            # This \o/ line finds the Downloads directory for the current user
+            with OpenKey(HKEY_CURRENT_USER, rk) as key:
+                download_path, _ = QueryValueEx(
+                    key,
+                    # don't ask what this uuid stands for...
+                    "{374DE290-123F-4565-9164-39C4925E467B}",
+                )
+                base_dir = Path(download_path)
+
+    folder = base_dir
 
     if (folder / name).is_dir():
         return

{pyopensky-2.12 → pyopensky-2.15}/tests/test_trino.py

@@ -13,14 +13,6 @@ commercial_callsign = (
 )
 
 
-def test_alive() -> None:
-    df = trino.query(
-        "select * from state_vectors_data4 limit 5",
-        cached=False,
-    )
-    assert df.shape[0] == 5
-
-
 def test_query() -> None:
     res = trino.query(
         select(FlightsData4)