pyopensky 2.8__tar.gz → 2.9__tar.gz

pyopensky-2.9/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  # - package-ecosystem: "pip"
+  #   directory: "/"
+  #   schedule:
+  #     interval: "monthly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

pyopensky-2.9/.github/renovate.json5

@@ -0,0 +1,6 @@
+{
+  $schema: "https://docs.renovatebot.com/renovate-schema.json",
+  lockFileMaintenance: {
+    enabled: true,
+  },
+}

pyopensky-2.9/.github/workflows/build-docs.yml

@@ -0,0 +1,52 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  documentation:
+    runs-on: ubuntu-latest
+
+    env:
+      UV_CACHE_DIR: /tmp/.uv-cache
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+
+      - name: Cache folder for uv
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.uv-cache
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras --dev
+
+      - name: Build pages
+        working-directory: docs
+        run: |
+          uv run make html
+
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+      - name: Deploy pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/build/html

pyopensky-2.9/.github/workflows/pypi_publish.yml

@@ -0,0 +1,39 @@
+name: publish
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+
+      - name: Cache folder for uv
+        uses: actions/cache@v4
+        with:
+          path: /tmp/.uv-cache
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+
+      - name: Build packages
+        run: uvx hatch build
+
+      - name: Minimize uv cache
+        run: uv cache prune --ci
+
+      - name: Publish a Python distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_PASSWORD }}

pyopensky-2.9/.github/workflows/run_tests.yml

@@ -0,0 +1,81 @@
+name: tests
+
+on:
+  push:
+  pull_request_target:
+  schedule: # This is useful for keeping the cache fit and ready
+    - cron: "42 3 * * 0" # Every Sunday morning when I am fast asleep :)
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    name: python-${{ matrix.python-version }} on ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+
+      fail-fast: false
+
+    runs-on: ${{ matrix.os }}
+
+    env:
+      UV_CACHE_DIR: /tmp/.uv-cache
+
+    steps:
+      - uses: actions/checkout@v4
+        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
+        with:
+          path: /tmp/.uv-cache
+          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
+            uv-${{ runner.os }}
+
+      - 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') }}
+
+      - name: Install the project
+        run: uv sync --all-extras --dev --python ${{ matrix.python-version }}
+
+      - name: Linting and formatting
+        run: |
+          uv run ruff check
+          uv run ruff format --check
+
+      - name: Run tests
+        if: ${{ matrix.python-version == '3.12' || steps.cache-folder.outputs.cache-hit == 'true' }}
+        env:
+          OPENSKY_USERNAME: ${{ secrets.OPENSKY_USERNAME }}
+          OPENSKY_PASSWORD: ${{ secrets.OPENSKY_PASSWORD }}
+          OPENSKY_CACHE: ${{ github.workspace }}/cache_opensky
+        run: uv run pytest
+
+      - name: Minimize uv cache
+        run: uv cache prune --ci

pyopensky-2.9/.gitignore

@@ -0,0 +1,34 @@
+.vscode/
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+.pytest_cache/
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+

{pyopensky-2.8 → pyopensky-2.9}/PKG-INFO

@@ -1,28 +1,24 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: pyopensky
-Version: 2.8
+Version: 2.9
 Summary: A Python interface for OpenSky database
-Home-page: https://github.com/open-aviation/pyopensky/
-License: MIT
-Author: Xavier Olive
-Author-email: git@xoolive.org
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: appdirs (>=1.4.4)
-Requires-Dist: httpx (>=0.27.0,<0.28.0)
-Requires-Dist: minio (>=7.1)
-Requires-Dist: pandas (>=1.5)
-Requires-Dist: pyarrow (>=11.0.0)
-Requires-Dist: pyjwt (>=2.7.0)
-Requires-Dist: tqdm (>=4.65.0)
-Requires-Dist: trino[sqlalchemy] (>=0.322)
-Requires-Dist: typing-extensions (>=4.5.0)
-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
+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: tqdm>=4.66.5
+Requires-Dist: trino[sqlalchemy]>=0.329.0
+Requires-Dist: typing-extensions>=4.12.2
+Provides-Extra: cartes
+Requires-Dist: cartes>=0.8.0; extra == 'cartes'
+Provides-Extra: decoding
+Requires-Dist: pymodes>=2.18; extra == 'decoding'
+Requires-Dist: rs1090>=0.3.0; extra == 'decoding'
 Description-Content-Type: text/markdown
 
 # pyopensky
