apyefa 1.1.6__tar.gz

apyefa-1.1.6/.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+ARG PYTHON_VERSION=3.12
+
+FROM python:${PYTHON_VERSION}-slim
+
+WORKDIR /app
+
+COPY . .
+
+RUN apt-get update && apt-get install -y git \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN pip install --no-cache-dir uv
+
+RUN uv sync --frozen --all-groups
+
+CMD ["uv", "run", "pytest"]

apyefa-1.1.6/.devcontainer/devcontainer.json

@@ -0,0 +1,20 @@
+{
+    "name": "Python + uv",
+    "build": {
+        "dockerfile": "Dockerfile",
+        "context": ".."
+    },
+
+    "customizations": {
+        "vscode": {
+            "extensions": ["ms-python.python", "ms-python.vscode-pylance", "charliermarsh.ruff", "ms-azuretools.vscode-docker"],
+            "settings": {
+                "python.defaultInterpreterPath": "/usr/local/bin/python",
+                "python.analysis.typeCheckingMode": "basic"
+            }
+        }
+    },
+
+    "postCreateCommand": "uv sync --all-groups",
+    "remoteUser": "root"
+}

apyefa-1.1.6/.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: alexjungnbg

apyefa-1.1.6/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+  - package-ecosystem: pip
+    directory: "/.github/workflows"
+    schedule:
+      interval: daily
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: daily

apyefa-1.1.6/.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-1.1.6/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: Lint, check format and tests
+
+on:
+  push:
+    branches: ["**"]
+    tags-ignore: ["v*"]
+  pull_request:
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Display Python version
+      run: python -c "import sys; print(sys.version)"
+
+    - name: Build Docker image
+      run: |
+        docker build \
+          --build-arg PYTHON_VERSION=${{ matrix.python-version }} \
+          -t apyefa:${{ matrix.python-version }} -f .devcontainer/Dockerfile .
+
+    - name: Lint code
+      run: docker run --rm apyefa:${{ matrix.python-version }} uv run ruff check .
+
+    - name: Check code formatting
+      run: docker run --rm apyefa:${{ matrix.python-version }} uv run black --check .
+
+    - name: Run tests
+      run: |
+        docker run --rm apyefa:${{ matrix.python-version }} uv run pytest .

apyefa-1.1.6/.github/workflows/publish.yml

@@ -0,0 +1,57 @@
+name: Build and publish to PyPI
+
+on: 
+  push:
+    tags:
+       - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Build Docker image
+        run: |
+          docker build \
+            -t apyefa:release -f .devcontainer/Dockerfile .
+
+      - name: Build package
+        run: |
+          docker run --rm \
+            -v $PWD/dist:/app/dist \
+            apyefa:release \
+            uv run python -m build
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install twine tool
+        run: |
+          python -m pip install --upgrade pip
+          pip install twine
+
+      - name: Decide publish target
+        id: target
+        run: |
+          if [[ "${GITHUB_REF_NAME}" == *dev* ]]; then
+            echo "url=https://test.pypi.org/legacy/" >> $GITHUB_OUTPUT
+            echo "token=TEST_PYPI_API_TOKEN" >> $GITHUB_OUTPUT
+          else
+            echo "url=https://upload.pypi.org/legacy/" >> $GITHUB_OUTPUT
+            echo "token=PYPI_API_TOKEN" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Publish to (Test) PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets[steps.target.outputs.token] }}
+        run: |
+          twine upload \
+            --repository-url ${{ steps.target.outputs.url }} \
+            dist/*

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

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

apyefa-1.1.6/.gitignore

@@ -0,0 +1,55 @@
+# developing script
+script.py
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+
+# Environments
+.venv

apyefa-1.1.6/.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "editor.codeActionsOnSave": 
+    {
+        "source.organizeImports": "always",
+    },
+    "editor.formatOnSave": true,
+    "[json]": {
+        "editor.defaultFormatter": "vscode.json-language-features"
+    },
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "notebook.defaultFormatter": "charliermarsh.ruff",
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    }
+}

apyefa-1.1.6/LICENSE

@@ -0,0 +1,21 @@
+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.

apyefa-1.1.6/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: apyefa
+Version: 1.1.6
+Summary: Python API for EFA(Elektronische Fahrplanauskunft) async requests
+Author-email: Alex Jung <jungdevelop@gmail.com>
+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.2
+Requires-Dist: voluptuous>=0.15.2
+Requires-Dist: tzdata>=2024.2
+Requires-Dist: black>=25.12.0
+Requires-Dist: twine>=6.2.0
+Dynamic: license-file
+
+# apyefa
+[![Python package](https://github.com/alex-jung/apyefa/actions/workflows/ci.yml/badge.svg)](https://github.com/alex-jung/apyefa/actions/workflows/ci.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|
+|[locations_by_coord()](https://github.com/alex-jung/apyefa/wiki/locations_by_coord)|Search for locations by 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())
+```

apyefa-1.1.6/README.md

@@ -0,0 +1,80 @@
+# apyefa
+[![Python package](https://github.com/alex-jung/apyefa/actions/workflows/ci.yml/badge.svg)](https://github.com/alex-jung/apyefa/actions/workflows/ci.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|
+|[locations_by_coord()](https://github.com/alex-jung/apyefa/wiki/locations_by_coord)|Search for locations by 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())
+```

apyefa-1.1.6/apyefa/__init__.py

@@ -0,0 +1,23 @@
+from apyefa.client import EfaClient
+from apyefa.data_classes import (
+    Departure,
+    Line,
+    LineRequestType,
+    Location,
+    LocationFilter,
+    LocationType,
+    SystemInfo,
+    TransportType,
+)
+
+__all__ = [
+    "LocationFilter",
+    "Location",
+    "LineRequestType",
+    "LocationType",
+    "Departure",
+    "SystemInfo",
+    "Line",
+    "TransportType",
+    "EfaClient",
+]