FlightRadarAPI 1.2.8__tar.gz → 1.3.1__tar.gz

{FlightRadarAPI-1.2.8 → FlightRadarAPI-1.3.1}/FlightRadar24/__init__.py

@@ -13,4 +13,4 @@ https://www.flightradar24.com/terms-and-conditions
 """
 
 __author__ = "Jean Loui Bernard Silva de Jesus"
-__version__ = "1.2.8"
+__version__ = "1.3.1"

FlightRadarAPI-1.3.1/FlightRadar24/api.py

@@ -0,0 +1,226 @@
+# -*- coding: utf-8 -*-
+from typing import Any, Dict, List, Optional, Tuple
+
+from .core import Core
+from .errors import LoginError
+from .flight import Flight
+from .request import APIRequest
+
+
+class FlightRadar24API(object):
+    """
+    Main class of the FlightRadarAPI
+    """
+
+    def __init__(self, user: Optional[str] = None, password: Optional[str] = None):
+        self.__real_time_flight_tracker_config = {
+            "faa": "1",
+            "satellite": "1",
+            "mlat": "1",
+            "flarm": "1",
+            "adsb": "1",
+            "gnd": "1",
+            "air": "1",
+            "vehicles": "1",
+            "estimated": "1",
+            "maxage": "14400",
+            "gliders": "1",
+            "stats": "1",
+            "limit": "5000"
+        }
+        self.__login_data: Optional[Dict] = None
+
+        if user is not None and password is not None:
+            self.login(user, password)
+
+    def get_airlines(self) -> List[Dict]:
+        """
+        Return a list with all airlines.
+        """
+        response = APIRequest(Core.airlines_data_url, headers = Core.json_headers)
+        return response.get_content()["rows"]
+
+    def get_airline_logo(self, iata: str, icao: str) -> Optional[Tuple[bytes, str]]:
+        """
+        Download the logo of an airline from FlightRadar24 and return it as bytes.
+        """
+        first_logo_url = Core.airline_logo_url.format(iata, icao)
+
+        # Try to get the image by the first URL option.
+        response = APIRequest(first_logo_url, headers = Core.image_headers)
+        status_code = response.get_status_code()
+
+        if not str(status_code).startswith("4"):
+            return response.get_content(), first_logo_url.split(".")[-1]
+
+        # Get the image by the second airline logo URL.
+        second_logo_url = Core.alternative_airline_logo_url.format(icao)
+
+        response = APIRequest(second_logo_url, headers = Core.image_headers)
+        status_code = response.get_status_code()
+
+        if not str(status_code).startswith("4"):
+            return response.get_content(), second_logo_url.split(".")[-1]
+
+    def get_airport(self, code: str) -> Dict:
+        """
+        Return detailed information about an airport.
+
+        :param code: ICAO or IATA of the airport.
+        """
+        response = APIRequest(Core.airport_data_url.format(code), headers = Core.json_headers)
+        return response.get_content()["details"]
+
+    def get_airports(self) -> List[Dict]:
+        """
+        Return a list with all airports.
+        """
+        response = APIRequest(Core.airports_data_url, headers = Core.json_headers)
+        return response.get_content()["rows"]
+
+    def get_bounds(self, zone: Dict[str, float]) -> str:
+        """
+        Convert coordinate dictionary to a string "y1, y2, x1, x2".
+
+        :param zone: Dictionary containing the following keys: tl_y, tl_x, br_y, br_x
+        """
+        return "{},{},{},{}".format(zone["tl_y"], zone["br_y"], zone["tl_x"], zone["br_x"])
+
+    def get_country_flag(self, country: str) -> Optional[Tuple[bytes, str]]:
+        """
+        Download the flag of a country from FlightRadar24 and return it as bytes.
+
+        :param country: Country name
+        """
+        flag_url = Core.country_flag_url.format(country.lower().replace(" ", "-"))
+        headers = Core.image_headers.copy()
+        
+        if "origin" in headers:
+            headers.pop("origin")  # Does not work for this request.
+
+        response = APIRequest(flag_url, headers = headers)
+        status_code = response.get_status_code()
+
+        if not str(status_code).startswith("4"):
+            return response.get_content(), flag_url.split(".")[-1]
+
+    def get_flight_details(self, flight_id: str) -> Dict[Any, Any]:
+        """
+        Return the flight details from Data Live Flightradar24.
+        """
+        response = APIRequest(Core.flight_data_url.format(flight_id), headers = Core.json_headers)
+        return response.get_content()
+
+    def get_flights(self, airline: str = None, bounds: str = None, registration: str = None, aircraft_type: str = None) -> List[Flight]:
+        """
+        Return a list of flights. See more options at set_real_time_flight_tracker_config() method.
+
+        :param airline: the airline ICAO. Ex: "DAL"
+        :param bounds: coordinates (y1, y2 ,x1, x2). Ex: "75.78,-75.78,-427.56,427.56"
+        :param registration: aircraft registration
+        :param aircraft_type: aircraft model code. Ex: "B737"
+        """
+        request_params = self.__real_time_flight_tracker_config.copy()
+
+        # Insert the parameters "airline", "bounds", "reg",and "type" in the dictionary for the request.
+        if airline: request_params["airline"] = airline
+        if bounds: request_params["bounds"] = bounds.replace(",", "%2C")
+        if registration: request_params["reg"] = registration
+        if aircraft_type: request_params["type"] = aircraft_type
+
+        # Get all flights from Data Live Flightradar24.
+        response = APIRequest(Core.real_time_flight_tracker_data_url, request_params, Core.json_headers)
+        response = response.get_content()
+
+        flights = []
+
+        for flight_id, flight_info in response.items():
+
+            # Get flights only.
+            if flight_id[0].isnumeric():
+                flights.append(Flight(flight_id, flight_info))
+
+        return flights
+
+    def get_login_data(self) -> Dict[Any, Any]:
+        """
+        Return the user data.
+        """
+        if not self.is_logged_in():
+            raise LoginError("You must log in to your account.")
+
+        return self.__login_data["userData"].copy()
+
+    def get_real_time_flight_tracker_config(self) -> Dict[str, str]:
+        """
+        Return the current config of the real time flight tracker, used by get_flights() method.
+        """
+        return self.__real_time_flight_tracker_config.copy()
+
+    def get_zones(self) -> Dict[str, Dict]:
+        """
+        Returns all major zones on the globe.
+        """
+        response = APIRequest(Core.zones_data_url, headers = Core.json_headers)
+        zones = response.get_content()
+
+        if "version" in zones:
+            zones.pop("version")
+
+        return zones
+
+    def is_logged_in(self) -> bool:
+        """
+        Check if the user is logged into the FlightRadar24 account.
+        """
+        return self.__login_data is not None
+
+    def login(self, user: str, password: str) -> None:
+        """
+        Log in to a FlightRadar24 account.
+
+        :param user: Your email.
+        :param password: Your password.
+        """
+        data = {
+            "email": user,
+            "password": password,
+            "remember": "true",
+            "type": "web"
+        }
+
+        response = APIRequest(Core.user_login_url, headers = Core.json_headers, data = data)
+        status_code = response.get_status_code()
+        content = response.get_content()
+
+        if not str(status_code).startswith("2") or not content.get("success"):
+            if isinstance(content, dict): raise LoginError(content["message"])
+            else: raise LoginError("Your email or password is incorrect")
+
+        self.__real_time_flight_tracker_config["enc"] = response.get_cookie("_frPl")
+
+        self.__login_data = {
+            "userData": content["userData"],
+            "cookies": response.get_cookies()
+        }
+
+    def logout(self) -> None:
+        """
+        Log out of the Flightradar24 account.
+        """
+        if not self.__login_data: return
+
+        APIRequest(Core.user_login_url, headers = Core.json_headers, cookies = self.__login_data["cookies"])
+
+        self.__real_time_flight_tracker_config.pop("enc")
+        self.__login_data = None
+
+    def set_real_time_flight_tracker_config(self, **config: str) -> None:
+        """
+        Set config for the real time flight tracker, used by get_flights() method.
+        """
+        for key, value in config.items():
+
+            # Check if the parameter exists and if the value is numeric.
+            if key in self.__real_time_flight_tracker_config and value.isnumeric():
+                self.__real_time_flight_tracker_config[key] = value

{FlightRadarAPI-1.2.8 → FlightRadarAPI-1.3.1}/FlightRadar24/core.py

@@ -13,6 +13,7 @@ class Core(ABC):
 
     # User login URL.
     user_login_url = flightradar_base_url + "/user/login"
+    user_logout_url = flightradar_base_url + "/user/logout"
 
     # Flights data URLs.
     real_time_flight_tracker_data_url = data_cloud_base_url + "/zones/fcgi/feed.js"

FlightRadarAPI-1.3.1/FlightRadar24/errors.py

@@ -0,0 +1,2 @@
+class LoginError(Exception):
+    pass

{FlightRadarAPI-1.2.8 → FlightRadarAPI-1.3.1}/FlightRadar24/request.py

@@ -15,18 +15,19 @@ class APIRequest(object):
         "gzip": gzip.decompress
     }
 
-    def __init__(self, url, params = {}, headers = {}, data = None):
+    def __init__(self, url, params = {}, headers = {}, data = None, cookies = None):
 
         self.url = url
         self.params = params
         self.headers = headers
         self.data = data
+        self.cookies = cookies
 
         if data is None:
             if params: url += "?" + "&".join(["{}={}".format(k, v) for k, v in params.items()])
-            self.__response = requests.get(url, headers = headers)
+            self.__response = requests.get(url, headers = headers, cookies = cookies)
         else:
-            self.__response = requests.post(url, data = data, headers = headers)
+            self.__response = requests.post(url, headers = headers, cookies = cookies, data = data)
 
     def get_content(self) -> Union[Dict, bytes]:
         content = self.__response.content

{FlightRadarAPI-1.2.8 → FlightRadarAPI-1.3.1/FlightRadarAPI.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlightRadarAPI
-Version: 1.2.8
+Version: 1.3.1
 Summary: API for FlightRadar24
 Home-page: https://github.com/JeanExtreme002/FlightRadarAPI
 Author: Jean Loui Bernard Silva de Jesus

{FlightRadarAPI-1.2.8 → FlightRadarAPI-1.3.1}/FlightRadarAPI.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ setup.py
 FlightRadar24/__init__.py
 FlightRadar24/api.py
 FlightRadar24/core.py
+FlightRadar24/errors.py
 FlightRadar24/flight.py
 FlightRadar24/request.py
 FlightRadarAPI.egg-info/PKG-INFO

{FlightRadarAPI-1.2.8/FlightRadarAPI.egg-info → FlightRadarAPI-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: FlightRadarAPI
-Version: 1.2.8
+Version: 1.3.1
 Summary: API for FlightRadar24
 Home-page: https://github.com/JeanExtreme002/FlightRadarAPI
 Author: Jean Loui Bernard Silva de Jesus

FlightRadarAPI-1.2.8/FlightRadar24/api.py

@@ -1,147 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from .core import Core
-from .flight import Flight
-from .request import APIRequest
-
-from deprecated import deprecated
-from typing import Dict, List
-
-
-class FlightRadar24API(object):
-    """
-    Flight Radar 24 API
-    """
-
-    __real_time_flight_tracker_config = {
-        "faa": "1",
-        "satellite": "1",
-        "mlat": "1",
-        "flarm": "1",
-        "adsb": "1",
-        "gnd": "1",
-        "air": "1",
-        "vehicles": "1",
-        "estimated": "1",
-        "maxage": "14400",
-        "gliders": "1",
-        "stats": "1",
-        "limit": "5000"
-        }
-
-    def login(self, user: str, password: str) -> Dict:
-        # Log in with Flightradar24 Premium user credentials
-        data = {
-            "email": user,
-            "password": password,
-            "remember": "true",
-            "type": "web"
-        }
-
-        request = APIRequest(Core.user_login_url, headers = Core.json_headers, data = data)
-        self.__real_time_flight_tracker_config["enc"] = request.get_cookie("_frPl")
-
-        return request.get_content()
-
-    def get_airlines(self) -> List[Dict]:
-        # Get the data from Flightradar24.
-        request = APIRequest(Core.airlines_data_url, headers = Core.json_headers)
-        return request.get_content()["rows"]
-
-    def get_airline_logo(self, iata: str, icao: str) -> str:
-        # Get the first airline logo URL.
-        first_logo_url = Core.airline_logo_url.format(iata, icao)
-
-        # Check if there was a problem with the request. If not, the URL is returned.
-        first_status_code = APIRequest(first_logo_url, headers = Core.image_headers).get_status_code()
-        if not str(first_status_code).startswith("4"): return first_logo_url
-
-        # Get the second airline logo URL.
-        second_logo_url = Core.alternative_airline_logo_url.format(icao)
-
-        # Check if there was a problem with the request. If not, the URL is returned.
-        second_status_code = APIRequest(second_logo_url, headers = Core.image_headers).get_status_code()
-        if not str(second_status_code).startswith("4"): return second_logo_url
-
-    def get_airport(self, code: str) -> Dict:
-        # Get the airport data from Flightradar24.
-        request = APIRequest(Core.airport_data_url.format(code), headers = Core.json_headers)
-        return request.get_content()["details"]
-
-    def get_airports(self) -> List[Dict]:
-        # Get the airports data from Flightradar24.
-        request = APIRequest(Core.airports_data_url, headers = Core.json_headers)
-        return request.get_content()["rows"]
-
-    def get_bounds(self, zone: Dict[str, float]) -> str:
-        # Convert coordinate dictionary (tl_y, tl_x, br_y, br_x) to string "y1, y2, x1, x2".
-        return "{},{},{},{}".format(zone["tl_y"], zone["br_y"] , zone["tl_x"], zone["br_x"])
-
-    def get_country_flag(self, country: str) -> str:
-        # Get the country flag image URL.
-        flag_url = Core.country_flag_url.format(country.lower().replace(" ", "-"))
-
-        headers = Core.image_headers.copy()
-        
-        if "origin" in headers:
-            headers.pop("origin") # Doesn't work for this request
-
-        # Check if there is a problem with the request. If not, the URL is returned.
-        status_code = APIRequest(flag_url, headers = headers).get_status_code()
-        if not str(status_code).startswith("4"): return flag_url
-
-    def get_flight_details(self, flight_id: str) -> Dict:
-        # Get the flight details from Data Live Flightradar24.
-        request = APIRequest(Core.flight_data_url.format(flight_id), headers = Core.json_headers)
-        return request.get_content()
-
-    def get_flights(self, airline: str = None, bounds: str = None, registration: str = None, aircraft_type: str = None) -> List[Flight]:
-        """
-        :param airline: the airline ICAO. Ex: "DAL"
-        :param bounds: coordinates (y1, y2 ,x1, x2). Ex: "75.78,-75.78,-427.56,427.56"
-        :param registration: aircraft registration
-        :param aircraft_type: aircraft model code. Ex: "B737"
-        """
-
-        request_params = self.__real_time_flight_tracker_config.copy()
-
-        # Insert the parameters "airline", "bounds", "reg",and "type" in the dictionary for the request.
-        if airline: request_params["airline"] = airline
-        if bounds: request_params["bounds"] = bounds.replace(",", "%2C")
-        if registration: request_params["reg"] = registration
-        if aircraft_type: request_params["type"] = aircraft_type
-
-        # Get all flights from Data Live Flightradar24.
-        request = APIRequest(Core.real_time_flight_tracker_data_url, request_params, Core.json_headers)
-        response = request.get_content()
-
-        flights = []
-
-        for flight_id, flight_info in response.items():
-
-            # Get flights only.
-            if flight_id[0].isnumeric():
-                flights.append(Flight(flight_id, flight_info))
-
-        return flights
-
-    def get_real_time_flight_tracker_config(self) -> Dict[str, str]:
-        return self.__real_time_flight_tracker_config.copy()
-
-    def get_zones(self) -> Dict:
-
-        # Get the zones data from Flightradar24.
-        request = APIRequest(Core.zones_data_url, headers = Core.json_headers)
-        zones = request.get_content()
-
-        # Remove version information.
-        zones.pop("version")
-        return zones
-
-    def set_real_time_flight_tracker_config(self, **config: str) -> None:
-
-        for key, value in config.items():
-
-            # Check if the parameter exists and if the value is numeric.
-            if key in self.__real_time_flight_tracker_config and value.isnumeric():
-                self.__real_time_flight_tracker_config[key] = value