opensky 0.2.1

Rust client for OpenSky Network Trino database
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! # opensky
//!
//! A Rust client for the OpenSky Network Trino database.
//!
//! This crate provides access to historical flight data from the OpenSky Network,
//! allowing you to query ADS-B trajectory data for aircraft worldwide.
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use opensky::{Trino, QueryParams};
//!
//! #[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     // Create a Trino client (reads credentials from ~/.config/opensky/settings.conf)
//!     let mut trino = Trino::new().await?;
//!
//!     // Query flight history
//!     let params = QueryParams::new()
//!         .icao24("485a32")
//!         .time_range("2025-01-01 10:00:00", "2025-01-01 12:00:00");
//!
//!     let data = trino.history(params).await?;
//!     println!("Got {} rows", data.len());
//!
//!     // Export to CSV
//!     data.to_csv("flight.csv")?;
//!
//!     Ok(())
//! }
//! ```
//!
//! ## Configuration
//!
//! Credentials are read from a platform-specific config file:
//! - Linux: `~/.config/opensky/settings.conf`
//! - macOS: `~/Library/Application Support/opensky/settings.conf`
//! - Windows: `%LOCALAPPDATA%\opensky\settings.conf`
//!
//! ```ini
//! [default]
//! username = your_username
//! password = your_password
//! ```
//!
//! Register for an account at <https://opensky-network.org/>.

pub mod cache;
pub mod config;
pub mod query;
pub mod trino;
pub mod types;

// Re-export main types for convenience
pub use cache::{cache_dir, cache_stats, clear_cache, purge_old_cache, CacheStats};
pub use config::Config;
pub use query::{build_history_query, build_flightlist_query, build_rawdata_query, build_query_preview, build_query_preview_method};
pub use trino::{QueryStatus, Trino};
pub use types::{Bounds, FlightData, OpenSkyError, QueryParams, RawTable, Result, FLIGHT_COLUMNS, FLIGHTLIST_COLUMNS, RAWDATA_COLUMNS};

// Re-export polars DataFrame for convenience
pub use polars::frame::DataFrame;

use std::path::Path;

/// Write a DataFrame to a CSV file.
pub fn write_csv(df: &DataFrame, path: impl AsRef<Path>) -> Result<()> {
    use polars::prelude::*;
    let mut file = std::fs::File::create(path.as_ref())?;
    CsvWriter::new(&mut file)
        .finish(&mut df.clone())
        .map_err(|e| OpenSkyError::DataConversion(format!("Failed to write CSV: {}", e)))?;
    Ok(())
}

/// Write a DataFrame to a Parquet file.
pub fn write_parquet(df: &DataFrame, path: impl AsRef<Path>) -> Result<()> {
    use polars::prelude::*;
    let mut file = std::fs::File::create(path.as_ref())?;
    ParquetWriter::new(&mut file)
        .finish(&mut df.clone())
        .map_err(|e| OpenSkyError::DataConversion(format!("Failed to write Parquet: {}", e)))?;
    Ok(())
}