apyefa 0.0.6__tar.gz → 1.0.0__tar.gz

{apyefa-0.0.6 → apyefa-1.0.0}/.gitignore

@@ -1,11 +1,11 @@
+# developing script
+script.py
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
 # Distribution / packaging
 .Python
 build/
@@ -114,12 +114,6 @@ ipython_config.py
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
 
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
 
 # Environments
 .env
@@ -130,9 +124,6 @@ ENV/
 env.bak/
 venv.bak/
 
-# Spyder project settings
-.spyderproject
-.spyproject
 
 # Rope project settings
 .ropeproject
@@ -145,18 +136,3 @@ venv.bak/
 .dmypy.json
 dmypy.json
 
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  and can be added to the global gitignore or merged into this file.  For a more nuclear
-#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/

apyefa-1.0.0/PKG-INFO

@@ -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())
+```

apyefa-1.0.0/README.md

@@ -0,0 +1,80 @@
+# 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())
+```