@@ -43,12 +39,12 @@ The library is also available on conda-forge:
 conda install -c conda-forge pyopensky
 ```
 
-Development mode (with poetry):
+Development mode (with uv):
 
 ```sh
-git clone https://github.com/open-aviation/pyopensky
-cd pyopensky
-poetry install
+curl -LsSf https://astral.sh/uv/install.sh | sh  # Linux and MacOS
+irm https://astral.sh/uv/install.ps1 | iex  # Windows
+uv sync --dev
 ```
 
 ## Credentials
@@ -86,4 +82,3 @@ See details in the [documentation](https://open-aviation.github.io/pyopensky/cre
   trino.history(start, stop, *, callsign, icao24, bounds)
   trino.rawdata(start, stop, *, callsign, icao24, bounds)
   ```
-

pyopensky-2.9/docs/.gitignore

@@ -0,0 +1 @@
+build/

pyopensky-2.9/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pyopensky-2.9/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pyopensky-2.9/docs/source/_static/main_stylesheet.css

@@ -0,0 +1,17 @@
+a.reference code.literal span {
+  font-family: Lato, proxima-nova, Helvetica Neue, Arial, sans-serif;
+  font-size: 16px;
+  font-weight: 500;
+  color: #2980b9;
+}
+.rst-content .document a {
+  text-decoration: underline;
+  text-underline-offset: 2pt;
+}
+.rst-content .document a code {
+    padding: 0
+}
+.rst-content code {
+    border: none;
+    background: none;
+}

pyopensky-2.9/docs/source/api_reference.rst

@@ -0,0 +1,8 @@
+API reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   rest
+   trino

pyopensky-2.9/docs/source/conf.py

@@ -0,0 +1,47 @@
+from typing import Any
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+import pyopensky
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "pyopensky"
+copyright = "2023, Xavier Olive, Junzi Sun"
+author = "Xavier Olive, Junzi Sun"
+release = pyopensky.__version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.intersphinx",
+    "sphinx_autodoc_typehints",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "pandas": ("https://pandas.pydata.org/pandas-docs/dev", None),
+    "traffic": ("https://traffic-viz.github.io", None),
+}
+
+
+def setup(app: Any) -> None:
+    # Specific stylesheet
+    app.add_css_file("main_stylesheet.css")

pyopensky-2.9/docs/source/credentials.rst

@@ -0,0 +1,65 @@
+Credentials
+===========
+
+Apply for access
+----------------
+
+Access to the Trino database will be granted provided you meet the conditions
+defined by The OpenSky Network. Please create an account on
+https://trino.opensky-network.org, and then send an email to
+contact@opensky-network.org with your Trino username to request for activation.
+
+Configuration
+-------------
+
+The first time you use the library, a configuration file named ``settings.conf``
+is created, including the following content:
+
+.. code::
+
+    [default]
+    username =
+    password =
+
+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.
+
+You will identify the folder where the ``settings.conf`` file is located:
+
+.. code:: python
+
+    from pyopensky.config import opensky_config_dir
+
+    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
+----------------------
+
+If no username and password are specified in the `pyopensky` configuration file, the
+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.

pyopensky-2.9/docs/source/index.rst

@@ -0,0 +1,30 @@
+pyopensky
+=========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Source code on `github <https://github.com/open-aviation/pyopensky>`_
+
+The pyopensky library provides function to easily download data from
+`The OpenSky Network <https://opensky-network.org/>`_ databases. This minimal 
+library is ideal for quickly downloading and locally saving data that you will
+use in your future studies. All functions return pandas :class:`~pandas.DataFrame`.
+
+.. hint::
+
+   If Python is your language of choice in general, and you are interested in
+   analysing aircraft trajectories, please refer to the following `section in
+   the traffic <https://traffic-viz.github.io/data_sources/opensky_db.html>`_
+   library. traffic wraps the same pyopensky queries and returns
+   :class:`~traffic.core.Traffic` and :class:`~traffic.core.Flight` objects.
+   
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   installation
+   credentials
+   api_reference
+

