Skip to main content

A Python interface for OpenSky database

Project description

pyopensky

The pyopensky Python library provides functions to download data from the OpenSky Network live API and historical databases. It aims at making ADS-B and Mode S data from OpenSky easily accessible in the Python programming environment.

Full documentation on https://open-aviation.github.io/pyopensky

Installation

pip install pyopensky

The library is also available on conda-forge:

conda install -c conda-forge pyopensky

Development mode (with poetry):

git clone https://github.com/open-aviation/pyopensky
cd pyopensky
poetry install

Credentials

Apply for access
Impala https://opensky-network.org/data/impala
Trino contact@opensky-network.org (or specify it in the Impala form)

The first time you use the library, a configuration file named settings.conf is created, including the following content:

[default]
username =
password =

You will identify the folder where the settings.conf is located:

from pyopensky.config import opensky_config_dir

print(opensky_config_dir)

Usage

  • from the REST API:

    from pyopensky.rest import REST
    
    rest = REST()
    
    rest.states()
    rest.tracks(icao24)
    rest.routes(callsign)
    rest.aircraft(icao24, begin, end)
    rest.arrival(airport, begin, end)
    rest.departure(airport, begin, end)
    
  • from the Impala shell (requires authentication):

    from pyopensky.impala import Impala
    
    impala = Impala()
    # full description of the whole set of parameters in the documentation
    impala.flightlist(start, stop, *, airport, callsign, icao24)
    impala.history(start, stop, *, callsign, icao24, bounds)
    impala.rawdata(start, stop, *, callsign, icao24, bounds)
    
  • from the Trino database (requires authentication):

    from pyopensky.trino import Trino
    
    trino = Trino()
    # full description of the whole set of parameters in the documentation
    trino.flightlist(start, stop, *, airport, callsign, icao24)
    trino.history(start, stop, *, callsign, icao24, bounds)
    trino.rawdata(start, stop, *, callsign, icao24, bounds)
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyopensky-2.3.tar.gz (28.9 kB view hashes)

Uploaded source

Built Distribution

pyopensky-2.3-py3-none-any.whl (31.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page