An open API service indexing awesome lists of open source software.

https://github.com/zefir-git/eatc-airlines

A command-line tool and API for retrieving scheduled and historical flight data and generating Endless ATC airline configurations.
https://github.com/zefir-git/eatc-airlines

airlines airspace atc eatc endlessatc traffic

Last synced: 6 months ago
JSON representation

A command-line tool and API for retrieving scheduled and historical flight data and generating Endless ATC airline configurations.

Awesome Lists containing this project

README

          

# eatc-airlines

A command-line tool and API for retrieving scheduled and historical flight data and generating *Endless
ATC* airline configurations.

## Features

- Fetch scheduled and past flights (up to 7 days) from [AirNav Radar](https://airnavradar.com).
- Convert flight data into `airlines` configuration for *Endless ATC* custom airspace.
- Analyse traffic flow statistics from flight data.
- Simple, fast, and works offline once data is fetched.
- No API key or authentication required.

---

## Installation

### Requirements

- [Node.js and NPM](https://nodejs.org/en/download/) (Latest LTS version recommended).
- A terminal, Command Prompt (cmd.exe), or similar for executing shell commands.

### Install Globally

Use your preferred terminal application to run the following command:

```sh
npm install -g eatc-airlines
```

### Android Installation (via Termux)

1. Install *Termux*, a terminal emulator for Android:

[Get it on Google Play](https://play.google.com/store/apps/details?id=com.termux)
[Get it on F-Droid](https://f-droid.org/packages/com.termux)

2. Install Node.js and NPM:
```sh
pkg install nodejs
```
3. Install `eatc-airlines`:
```sh
npm i -g eatc-airlines
```

### Updating

To update to the latest version:

```sh
npm install -g eatc-airlines@latest
```

---

## Usage

### Fetching Flight Data

Retrieve scheduled and historical flights (up to 7 days in the past) for a specific airport.

#### Command:

```sh
eatc-airlines fetch [path]
```

- `` – **ICAO airport code** (e.g., `EGLL` for Heathrow).
- `[path]` – *(Optional)* **File path** to save the data. Defaults to a unique file in the current directory.

#### Example:

```sh
mkdir EGLL && cd EGLL
eatc-airlines fetch EGLL
```

> [!NOTE]
> The fetched JSON files should not be manually edited unless you know what you are doing.

---

### Generating `airlines` Configuration for *Endless ATC*

Convert fetched flight data into an `airlines` configuration for *Endless ATC*.

#### Command:

```sh
eatc-airlines gen
```

- `` – **One or more JSON files or directories** containing flight data.

#### Example:

```sh
# Convert all flight data in the current directory
eatc-airlines gen .

# Convert all files in a specific directory
eatc-airlines gen ./EGLL

# Convert specific files
eatc-airlines gen file1.json file2.json

# Save output to a file
eatc-airlines gen ./EGLL > EGLL-airlines.txt
```

---

### Analysing Traffic Flow

Generate basic statistics on traffic flow from fetched flight data.

#### Command:

```sh
eatc-airlines flow
```

Uses the same arguments as the `gen` command.

#### Example:

```sh
eatc-airlines flow ./EGLL
```

---

## Contributing

This project is **free and open-source** under
the [GNU General Public License, Version 3](https://www.gnu.org/licenses/gpl-3.0.en.html). Contributions are welcome!

For inquiries or collaboration, contact:

| Matrix | [@zefir:cloudnode.pro](https://matrix.to/#/@zefir:cloudnode.pro) |
|--------|------------------------------------------------------------------|
| E-mail | [eatc+airlines@zefir.pro](mailto:eatc+airlines@zefir.pro) |