apyefa 0.0.3__tar.gz → 0.0.5__tar.gz

apyefa-0.0.5/.github/labeler.yml

@@ -0,0 +1,14 @@
+documentation:
+- changed-files:
+  - any-glob-to-any-file: '**/*.md'
+
+# Add 'feature' label to any PR where the head branch name starts with `feature` or has a `feature` section in the name
+feature:
+ - head-branch: ['^feature', 'feature']
+
+bugfix:
+- head-branch: ['^bugfix', '^fix']
+
+# Add 'release' label to any PR that is opened against the `main` branch
+release:
+ - base-branch: 'master'

apyefa-0.0.5/.github/release-drafter.yml

@@ -0,0 +1,29 @@
+categories:
+  - title: ":boom: Breaking Changes"
+    label: "breaking"
+  - title: ":rocket: Features"
+    label: "enhancement"
+  - title: ":fire: Removals and Deprecations"
+    label: "removal"
+  - title: ":beetle: Fixes"
+    label: "bug"
+  - title: ":racehorse: Performance"
+    label: "performance"
+  - title: ":rotating_light: Testing"
+    label: "testing"
+  - title: ":construction_worker: Continuous Integration"
+    label: "ci"
+  - title: ":books: Documentation"
+    label: "documentation"
+  - title: ":hammer: Refactoring"
+    label: "refactoring"
+  - title: ":lipstick: Style"
+    label: "style"
+  - title: ":package: Dependencies"
+    labels:
+      - "dependencies"
+      - "build"
+template: |
+  ## Changes
+
+  $CHANGES

apyefa-0.0.5/.github/workflows/labeler.yml

@@ -0,0 +1,13 @@
+name: "Pull Request Labeler"
+on:
+- pull_request_target
+
+jobs:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: "actions/checkout@v4"
+    - uses: "actions/labeler@v5"

apyefa-0.0.5/.github/workflows/release_drafter.yml

@@ -0,0 +1,15 @@
+name: Draft a release note
+on:
+  push:
+    branches:
+      - main
+      - master
+jobs:
+  draft_release:
+    name: Release Drafter
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run release-drafter
+        uses: release-drafter/release-drafter@v6.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.API_TOKEN }}

