File: README.md

package info (click to toggle)
faadelays 2023.9.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 80 kB
  • sloc: python: 180; makefile: 6
file content (32 lines) | stat: -rw-r--r-- 1,893 bytes parent folder | download
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
# FAA Airport Status

This is a simple Python package used to retrieve data from the FAA's NAS Status API.

## Classes

The following classes are available and in some cases dynamically generated when retrieving data:

Class | Information Provided | Methods
--- | --- | ---
ArriveDepartDelay | Airport, Status, Minimum delay, Maximum delay, Trend, Reason, Update time
GroundDelay | Airport, Status, Average delay, Maximum delay, Start time, End time, Reason, Update time, URL to the advisory, Departure scope (if applicable), Included Facilities (if applicable), Included flights (if applicable)
GroundStop | Airport, Status, End Time, Reason, Update time, URL to advisory, Included facilities (if applicable), Included flights (if applicable), Probabibility of extension
Closure | Airport, Status, Begin Time, End Time, Update time, NOTAM text
AirportConfig | Airport, Time the data was created, Arrival runway config, Departure runway config, Arrival rate, Source time stamp
Airport | Code (provide when creating, IATA format), *Name*, *Longitude*, *Latitude*, Bool of if airport is deicing (see note), Bool of any delays, Count of delays, GroundDelay object, GroundStop object, Depart Delay object (ArriveDepartDelay), Arrive Delay object (ArriveDepartDelay), Closure object, Airport config | Update

Items in *italics* are not updated until delay data is present

Note: Information about airport deicing is untested

## Methods Available

`get_airport_delays(airport_code, session)` requires the code for the airport to get delays for in IATA format (i.e. ATL for Atlanta) and an asyncio HTTP session (such as aiohttp.ClientSession) and returns an Airport object

## Support
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]



[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/ntilley905