ltasg 0.0.1__tar.gz

ltasg-0.0.1/.gitignore

@@ -0,0 +1,162 @@
+# Vscode settings
+.vscode
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# 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
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# 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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.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/

ltasg-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ashe
+
+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.

ltasg-0.0.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.3
+Name: ltasg
+Version: 0.0.1
+Summary: A LTA Datamall API Wrapper Library for Python
+Project-URL: Homepage, https://github.com/ashe/ltasg
+Project-URL: Issues, https://github.com/ashe/ltasg/issues
+Author-email: Aw Sheng Xiang <awshengxiang@hotmail.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# ltasg

ltasg-0.0.1/README.md

@@ -0,0 +1 @@
+# ltasg

ltasg-0.0.1/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[project]
+name = "ltasg"
+version = "0.0.1"
+authors = [
+  { name="Aw Sheng Xiang", email="awshengxiang@hotmail.com" },
+]
+description = "A LTA Datamall API Wrapper Library for Python"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/ashe/ltasg"
+Issues = "https://github.com/ashe/ltasg/issues"

ltasg-0.0.1/requirements.txt

@@ -0,0 +1,10 @@
+aiohttp==3.9.5
+aiosignal==1.3.1
+attrs==23.2.0
+frozenlist==1.4.1
+idna==3.7
+multidict==6.0.5
+python-dotenv==1.0.1
+setuptools==69.5.1
+wheel==0.43.0
+yarl==1.9.4

ltasg-0.0.1/src/ltasg/__init__.py

@@ -0,0 +1,5 @@
+from transport.bus import *
+from transport.train import *
+from transport.taxi import *
+from traffic import *
+

ltasg-0.0.1/src/ltasg/api.py

@@ -0,0 +1,29 @@
+from aiohttp import ClientSession, ClientConnectionError
+import traceback
+class LTADataMall:
+    def __init__(self, api_key) -> None:
+        self.BASE_URL = "http://datamall2.mytransport.sg/ltaodataservice/"
+        self.API_KEY = api_key
+        self.HEADERS = {
+            "Accept": "application/json",
+            "AccountKey": self.API_KEY
+        }
+
+    async def fetch(self, service_endpoint: str, query_params: dict=None, data:dict=None):
+        url = f"{self.BASE_URL}{service_endpoint}"
+        if query_params:
+            url += "?"
+            for param, value in query_params.items():
+                url += f"{param}={value}"
+                if param != list(query_params.keys())[-1]:
+                    url += "&"
+        async with ClientSession() as session:
+            try:
+                async with session.get(url, headers=self.HEADERS) as response:
+                    if response.status == 200:
+                        return await response.json()
+                    else:
+                        raise Exception("Error calling api for {} with status code: {}".format(
+                            service_endpoint, response.status)) from None
+            except ClientConnectionError as e:
+                raise e

ltasg-0.0.1/src/ltasg/constants.py

@@ -0,0 +1,36 @@
+from enum import Enum
+
+
+class TransportType(Enum):
+    BUS = "bus"
+    TRAIN = "mrt"
+    TAXI = "taxi"
+
+
+LTA_SERVICES = {
+    "PUBLIC_TRANSPORT_SERVICES": {
+        TransportType.BUS: {
+            "ARRIVAL": "BusArrivalv2",
+            "SERVICES": "BusServices",
+            "ROUTES": "BusRoutes",
+            "STOPS": "BusStops",
+            # "PASSENGER_VOLUME": {
+            #     "BUS_STOPS": "PV/Bus",
+            #     "ORIGIN_TO_DEST": "PV/ODBus"
+            # }
+        },
+        TransportType.TRAIN: {
+            # "PASSENGER_VOLUME": {
+            #     "ORIGIN_TO_DEST": "PV/ODTrain",
+            # },
+            "PLATFORM_CROWD_DENSITY": {
+                "REALTIME": "PCDRealTime",
+                "FORECAST": "PCDForecast"
+            },
+            "SERVICE_ALERTS": "TrainServiceAlerts"
+        },
+        TransportType.TAXI: {
+            "AVAILABILITY": "Taxi-Availability",
+            "STANDS": "TaxiStands",
+        }
+}}

ltasg-0.0.1/src/ltasg/traffic.py

@@ -0,0 +1,2 @@
+from api import LTADataMall
+

ltasg-0.0.1/src/ltasg/transport/bus.py

@@ -0,0 +1,30 @@
+from api import LTADataMall
+from transport.transport import Transport
+from constants import TransportType
+
+class Bus(Transport):
+    def __init__(self, api_key):
+        super().__init__(api_key)
+        self.bus_services = self.transport_services[TransportType.BUS]
+
+    async def arrival(self, bus_stop_code: int, bus_no: int):
+        data = await self.lta_api.fetch(self.bus_services['ARRIVAL'], query_params={
+            "BusStopCode": bus_stop_code,
+            "ServiceNo": bus_no
+        })
+        return data["Services"]
+    
+    async def services(self):
+        data = await self.lta_api.fetch(self.bus_services['SERVICES'])
+        return data["value"]
+
+    async def routes(self):
+        data = await self.lta_api.fetch(self.bus_services['ROUTES'])
+        return data["value"]
+
+    async def stops(self):
+        data = await self.lta_api.fetch(self.bus_services['STOPS'])
+        return data["value"]
+
+    
+# BusArrivalv2?BusStopCode=71111&ServiceNo=137