{apyefa-0.0.3 → apyefa-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apyefa
-Version: 0.0.3
+Version: 0.0.5
 Summary: Python API for EFA(Elektronische Fahrplanauskunft) async requests
 Author-email: Alex Jung <jungdevelop@gmail.com>
 License: MIT License
@@ -28,7 +28,7 @@ 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,vgn,gtfs,public transport,traffic
+Keywords: efa,public transport,traffic
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -280,14 +280,13 @@ Find lines pass provided location.
 |Arguments|Type                |Required|Description|
 |---------|--------------------|--------|-----------|
 |location |str \| [Location](#location) |required|The location passed by searched line(s)|
+|req_types|list[[LineRequestType](#lineRequestType)]|optional|The result presentation type(s) can be defined with this argument. Default value is `[]`
 
 ### Return value
 |Type|Description|
 |----|-----------|
 |list[[Line](#line)]|List of lines found for provided location|
 
-> The attribute `origin` of returned `line` objects is None
-
 ### Examples
 ``` python
 async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
@@ -367,17 +366,37 @@ async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
 ## TransportType
 ```python
 class TransportType(IntEnum):
-    RAIL        = 0 
-    SUBURBAN    = 1
-    SUBWAY      = 2 
-    CITY_RAIL   = 3 
-    TRAM        = 4
-    BUS         = 5 
-    RBUS        = 6 
-    EXPRESS_BUS = 7
-    CABLE_TRAM  = 8
-    FERRY       = 9 
-    AST         = 10  # Anruf-Sammel-Taxi
+    TRAIN                      = 0  # Zug
+    SUBURBAN                   = 1  # S-Bahn
+    SUBWAY                     = 2  # U-Bahn
+    CITY_RAIL                  = 3  # Stadtbahn
+    TRAM                       = 4  # Straßenbahn
+    CITY_BUS                   = 5  # Stadtbus
+    REGIONAL_BUS               = 6  # Regionalbus
+    EXPRESS_BUS                = 7  # Schnellbus
+    CABLE_RAIL                 = 8  # Seilbahn
+    FERRY                      = 9  # Schief
+    AST                        = 10 # Anruf-Sammel-Taxi
+    SUSPENSION_RAIL            = 11 # Schwebebahn
+    AIRPLANE                   = 12 # Flugzeug
+    REGIONAL_TRAIN             = 13 # Reginalzug (z.B. IRE, RE und RB)
+    NATIONAL_TRAIN             = 14 # Nationaler Zug (z.B. IR und D)
+    INTERNATINAL_TRAIN         = 15 # Internationaler Zug (z.B. IC und EC)
+    HIGH_SPEED_TRAIN           = 16 # Hochgeschwindigkeitzüge (z.B. ICE)
+    RAIL_REPLACEMENT_TRANSPORT = 17 # Schienenersatzverkehr
+    SHUTTLE_TRAIN              = 18 # Schuttlezug
+    CITIZEN_BUS                = 19 # Bürgerbus
+```
+
+## LineRequestType
+```python
+class LineRequestType(IntEnum):
+    NONE              = 0
+    DEPARTURE_MONITOR = 1
+    STOP_TIMETABLE    = 2
+    TIMETABLE         = 4
+    ROUTE_MAPS        = 8
+    STATION_TIMETABLE = 16
 ```
 
 ## CoordFormat

{apyefa-0.0.3 → apyefa-0.0.5}/README.md

@@ -235,14 +235,13 @@ Find lines pass provided location.
 |Arguments|Type                |Required|Description|
 |---------|--------------------|--------|-----------|
 |location |str \| [Location](#location) |required|The location passed by searched line(s)|
+|req_types|list[[LineRequestType](#lineRequestType)]|optional|The result presentation type(s) can be defined with this argument. Default value is `[]`
 
 ### Return value
 |Type|Description|
 |----|-----------|
 |list[[Line](#line)]|List of lines found for provided location|
 
-> The attribute `origin` of returned `line` objects is None
-
 ### Examples
 ``` python
 async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
@@ -322,17 +321,37 @@ async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
 ## TransportType
 ```python
 class TransportType(IntEnum):
-    RAIL        = 0 
-    SUBURBAN    = 1
-    SUBWAY      = 2 
-    CITY_RAIL   = 3 
-    TRAM        = 4
-    BUS         = 5 
-    RBUS        = 6 
-    EXPRESS_BUS = 7
-    CABLE_TRAM  = 8
-    FERRY       = 9 
-    AST         = 10  # Anruf-Sammel-Taxi
+    TRAIN                      = 0  # Zug
+    SUBURBAN                   = 1  # S-Bahn
+    SUBWAY                     = 2  # U-Bahn
+    CITY_RAIL                  = 3  # Stadtbahn
+    TRAM                       = 4  # Straßenbahn
+    CITY_BUS                   = 5  # Stadtbus
+    REGIONAL_BUS               = 6  # Regionalbus
+    EXPRESS_BUS                = 7  # Schnellbus
+    CABLE_RAIL                 = 8  # Seilbahn
+    FERRY                      = 9  # Schief
+    AST                        = 10 # Anruf-Sammel-Taxi
+    SUSPENSION_RAIL            = 11 # Schwebebahn
+    AIRPLANE                   = 12 # Flugzeug
+    REGIONAL_TRAIN             = 13 # Reginalzug (z.B. IRE, RE und RB)
+    NATIONAL_TRAIN             = 14 # Nationaler Zug (z.B. IR und D)
+    INTERNATINAL_TRAIN         = 15 # Internationaler Zug (z.B. IC und EC)
+    HIGH_SPEED_TRAIN           = 16 # Hochgeschwindigkeitzüge (z.B. ICE)
+    RAIL_REPLACEMENT_TRANSPORT = 17 # Schienenersatzverkehr
+    SHUTTLE_TRAIN              = 18 # Schuttlezug
+    CITIZEN_BUS                = 19 # Bürgerbus
+```
+
+## LineRequestType
+```python
+class LineRequestType(IntEnum):
+    NONE              = 0
+    DEPARTURE_MONITOR = 1
+    STOP_TIMETABLE    = 2
+    TIMETABLE         = 4
+    ROUTE_MAPS        = 8
+    STATION_TIMETABLE = 16
 ```
 
 ## CoordFormat

{apyefa-0.0.3 → apyefa-0.0.5}/apyefa/client.py

@@ -13,6 +13,7 @@ from apyefa.data_classes import (
     CoordFormat,
     Departure,
     Line,
+    LineRequestType,
     Location,
     LocationFilter,
     LocationType,
@@ -162,20 +163,24 @@ class EfaClient:
 
         return command.parse(response)
 
-    async def lines_by_location(self, location: str | Location) -> list[Line]:
-        """Search for lines that pass `location`. Location can be location ID like `de:08111:6221` or a Location object
+    async def lines_by_location(
+        self, location: str | Location, req_types: list[LineRequestType] = []
+    ) -> list[Line]:
+        """Search for lines that pass `location`. Location can be location ID like `de:08111:6221` or a `Location` object
 
         Args:
             location (str | Location): Location
+            req_types (list[LineRequestType], optional): List of types for the request. Defaults to empty.
 
         Raises:
-            ValueError: If not a stop location provided but e.g. POI or Address
+            ValueError: Wrong location type provided e.g. LocationType.POI or LocationType.ADDRESS
 
         Returns:
             list[Transport]: List of lines
         """
         _LOGGER.info("Request lines by location")
         _LOGGER.debug(f"location:{location}")
+        _LOGGER.debug(f"filters :{req_types}")
 
         if isinstance(location, Location):
             if location.loc_type != LocationType.STOP:
@@ -186,6 +191,9 @@ class EfaClient:
 
         command = CommandServingLines("odv", location)
 
+        if req_types:
+            command.add_param("lineReqType", sum(req_types))
+
         response = await self._run_query(self._build_url(command))
 
         return command.parse(response)

{apyefa-0.0.3 → apyefa-0.0.5}/apyefa/commands/command_serving_lines.py

@@ -1,9 +1,9 @@
 import logging
 
-from voluptuous import Any, Optional, Required, Schema
+from voluptuous import Any, Optional, Range, Required, Schema
 
 from apyefa.commands.command import Command
-from apyefa.data_classes import Line
+from apyefa.data_classes import Line, LineRequestType
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -48,7 +48,9 @@ class CommandServingLines(Command):
                 Optional("name_sl"): str,
                 # mode 'line'
                 Optional("lineName"): str,
-                Optional("lineReqType"): int,
+                Optional("lineReqType"): Range(
+                    min=0, max=sum([x.value for x in LineRequestType])
+                ),
                 Optional("mergeDir"): Any("0", "1", 0, 1),
                 Optional("lsShowTrainsExplicit"): Any("0", "1", 0, 1),
                 Optional("line"): str,

{apyefa-0.0.3 → apyefa-0.0.5}/apyefa/data_classes.py

@@ -21,18 +21,48 @@ class LocationType(StrEnum):
     UNKNOWN = "unknown"
 
 
+class InfoType(StrEnum):
+    AREA_INFO = "areaInfo"
+    STOP_INFO = "stopInfo"
+    STOP_BLOCKING = "stopBlocking"
+    LINE_INFO = "lineInfo"
+    LINE_BLOCKING = "lineBlocking"
+    ROUTE_INFO = "routeInfo"
+    ROUTE_BLOCKING = "routeBlocking"
+    GENERAL_INFO = "generalInfo"
+    BANNER_INFO = "bannerInfo"
+    TRAFFIC_INFO = "trafficInformation"
+
+
+class InfoPriority(StrEnum):
+    VERY_LOW = "veryLow"
+    LOW = "low"
+    NORMAL = "normal"
+    HIGH = "high"
+    VERY_HIGH = "veryHigh"
+
+
 class TransportType(IntEnum):
-    RAIL = 0  # RB
+    TRAIN = 0  # Zug
     SUBURBAN = 1  # S-Bahn
     SUBWAY = 2  # U-Bahn
     CITY_RAIL = 3  # Stadtbahn
     TRAM = 4  # Straßenbahn
-    BUS = 5  # Bus
-    RBUS = 6  # Regional Bus
+    CITY_BUS = 5  # Stadtbus
+    REGIONAL_BUS = 6  # Regionalbus
     EXPRESS_BUS = 7  # Schnellbus
-    CABLE_TRAM = 8  # Seilbahn
+    CABLE_RAIL = 8  # Seilbahn
     FERRY = 9  # Schief
     AST = 10  # Anruf-Sammel-Taxi
+    SUSPENSION_RAIL = 11  # Schwebebahn
+    AIRPLANE = 12  # Flugzeug
+    REGIONAL_TRAIN = 13  # Reginalzug (z.B. IRE, RE und RB)
+    NATIONAL_TRAIN = 14  # Nationaler Zug (z.B. IR und D)
+    INTERNATINAL_TRAIN = 15  # Internationaler Zug (z.B. IC und EC)
+    HIGH_SPEED_TRAIN = 16  # Hochgeschwindigkeitzüge (z.B. ICE)
+    RAIL_REPLACEMENT_TRANSPORT = 17  # Schienenersatzverkehr
+    SHUTTLE_TRAIN = 18  # Schuttlezug
+    CITIZEN_BUS = 19  # Bürgerbus
 
 
 class LocationFilter(IntEnum):
@@ -46,6 +76,15 @@ class LocationFilter(IntEnum):
     POST_CODES = 64
 
 
+class LineRequestType(IntEnum):
+    NONE = 0
+    DEPARTURE_MONITOR = 1
+    STOP_TIMETABLE = 2
+    TIMETABLE = 4
+    ROUTE_MAPS = 8
+    STATION_TIMETABLE = 16
+
+
 class CoordFormat(StrEnum):
     WGS84 = "WGS84[dd.ddddd]"
 
@@ -63,7 +102,8 @@ SCHEMA_PROPERTIES = vol.Schema(
         vol.Optional("area"): str,
         vol.Optional("platform"): str,
         vol.Optional("platformName"): str,
-    }
+    },
+    extra=vol.ALLOW_EXTRA,
 )
 
 SCHEMA_LINE_PROPERTIES: Final = vol.Schema(
@@ -143,14 +183,14 @@ SCHEMA_TRANSPORTATION: Final = vol.Schema(
     {
         vol.Required("id"): str,
         vol.Required("name"): str,
-        vol.Required("disassembledName"): str,
         vol.Required("number"): str,
-        vol.Required("description"): str,
         vol.Required("product"): SCHEMA_PRODUCT,
+        vol.Optional("description"): str,
         vol.Optional("operator"): SCHEMA_OPERATOR,
         vol.Optional("destination"): SCHEMA_LOCATION,
         vol.Optional("origin"): SCHEMA_LOCATION,
         vol.Optional("properties"): dict,
+        vol.Optional("disassembledName"): str,
     }
 )
 
@@ -181,7 +221,8 @@ SCHEMA_DEPARTURE: Final = vol.Schema(
         vol.Required("transportation"): SCHEMA_TRANSPORTATION,
         vol.Optional("infos"): list,
         vol.Optional("hints"): list,
-    }
+    },
+    extra=vol.ALLOW_EXTRA,
 )
 
 
@@ -367,7 +408,8 @@ class Line(_Base):
         # number = data.get("number")
         description = data.get("description")
         product = TransportType(data.get("product").get("class"))
-        operator = data.get("operator").get("name")
+        # operator = data.get("operator", None).get("name", None)
+        operator = "None"
         destination = Location.from_dict(data.get("destination"))
         origin = Location.from_dict(data.get("origin"))
         properties = data.get("properties", {})

{apyefa-0.0.3 → apyefa-0.0.5}/apyefa.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: apyefa
-Version: 0.0.3
+Version: 0.0.5
 Summary: Python API for EFA(Elektronische Fahrplanauskunft) async requests
 Author-email: Alex Jung <jungdevelop@gmail.com>
 License: MIT License
@@ -28,7 +28,7 @@ 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,vgn,gtfs,public transport,traffic
+Keywords: efa,public transport,traffic
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -280,14 +280,13 @@ Find lines pass provided location.
 |Arguments|Type                |Required|Description|
 |---------|--------------------|--------|-----------|
 |location |str \| [Location](#location) |required|The location passed by searched line(s)|
+|req_types|list[[LineRequestType](#lineRequestType)]|optional|The result presentation type(s) can be defined with this argument. Default value is `[]`
 
 ### Return value
 |Type|Description|
 |----|-----------|
 |list[[Line](#line)]|List of lines found for provided location|
 
-> The attribute `origin` of returned `line` objects is None
-
 ### Examples
 ``` python
 async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
@@ -367,17 +366,37 @@ async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
 ## TransportType
 ```python
 class TransportType(IntEnum):
-    RAIL        = 0 
-    SUBURBAN    = 1
-    SUBWAY      = 2 
-    CITY_RAIL   = 3 
-    TRAM        = 4
-    BUS         = 5 
-    RBUS        = 6 
-    EXPRESS_BUS = 7
-    CABLE_TRAM  = 8
-    FERRY       = 9 
-    AST         = 10  # Anruf-Sammel-Taxi
+    TRAIN                      = 0  # Zug
+    SUBURBAN                   = 1  # S-Bahn
+    SUBWAY                     = 2  # U-Bahn
+    CITY_RAIL                  = 3  # Stadtbahn
+    TRAM                       = 4  # Straßenbahn
+    CITY_BUS                   = 5  # Stadtbus
+    REGIONAL_BUS               = 6  # Regionalbus
+    EXPRESS_BUS                = 7  # Schnellbus
+    CABLE_RAIL                 = 8  # Seilbahn
+    FERRY                      = 9  # Schief
+    AST                        = 10 # Anruf-Sammel-Taxi
+    SUSPENSION_RAIL            = 11 # Schwebebahn
+    AIRPLANE                   = 12 # Flugzeug
+    REGIONAL_TRAIN             = 13 # Reginalzug (z.B. IRE, RE und RB)
+    NATIONAL_TRAIN             = 14 # Nationaler Zug (z.B. IR und D)
+    INTERNATINAL_TRAIN         = 15 # Internationaler Zug (z.B. IC und EC)
+    HIGH_SPEED_TRAIN           = 16 # Hochgeschwindigkeitzüge (z.B. ICE)
+    RAIL_REPLACEMENT_TRANSPORT = 17 # Schienenersatzverkehr
+    SHUTTLE_TRAIN              = 18 # Schuttlezug
+    CITIZEN_BUS                = 19 # Bürgerbus
+```
+
+## LineRequestType
+```python
+class LineRequestType(IntEnum):
+    NONE              = 0
+    DEPARTURE_MONITOR = 1
+    STOP_TIMETABLE    = 2
+    TIMETABLE         = 4
+    ROUTE_MAPS        = 8
+    STATION_TIMETABLE = 16
 ```
 
 ## CoordFormat

{apyefa-0.0.3 → apyefa-0.0.5}/apyefa.egg-info/SOURCES.txt

@@ -3,7 +3,11 @@ LICENSE
 README.md
 examples.py
 pyproject.toml
+.github/labeler.yml
+.github/release-drafter.yml
+.github/workflows/labeler.yml
 .github/workflows/python-package.yml
+.github/workflows/release_drafter.yml
 .vscode/settings.json
 apyefa/__init__.py
 apyefa/client.py

{apyefa-0.0.3 → apyefa-0.0.5}/examples.py

@@ -1,15 +1,18 @@
 import asyncio
-from apyefa import EfaClient, StopFilter
 from pprint import pprint
 
+from apyefa import EfaClient, LocationFilter
+
 
 async def main():
     async with EfaClient("https://efa.vgn.de/vgnExt_oeffi/") as client:
         result = await asyncio.gather(
             client.info(),
-            client.stops("Nürnberg Plärrer"),
-            client.stops("Nordostbahnhof", filters=[StopFilter.STOPS]),
-            client.departures("de:09564:704", limit=10, date="20241126 16:30"),
+            client.locations_by_name("Nürnberg Plärrer"),
+            client.locations_by_name("Nordostbahnhof", filters=[LocationFilter.STOPS]),
+            client.departures_by_location(
+                "de:09564:704", limit=10, date="20241126 16:30"
+            ),
         )
 
     print("System Info".center(60, "-"))

{apyefa-0.0.3 → apyefa-0.0.5}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "apyefa"
-version = "0.0.3"
+version = "0.0.5"
 requires-python = ">= 3.11"
 description = "Python API for EFA(Elektronische Fahrplanauskunft) async requests"
 authors = [
@@ -15,7 +15,7 @@ authors = [
 ]
 readme = "README.md"
 license = {file = "LICENSE"}
-keywords = ["efa", "vgn", "gtfs", "public transport", "traffic"]
+keywords = ["efa", "public transport", "traffic"]
 
 dependencies = [
     "aiohttp>=3.11.7",
@@ -37,6 +37,7 @@ tests = [
 minversion = "6.0"
 asyncio_mode="auto"
 addopts = "-ra -q"
+asyncio_default_fixture_loop_scope = "function"
 testpaths = [
     "tests"
 ]

{apyefa-0.0.3 → apyefa-0.0.5}/tests/commands/test_cmd_departures.py

@@ -12,7 +12,7 @@ STOP_ID_PLAERRER: Final = "de:09564:704"
 
 @pytest.fixture(scope="module")
 def query_url():
-    return f"https://efa.vgn.de/vgnExt_oeffi/{NAME}?commonMacro={MACRO}&outputFormat=rapidJSON&name_dm={STOP_ID_PLAERRER}&itdTime=2216&itdDate=20241110&mode=direct&type_dm=stop"
+    return f"https://efa.vgn.de/vgnExt_oeffi/{NAME}?commonMacro={MACRO}&outputFormat=rapidJSON&name_dm={STOP_ID_PLAERRER}&mode=direct&type_dm=stop"
 
 
 @pytest.fixture