apyefa 0.0.6__py3-none-any.whl → 1.0.0__py3-none-any.whl

apyefa/commands/command_trip.py

@@ -3,18 +3,28 @@ import logging
 from voluptuous import Any, Optional, Required, Schema
 
 from apyefa.commands.command import Command
-
-from ..data_classes import CoordFormat
+from apyefa.data_classes import CoordFormat, Jorney
 
 _LOGGER = logging.getLogger(__name__)
 
 
 class CommandTrip(Command):
-    def __init__(self) -> None:
-        super().__init__("XML_TRIP_REQUEST2", "trip")
+    def __init__(self, format: str) -> None:
+        super().__init__("XML_TRIP_REQUEST2", format)
 
     def parse(self, data: dict):
-        raise NotImplementedError
+        data = self._get_parser().parse(data)
+
+        journeys = data.get("journeys", [])
+
+        _LOGGER.info(f"{len(journeys)} journey(s) found")
+
+        result = []
+
+        for jorney in journeys:
+            result.append(Jorney.from_dict(jorney))
+
+        return result
 
     def _get_params_schema(self) -> Schema:
         return Schema(
@@ -23,6 +33,8 @@ class CommandTrip(Command):
                 Required("coordOutputFormat", default="WGS84"): Any(
                     *[x.value for x in CoordFormat]
                 ),
+                Required("locationServerActive", default="1"): Any("0", "1", 0, 1),
+                Required("itdTripDateTimeDepArr", default="dep"): Any("dep", "arr"),
                 Required("type_origin", default="any"): Any("any", "coord"),
                 Required("name_origin"): str,
                 Required("type_destination", default="any"): Any("any", "coord"),
@@ -31,5 +43,14 @@ class CommandTrip(Command):
                 Optional("name_via"): str,
                 Optional("useUT"): Any("0", "1", 0, 1),
                 Optional("useRealtime"): Any("0", "1", 0, 1),
+                Optional("deleteAssignedStops_origin"): Any("0", "1", 0, 1),
+                Optional("deleteAssignedStops_destination"): Any("0", "1", 0, 1),
+                Optional("genC"): Any("0", "1", 0, 1),
+                Optional("genP"): Any("0", "1", 0, 1),
+                Optional("genMaps"): Any("0", "1", 0, 1),
+                Optional("allInterchangesAsLegs"): Any("0", "1", 0, 1),
+                Optional("calcOneDirection"): Any("0", "1", 0, 1),
+                Optional("changeSpeed"): str,
+                Optional("coordOutputDistance"): Any("0", "1", 0, 1),
             }
         )

apyefa/data_classes.py

@@ -52,7 +52,7 @@ class TransportType(IntEnum):
     REGIONAL_BUS = 6  # Regionalbus
     EXPRESS_BUS = 7  # Schnellbus
     CABLE_RAIL = 8  # Seilbahn
-    FERRY = 9  # Schief
+    FERRY = 9  # Schiff
     AST = 10  # Anruf-Sammel-Taxi
     SUSPENSION_RAIL = 11  # Schwebebahn
     AIRPLANE = 12  # Flugzeug
@@ -63,6 +63,8 @@ class TransportType(IntEnum):
     RAIL_REPLACEMENT_TRANSPORT = 17  # Schienenersatzverkehr
     SHUTTLE_TRAIN = 18  # Schuttlezug
     CITIZEN_BUS = 19  # Bürgerbus
+    UNKNOWN = 99  # TBD
+    FOOT_PATH = 100  # Fussweg
 
 
 class LocationFilter(IntEnum):
@@ -76,6 +78,19 @@ class LocationFilter(IntEnum):
     POST_CODES = 64
 
 
+class PointTypeFilter(StrEnum):
+    ANY = "ANY"
+    BUS_POINT = "BUS_POINT"
+    ENTRANCE = "ENTRANCE"
+    GIS_AREA = "GIS_AREA"
+    GIS_POINT = "GIS_POINT"
+    LINE = "LINE"
+    POI_AREA = "POI_AREA"
+    POI_POINT = "POI_POINT"
+    STOP = "STOP"
+    STREET = "STREET"
+
+
 class LineRequestType(IntEnum):
     NONE = 0
     DEPARTURE_MONITOR = 1