ltasg-0.0.1/src/ltasg/transport/taxi.py

@@ -0,0 +1,16 @@
+from transport.transport import Transport
+from constants import TransportType
+
+
+class Taxi(Transport):
+    def __init__(self, api_key) -> None:
+        super().__init__(api_key)
+        self.taxi_services = self.transport_services[TransportType.TAXI]
+
+    async def availability(self):
+        data = await self.lta_api.fetch(self.taxi_services["AVAILABILITY"])
+        return data['value']
+    
+    async def stands(self):
+        data = await self.lta_api.fetch(self.taxi_services["STANDS"])
+        return data['value']

ltasg-0.0.1/src/ltasg/transport/train.py

@@ -0,0 +1,19 @@
+from transport.transport import Transport
+from constants import TransportType
+from typing import Literal
+
+class Train(Transport):
+    def __init__(self, api_key) -> None:
+        super().__init__(api_key)
+        self.train_services = self.transport_services[TransportType.TRAIN]
+
+    async def service_alerts(self):
+        data = await self.lta_api.fetch(self.train_services['SERVICE_ALERTS'])
+        return data['value']
+    
+    # API currently results in Error 404 not found
+    # async def platform_crowd_density(self, type: Literal["realtime", "forecast"] = "realtime"):
+    #     if type == "realtime":
+    #         return await self.lta_api.fetch(self.train_services["PLATFORM_CROWD_DENSITY"]['REALTIME'])
+    #     else:
+    #         return await self.lta_api.fetch(self.train_services["PLATFORM_CROWD_DENSITY"]["FORECAST"])

ltasg-0.0.1/src/ltasg/transport/transport.py

@@ -0,0 +1,9 @@
+from api import LTADataMall
+from constants import LTA_SERVICES
+
+
+class Transport:
+    def __init__(self, api_key) -> None:
+        self.lta_api = LTADataMall(api_key=api_key)
+        self.transport_services = LTA_SERVICES['PUBLIC_TRANSPORT_SERVICES']
+    

ltasg-0.0.1/test/test.py

@@ -0,0 +1,79 @@
+import unittest
+from transport.bus import Bus
+from transport.train import Train
+from transport.taxi import Taxi
+import dotenv
+import os
+
+class Test(unittest.IsolatedAsyncioTestCase):
+    dotenv.load_dotenv()
+    api_key = os.getenv("LTA_API_KEY")
+    bus = Bus(api_key=api_key)
+    train = Train(api_key=api_key)
+    taxi = Taxi(api_key=api_key)
+
+    async def test_bus(self):
+        print("Start test for bus \n")
+        # bus arrival
+        arrival_params = [
+            [71111, 63],
+            [71111, "63M"],
+            [71111, 137],
+            [71119, 63],
+            [71119, "63M"],
+            [71119, 137],
+        ]
+        for param in arrival_params:
+            arrival_data = await self.bus.arrival(param[0], param[1])
+            print(arrival_data)
+            self.assertEqual(str(
+                param[1]), arrival_data[0]['ServiceNo'], "Service No is not the same as param")
+        # bus services
+        services_data = await self.bus.services()
+        print(services_data)
+        self.assertNotEqual(len(services_data), 0, "Services data is empty")
+
+        # bus routes
+        routes_data = await self.bus.routes()
+        print(routes_data)
+        self.assertNotEqual(len(routes_data), 0, "Routes data is empty")
+
+        # bus stops
+        stops_data = await self.bus.stops()
+        print(stops_data)
+        self.assertNotEqual(len(stops_data), 0, "Stops data is empty")
+
+        print("\Bus test completed\n")
+
+    async def test_train(self):
+        print("Start test for train \n")
+
+        # service alerts
+        service_alerts_data = await self.train.service_alerts()
+        print(service_alerts_data)
+        self.assertIn(service_alerts_data['Status'], [
+                      1, 2], "Status returned is not valid")
+        # platform crowd density realtime
+
+        # platform crowd density forecast
+
+        print("\Train test completed\n")
+
+    async def test_taxi(self):
+        print("Start test for taxi \n")
+
+        # Availability
+        availability_data = await self.taxi.availability()
+        print(availability_data)
+        self.assertNotEqual(len(availability_data), 0,
+                            "Availability data is empty")
+        # stands
+        stands_data = await self.taxi.stands()
+        print(stands_data)
+        self.assertNotEqual(len(stands_data), 0, "Stands data is empty")
+
+        print("\Taxi test completed\n")
+
+
+if __name__ == "__main__":
+    unittest.main()