liveflight

This repository is for visualising flight data from KML/CSV files and open-source data feeds.

Project Description

liveflight is a tool designed to track flights and visualise flight data from KML and CSV formats. As the project is in its early stages, features and functionality are subject to significant changes and improvements.

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/liveflight.git
   cd liveflight
   

2. (Optional but recommended) Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   

3. Install the required packages (until I make the requirements.txt file):

   pip install fastapi uvicorn
   

Usage

To start the server, run the following command in your terminal:

uvicorn data_api:app --reload

This command does the following:

• uvicorn: The ASGI server used to run the FastAPI application
• data_api:app: Tells uvicorn to look for the app object in the data_api.py file
• --reload: Enables auto-reloading, so the server restarts when code changes are detected

After running this command, you should see output indicating that the server is running. By default, you can access the API at http://127.0.0.1:8000.

To stop the server, press CTRL+C in the terminal where it's running.

Current Features

• FastAPI backend to retrieve and serve flight data from open-source data sources.
• Simple frontend displaying live flight data onto a map given an icao24 identifier using Mapbox.

To Be Implemented

• OpenAPI specification
• Downloading flight data (from callsign, flight code, icao24)
• Show flight track, departure and arrival airports
• Visualise KML/CSV data onto a map
• Timeline of flights (e.g. multiple flights on the map with a scrollable selector to choose dates and times)