🐋 pybelugaxl Documentation
========================

Welcome to 🐋 **pybelugaxl**, a Python library for tracking Airbus BelugaXL aircraft in real-time using FlightRadar24 data.

Overview
--------

pybelugaxl allow you to:

- Track live BelugaXL aircraft positions and flight status
- Filter flights by registration, status, origin, and destination
- Get detailed flight information including altitude, speed, heading

Installation
------------

Install pybelugaxl using pip:

.. code-block:: bash

   pip install pybelugaxl

Quick Start
-----------

Here's a simple example to get all active BelugaXL flights that are currently lsted on FlightRadar24:

.. code-block:: python

   from pybelugaxl import get_beluga

   # Get all Beluga flights
   flights = get_beluga()
   
   for flight in flights:
       print(f"{flight.registration}: {flight.from_airport} → {flight.to_airport}")
       print(f"  Altitude: {flight.altitude} ft, Speed: {flight.ground_speed} kt")

Filter by specific criteria:

.. code-block:: python

   # Get only flights that are enroute
   enroute_flights = get_beluga(status="enroute")
   
   # Get flights from a specific airport
   toulouse_flights = get_beluga(from_airport_icao="LFBO")
   
   # Track a specific aircraft
   specific_beluga = get_beluga(registration="F-GXLJ")

User Guide
----------

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   api
   examples

API Reference
=============

.. toctree::
   :maxdepth: 2
   
   modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`