pyopensky-2.9/docs/source/installation.rst

@@ -0,0 +1,27 @@
+Installation
+============
+
+pyopensky is available through pip:
+
+.. code::
+
+    pip install pyopensky
+
+The library is also available on conda-forge:
+
+.. code::
+
+    conda install -c conda-forge pyopensky
+
+Development mode (with poetry):
+
+.. code::
+
+    git clone https://github.com/open-aviation/pyopensky
+    cd pyopensky
+    poetry install
+
+.. hint::
+
+    pyopensky is automatically installed as a dependency of the `traffic
+    <https://traffic-viz.github.io>`_ library.

pyopensky-2.9/docs/source/rest.rst

@@ -0,0 +1,8 @@
+The REST API
+------------
+
+.. autoclass:: pyopensky.rest.REST
+    :members:
+    :inherited-members:
+    :no-undoc-members:
+    :show-inheritance:

pyopensky-2.9/docs/source/trino.rst

@@ -0,0 +1,8 @@
+The Trino database
+-------------------
+
+.. autoclass:: pyopensky.trino.Trino
+    :members:
+    :inherited-members:
+    :no-undoc-members:
+    :show-inheritance:

pyopensky-2.9/pyproject.toml

@@ -0,0 +1,76 @@
+[project]
+name = "pyopensky"
+version = "2.9"
+description = "A Python interface for OpenSky database"
+repository = "https://github.com/open-aviation/pyopensky/"
+authors = [
+  { name = "Xavier Olive", email = "git@xoolive.org" },
+  { name = "Junzi Sun", email = "j.sun-1@tudelft.nl" },
+]
+license = "MIT"
+readme = "readme.md"
+include = ["license.txt", "py.typed"]
+requires-python = ">=3.9"
+dependencies = [
+  "appdirs >= 1.4.4",
+  "httpx >= 0.27.2",
+  "minio >= 7.2.8",
+  "pandas >= 2.2.2",
+  "pyarrow >= 17.0.0",
+  "pyjwt >= 2.9.0",
+  "tqdm >= 4.66.5",
+  "trino[sqlalchemy] >= 0.329.0",
+  "typing-extensions >= 4.12.2",
+]
+
+[project.optional-dependencies]
+cartes = ["cartes>=0.8.0"]
+decoding = ["pymodes>=2.18", "rs1090>=0.3.0"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.uv]
+dev-dependencies = [
+  "pre-commit >= 3.8.0",
+  "mypy >= 1.11.2",
+  "ruff >= 0.6.3",
+  "pytest >= 8.3.2",
+  "ipykernel >= 6.29.5",
+  "sphinx >= 7.4.7",
+  "sphinx-design >= 0.6.1",
+  "sphinx-rtd-theme >= 2.0.0",
+  "sphinx-autodoc-typehints >= 2.3.0",
+]
+
+[tool.ruff]
+lint.select = [
+  "E",
+  "W",   # pycodestyle
+  "F",   # pyflakes
+  "I",   # isort
+  "NPY", # numpy
+  # "PD",  # pandas
+  "DTZ", # flake8-datetimez
+  "RUF",
+]
+line-length = 80
+target-version = "py38"
+
+[tool.ruff.lint.isort]
+known-first-party = ["numpy", "pandas"]
+
+[tool.mypy]
+python_version = 3.8
+platform = "posix"
+color_output = true
+pretty = true
+show_column_numbers = true
+strict = true
+check_untyped_defs = true
+ignore_missing_imports = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_unused_configs = true
+warn_unused_ignores = true

{pyopensky-2.8 → pyopensky-2.9}/readme.md

@@ -16,12 +16,12 @@ The library is also available on conda-forge:
 conda install -c conda-forge pyopensky
 ```
 
-Development mode (with poetry):
+Development mode (with uv):
 
 ```sh
-git clone https://github.com/open-aviation/pyopensky
-cd pyopensky
-poetry install
+curl -LsSf https://astral.sh/uv/install.sh | sh  # Linux and MacOS
+irm https://astral.sh/uv/install.ps1 | iex  # Windows
+uv sync --dev
 ```
 
 ## Credentials