@@ -90,14 +105,9 @@ class CoordFormat(StrEnum):
 
 
 # Validation schemas
-def IsLocationType(type: str):
-    if type not in [x.value for x in LocationFilter]:
-        raise ValueError
-
-
-SCHEMA_PROPERTIES = vol.Schema(
+_SCHEMA_PROPERTIES = vol.Schema(
     {
-        vol.Required("stopId"): str,
+        vol.Optional("stopId"): str,
         vol.Optional("downloads"): list,
         vol.Optional("area"): str,
         vol.Optional("platform"): str,
@@ -106,54 +116,30 @@ SCHEMA_PROPERTIES = vol.Schema(
     extra=vol.ALLOW_EXTRA,
 )
 
-SCHEMA_LINE_PROPERTIES: Final = vol.Schema(
-    {
-        vol.Required("globalId"): str,
-        vol.Required("isROP"): bool,
-        vol.Required("isSTT"): bool,
-        vol.Required("isTTB"): bool,
-        vol.Required("lineDisplay"): str,
-        vol.Required("timetablePeriod"): str,
-        vol.Required("tripCode"): int,
-        vol.Required("validity"): vol.Schema(
-            {
-                vol.Required("from"): vol.Date("%Y-%m-%d"),
-                vol.Required("to"): vol.Date("%Y-%m-%d"),
-            }
-        ),
-    }
-)
-
-SCHEMA_PRODUCT = vol.Schema(
+_SCHEMA_PRODUCT = vol.Schema(
     {
-        vol.Required("id"): int,
         vol.Required("class"): int,
-        vol.Required("name"): str,
+        vol.Optional("id"): int,
+        vol.Optional("name"): str,
         vol.Optional("iconId"): int,
     }
 )
 
-SCHEMA_STOP = vol.Schema(
-    {
-        vol.Required("name"): str,
-        vol.Required("type"): IsLocationType,
-        vol.Optional("id"): str,
-    }
-)
-
-SCHEMA_PARENT = vol.Schema(
+_SCHEMA_PARENT = vol.Schema(
     {
         vol.Required("name"): str,
         vol.Required("type"): str,
         vol.Optional("id"): str,
         vol.Optional("isGlobalId"): vol.Boolean,
+        vol.Optional("coord"): list,
+        vol.Optional("niveau"): int,
         vol.Optional("disassembledName"): str,
         vol.Optional("parent"): vol.Self,
-        vol.Optional("properties"): SCHEMA_PROPERTIES,
+        vol.Optional("properties"): _SCHEMA_PROPERTIES,
     }
 )
 
-SCHEMA_OPERATOR = vol.Schema(
+_SCHEMA_OPERATOR = vol.Schema(
     {
         vol.Required("id"): str,
         vol.Required("name"): str,
@@ -161,7 +147,7 @@ SCHEMA_OPERATOR = vol.Schema(
     }
 )
 
-SCHEMA_LOCATION: Final = vol.Schema(
+_SCHEMA_LOCATION: Final = vol.Schema(
     {
         vol.Required("name"): str,
         vol.Required("type"): vol.In([x.value for x in LocationType]),
@@ -169,32 +155,37 @@ SCHEMA_LOCATION: Final = vol.Schema(
         vol.Optional("disassembledName"): str,
         vol.Optional("coord"): list,
         vol.Optional("isGlobalId"): vol.Boolean,
+        vol.Optional("niveau"): int,
         vol.Optional("isBest"): vol.Boolean,
         vol.Optional("productClasses"): list[vol.Range(min=0, max=10)],
-        vol.Optional("parent"): SCHEMA_PARENT,
+        vol.Optional("parent"): _SCHEMA_PARENT,
         vol.Optional("assignedStops"): [vol.Self],
-        vol.Optional("properties"): SCHEMA_PROPERTIES,
+        vol.Optional("properties"): _SCHEMA_PROPERTIES,
         vol.Optional("matchQuality"): int,
+        vol.Optional("departureTimePlanned"): vol.Datetime("%Y-%m-%dT%H:%M:%S%z"),
+        vol.Optional("departureTimeEstimated"): vol.Datetime("%Y-%m-%dT%H:%M:%S%z"),
     },
     extra=vol.ALLOW_EXTRA,
 )
 
-SCHEMA_TRANSPORTATION: Final = vol.Schema(
+_SCHEMA_TRANSPORTATION: Final = vol.Schema(
     {
-        vol.Required("id"): str,
-        vol.Required("name"): str,
-        vol.Required("number"): str,
-        vol.Required("product"): SCHEMA_PRODUCT,
+        vol.Required("product"): _SCHEMA_PRODUCT,
+        vol.Optional("id"): str,
+        vol.Optional("number"): str,
+        vol.Optional("name"): str,
         vol.Optional("description"): str,
-        vol.Optional("operator"): SCHEMA_OPERATOR,
-        vol.Optional("destination"): SCHEMA_LOCATION,
-        vol.Optional("origin"): SCHEMA_LOCATION,
+        vol.Optional("operator"): _SCHEMA_OPERATOR,
+        vol.Optional("destination"): _SCHEMA_LOCATION,
+        vol.Optional("origin"): _SCHEMA_LOCATION,
         vol.Optional("properties"): dict,
         vol.Optional("disassembledName"): str,
-    }
+        vol.Optional("coord"): list,
+    },
+    extra=vol.ALLOW_EXTRA,
 )
 
-SCHEMA_SYSTEM_INFO: Final = vol.Schema(
+_SCHEMA_SYSTEM_INFO: Final = vol.Schema(
     {
         vol.Required("version"): str,
         vol.Required("ptKernel"): vol.Schema(
@@ -213,18 +204,45 @@ SCHEMA_SYSTEM_INFO: Final = vol.Schema(
     }
 )
 
-SCHEMA_DEPARTURE: Final = vol.Schema(
+_SCHEMA_DEPARTURE: Final = vol.Schema(
     {
-        vol.Required("location"): SCHEMA_LOCATION,
+        vol.Required("location"): _SCHEMA_LOCATION,
         vol.Required("departureTimePlanned"): vol.Datetime("%Y-%m-%dT%H:%M:%S%z"),
         vol.Optional("departureTimeEstimated"): vol.Datetime("%Y-%m-%dT%H:%M:%S%z"),
-        vol.Required("transportation"): SCHEMA_TRANSPORTATION,
+        vol.Required("transportation"): _SCHEMA_TRANSPORTATION,
         vol.Optional("infos"): list,
         vol.Optional("hints"): list,
     },
     extra=vol.ALLOW_EXTRA,
 )
 
+_SCHEMA_JORNEY: Final = vol.Schema(
+    {
+        vol.Optional("rating"): int,
+        vol.Required("isAdditional"): vol.Boolean,
+        vol.Required("interchanges"): int,
+        vol.Required("legs"): list,
+    },
+    extra=vol.ALLOW_EXTRA,
+)
+
+_SCHEMA_LEG: Final = vol.Schema(
+    {
+        vol.Required("duration"): int,
+        vol.Required("origin"): _SCHEMA_LOCATION,
+        vol.Required("destination"): _SCHEMA_LOCATION,
+        vol.Required("transportation"): _SCHEMA_TRANSPORTATION,
+        vol.Optional("stopSequence"): list,
+        vol.Optional("infos"): list,
+        vol.Optional("distance"): int,
+        vol.Optional("hints"): list,
+        vol.Optional("properties"): dict,
+        vol.Optional("isRealtimeControlled"): vol.Boolean,
+        vol.Optional("realtimeStatus"): list,
+        vol.Optional("footPathInfo"): list,
+    }
+)
+
 
 @dataclass(frozen=True)
 class _Base:
@@ -249,7 +267,7 @@ class SystemInfo(_Base):
     valid_from: date
     valid_to: date
 
-    _schema = SCHEMA_SYSTEM_INFO
+    _schema = _SCHEMA_SYSTEM_INFO
 
     @classmethod
     def from_dict(cls, data: dict) -> Self | None:
@@ -285,7 +303,7 @@ class Location(_Base):
     disassembled_name: str = field(repr=False, default="")
     match_quality: int = field(repr=False, default=0)
 
-    _schema = SCHEMA_LOCATION
+    _schema = _SCHEMA_LOCATION
 
     @classmethod
     def from_dict(cls, data: dict) -> Self | None:
@@ -337,7 +355,7 @@ class Departure(_Base):
     infos: list[dict] = field(default_factory=[])
     hints: list[dict] = field(default_factory=[])
 
-    _schema = SCHEMA_DEPARTURE
+    _schema = _SCHEMA_DEPARTURE
 
     @classmethod
     def from_dict(cls, data: dict) -> Self | None:
@@ -378,18 +396,47 @@ class Departure(_Base):
         )
 
 
+@dataclass(frozen=True)
+class Operator(_Base):
+    id: str
+    code: str
+    name: str
+
+    _schema = _SCHEMA_OPERATOR
+
+    @classmethod
+    def from_dict(cls, data: dict) -> Self | None:
+        if not data:
+            return None
+
+        if not isinstance(data, dict):
+            raise ValueError(f"Expected a dictionary, provided {type(data)}")
+
+        cls._schema(data)
+
+        return Operator(
+            data,
+            data.get("id"),
+            data.get("code"),
+            data.get("name"),
+        )
+
+
 @dataclass(frozen=True)
 class Line(_Base):
     id: str
     name: str
+    number: str
+    disassembled_name: str
     description: str
     product: TransportType
-    operator: str
+    operator: Operator | None
     destination: Location
     origin: Location
     properties: dict = field(default_factory={})
+    coords: list[float] = field(default_factory=[])
 
-    _schema = SCHEMA_TRANSPORTATION
+    _schema = _SCHEMA_TRANSPORTATION
 
     @classmethod
     def from_dict(cls, data: dict) -> Self | None:
@@ -403,25 +450,103 @@ class Line(_Base):
         cls._schema(data)
 
         id = data.get("id")
-        name = data.get("number")
-        # disassembled_name = data.get("disassembledName")
-        # number = data.get("number")
+        name = data.get("name", None)
+        number = data.get("number", None)
+        disassembled_name = data.get("disassembledName", None)
         description = data.get("description")
         product = TransportType(data.get("product").get("class"))
-        # operator = data.get("operator", None).get("name", None)
-        operator = "None"
+        operator = Operator.from_dict(data.get("operator", None))
         destination = Location.from_dict(data.get("destination"))
         origin = Location.from_dict(data.get("origin"))
         properties = data.get("properties", {})
+        coords = data.get("coord", [])
 
         return Line(
             data,
             id,
             name,
+            number,
+            disassembled_name,
             description,
             product,
             operator,
             destination,
             origin,
             properties,
+            coords,
+        )
+
+
+@dataclass(frozen=True)
+class Leg(_Base):
+    duration: int
+    distance: int
+    origin: Location
+    destination: Location
+    transport: Line
+    stop_sequence: list[Location]
+    infos: list[dict] | None
+
+    _schema = _SCHEMA_LEG
+
+    @classmethod
+    def from_dict(cls, data: dict) -> Self | None:
+        if not data:
+            return None
+
+        if not isinstance(data, dict):
+            raise ValueError(f"Expected a dictionary, provided {type(data)}")
+
+        # validate data dictionary
+        cls._schema(data)
+
+        duration = data.get("duration", 0)
+        distance = data.get("distance", 0)
+        origin = Location.from_dict(data.get("origin"))
+        destination = Location.from_dict(data.get("destination"))
+        transport = Line.from_dict(data.get("transportation"))
+        stop_sequence = [Location.from_dict(x) for x in data.get("stopSequence", [])]
+        infos = data.get("infos")
+
+        return Leg(
+            data,
+            duration,
+            distance,
+            origin,
+            destination,
+            transport,
+            stop_sequence,
+            infos,
         )
+
+
+@dataclass(frozen=True)
+class Jorney(_Base):
+    rating: int
+    is_additional: bool
+    interchanges: int
+    legs: list[Leg] = field(default_factory=[])
+
+    _schema = _SCHEMA_JORNEY
+
+    @classmethod
+    def from_dict(cls, data: dict) -> Self | None:
+        if not data:
+            return None
+
+        if not isinstance(data, dict):
+            raise ValueError(f"Expected a dictionary, provided {type(data)}")
+
+        # validate data dictionary
+        cls._schema(data)
+
+        rating = data.get("rating", 0)
+        is_additional = data.get("isAdditional", False)
+        interchanges = data.get("interchanges", 0)
+        legs = data.get("legs", [])
+        _legs = []
+
+        for leg in legs:
+            _legs.append(Leg.from_dict(leg))
+
+        return Jorney(data, rating, is_additional, interchanges, _legs)

apyefa/helpers.py

@@ -6,6 +6,15 @@ TZ_INFO = ZoneInfo("Europe/Berlin")
 
 
 def parse_datetime(date: str) -> datetime.datetime:
+    """
+    Parses a date string in ISO 8601 format and converts it to a timezone-aware datetime object.
+
+    Args:
+        date (str): The date string to parse in the format "%Y-%m-%dT%H:%M:%S%z".
+
+    Returns:
+        datetime.datetime: A timezone-aware datetime object if the input date is valid, otherwise None.
+    """
     if not date:
         return None
 
@@ -15,6 +24,15 @@ def parse_datetime(date: str) -> datetime.datetime:
 
 
 def parse_date(date: str) -> datetime.date:
+    """
+    Parses a date string in the format 'YYYY-MM-DD' and returns a datetime.date object.
+
+    Args:
+        date (str): The date string to parse.
+
+    Returns:
+        datetime.date: The parsed date object, or None if the input date string is empty.
+    """
     if not date:
         return None
 
@@ -22,10 +40,30 @@ def parse_date(date: str) -> datetime.date:
 
 
 def to_date(date: datetime.date) -> datetime.date:
+    """
+    Convert a datetime.date object to a string in the format 'YYYY-MM-DD'.
+
+    Args:
+        date (datetime.date): The date object to be converted.
+
+    Returns:
+        str: The date as a string in the format 'YYYY-MM-DD'.
+    """
     return datetime.datetime.strftime(date, "%Y-%m-%d")
 
 
 def is_datetime(date: str):
+    """
+    Check if the given string is in the format of a datetime.
+
+    The expected format is "YYYYMMDD HH:MM".
+
+    Args:
+        date (str): The date string to check.
+
+    Returns:
+        bool: True if the string is in the correct datetime format, False otherwise.
+    """
     if not isinstance(date, str) or not date:
         return False
 
@@ -41,6 +79,20 @@ def is_datetime(date: str):
 
 
 def is_date(date: str):
+    """
+    Check if the given string is a valid date in the format YYYYMMDD.
+
+    Args:
+        date (str): The date string to be validated.
+
+    Returns:
+        bool: True if the string is a valid date, False otherwise.
+
+    The function checks if the input string matches the pattern YYYYMMDD,
+    where YYYY is a four-digit year, MM is a two-digit month (01-12), and
+    DD is a two-digit day (01-31). It ensures that the month and day values
+    fall within the valid ranges.
+    """
     if not isinstance(date, str) or not date:
         return False
 
@@ -58,6 +110,15 @@ def is_date(date: str):
 
 
 def is_time(time: str):
+    """
+    Check if the given string is a valid time in HH:MM format.
+
+    Args:
+        time (str): The time string to validate.
+
+    Returns:
+        bool: True if the string is a valid time in HH:MM format, False otherwise.
+    """
     if not isinstance(time, str) or not time:
         return False
 

apyefa-1.0.0.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.1
+Name: apyefa
+Version: 1.0.0
+Summary: Python API for EFA(Elektronische Fahrplanauskunft) async requests
+Author-email: Alex Jung <jungdevelop@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2024 Alex Jung 
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/alex-jung/apyefa
+Project-URL: Documentation, https://github.com/alex-jung/apyefa
+Project-URL: Repository, https://github.com/alex-jung/apyefa
+Project-URL: Issues, https://github.com/alex-jung/apyefa/issues
+Keywords: efa,public transport,traffic
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.11.7
+Requires-Dist: voluptuous>=0.15.2
+Requires-Dist: tzdata>=2024.2
+Provides-Extra: tests
+Requires-Dist: coverage>=5.0.3; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-asyncio>=0.24.0; extra == "tests"
+Requires-Dist: pytest-benchmark[histogram]>=3.2.1; extra == "tests"
+Requires-Dist: requests>=2.32.3; extra == "tests"
+
+# apyefa
+[![Python package](https://github.com/alex-jung/apyefa/actions/workflows/python-package.yml/badge.svg)](https://github.com/alex-jung/apyefa/actions/workflows/python-package.yml)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Intro
+**apyefa** is a python package used to asynchronously fetch public transit routing data via EFA  interfaces like [efa.vgn](https://efa.vgn.de/vgnExt_oeffi/"). It can request itineraries for Bus/Trams/Subways etc. connections and return data in a human and machine readable format.
+
+# Installation
+You only need to install the **apyefa** package, for example using pip:
+``` bash
+pip install apyefa
+```
+
+# Restrictions
+Currently the package supports only endpoints using [RapidJSON](https://rapidjson.org/) format. To check whether the endpoint supports this format, please call:
+``` bash
+curl <EFA API URL>/XML_SYSTEMINFO_REQUEST?outputFormat=rapidJSON
+e.g. curl https://bahnland-bayern.de/efa/XML_SYSTEMINFO_REQUEST?outputFormat=rapidJSON
+```
+If API's answer looks like this, endpoint supports rapidJSON:
+```
+{"version":"10.6.21.17","ptKernel":{"appVersion":"10.6.22.28 build 16.12.2024 11:14:57","dataFormat":"EFA10_06_01","dataBuild":"2024-12-31T00:54:55Z"},"validity":{"from":"2024-12-15","to":"2025-06-14"}}
+```
+
+# Development setup
+Create and activate virtual environment. Then install dependencies required by `apefa` package.
+``` bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install .
+```
+
+# apyefa functions
+|Function Name                                                |Description|
+|----------------------------------------------------|-----------|
+|[info()](https://github.com/alex-jung/apyefa/wiki/info)|Provides EFA endpoint system information|
+|[locations_by_name()](https://github.com/alex-jung/apyefa/wiki/locations_by_name)|Search for locations by name with optional filters and limits|
+|[location_by_coord()](https://github.com/alex-jung/apyefa/wiki/location_by_coord)|Search for location by it's coordinates|
+|[list_lines()](https://github.com/alex-jung/apyefa/wiki/list_lines)|Retrieves a list of lines|
+|[list_stops()](https://github.com/alex-jung/apyefa/wiki/list_stops)|Retrieves a list of stops|
+|[trip()](https://github.com/alex-jung/apyefa/wiki/trip)|Calculates a trip between an origin and a destination locations|
+|[departures_by_location()](https://github.com/alex-jung/apyefa/wiki/departures_by_location)|Fetches departures for a given location|
+|[lines_by_name()](https://github.com/alex-jung/apyefa/wiki/lines_by_name)|Fetches lines by name|
+|[lines_by_location()](https://github.com/alex-jung/apyefa/wiki/lines_by_location)|Fetches lines for a specific location|
+|[line_stops()](https://github.com/alex-jung/apyefa/wiki/line_stops)|Retrieves the stops for a given line|
+|[coord_bounding_box()](https://github.com/alex-jung/apyefa/wiki/coord_bounding_box)|Requests locations within a bounding box|
+|[coord_radial()](https://github.com/alex-jung/apyefa/wiki/coord_radial)|Requests locations within a radius|
+|[geo_object()](https://github.com/alex-jung/apyefa/wiki/geo_object)|Generates a sequence of coordinates and all passed stops of a provided line|
+
+
+# Example
+``` python
+import asyncio
+from apyefa import EfaClient
+from apyefa.data_classes import (
+    Location,
+    LocationFilter,
+)
+
+async def async_info(client: EfaClient):
+    info = await client.info()
+    print(info)
+
+async def async_location_by_name(client: EfaClient):
+    stops: list[Location] = await client.locations_by_name(
+        "Plärrer", filters=[LocationFilter.STOPS], limit=20
+    )
+    for s in stops:
+        print(s)    
+
+async def main():
+    async with EfaClient("https://bahnland-bayern.de/efa/") as client:
+        await asyncio.gather(
+            async_info(client),
+            async_location_by_name(client),
+        )
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```