Merge pull request #30 from OneBusAway/examples

Examples

Author: Ahmedhossamdev

README.md

@@ -1,8 +1,8 @@
-# Onebusaway SDK Python API library
+# OneBusAway SDK Python API library
 
 [![PyPI version](https://img.shields.io/pypi/v/onebusaway.svg)](https://pypi.org/project/onebusaway/)
 
-The Onebusaway SDK Python library provides convenient access to the Onebusaway SDK REST API from any Python 3.7+
+The OneBusAway SDK Python library provides convenient access to the OneBusAway SDK REST API from any Python 3.7+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 

examples/.env.example

@@ -0,0 +1,2 @@
+api_key="TEST"
+base_url="https://api.pugetsound.onebusaway.org/"

examples/README.md

@@ -0,0 +1,42 @@
+# Examples README
+
+## Setting up the environment
+
+### With Rye
+
+We use [Rye](https://rye.astral.sh/) to manage dependencies so we highly recommend [installing it](https://rye.astral.sh/guide/installation/) as it will automatically provision a Python environment with the expected Python version.
+
+After installing Rye, you'll just have to run this command:
+
+```sh
+$ rye sync --all-features
+```
+
+You can then run scripts using `rye run python script.py` or by activating the virtual environment:
+
+```sh
+$ rye shell
+# or manually activate - https://docs.python.org/3/library/venv.html#how-venvs-work
+$ source .venv/bin/activate
+
+# now you can omit the `rye run` prefix
+$ python script.py
+```
+
+### Without Rye
+
+Alternatively if you don't want to install `Rye`, you can stick with the standard `pip` setup by ensuring you have the Python version specified in `.python-version`, create a virtual environment however you desire and then install dependencies using this command:
+
+```sh
+$ pip install -r requirements-dev.lock
+```
+
+## Run the examples
+
+```bash
+python EXAMPLE_NAME.py
+```
+
+## `.env` file: API keys and server URLs
+
+Copy the file `.env.example` to `.env` and edit it with your preferred API key and server URL.

examples/agencies_with_coverage.py

@@ -0,0 +1,21 @@
+from pprint import pprint
+
+from helpers.load_env import load_settings
+
+from onebusaway import OnebusawaySDK
+
+# Load settings from .env file, if it exists. If not, we'll use the
+# Puget Sound server URL (which is also the default in the SDK) and
+# the 'TEST' API key.
+settings = load_settings(
+    {
+        "api_key": "TEST",
+        "base_url": "https://api.pugetsound.onebusaway.org/",
+    }
+)
+
+# Create a new instance of the OneBusAway SDK with the settings we loaded.
+oba = OnebusawaySDK(**settings)
+
+response = oba.agencies_with_coverage.retrieve()
+pprint(response.data)

examples/agency.py

@@ -0,0 +1,38 @@
+from helpers.load_env import load_settings
+
+from onebusaway import OnebusawaySDK
+
+# Load settings from .env file, if it exists. If not, we'll use the
+# Puget Sound server URL (which is also the default in the SDK) and
+# the 'TEST' API key.
+settings = load_settings(
+    {
+        "api_key": "TEST",
+        "base_url": "https://api.pugetsound.onebusaway.org/",
+    }
+)
+
+# Create a new instance of the OneBusAway SDK with the settings we loaded.
+oba = OnebusawaySDK(**settings)
+
+# Define the query parameters
+query = {
+    "tripId": "1_604670535",  # Replace with actual trip ID
+    "serviceDate": "1810918000000",  # Replace with actual service date in milliseconds since epoch
+}
+
+stopId = "1_75403"  # Replace with actual stop ID
+
+# Retrieve arrival and departure information
+response = oba.arrival_and_departure.list(stopId, extra_query=query)
+
+# Example to access specific data
+arrivals_and_departures = response.data.entry.arrivals_and_departures
+
+for arr_dep in arrivals_and_departures:
+    print(f"Route: {arr_dep.route_short_name}")
+    print(f"Trip Headsign: {arr_dep.trip_headsign}")
+    print(f"Predicted Arrival Time: {arr_dep.predicted_arrival_time}")
+    print(f"Scheduled Arrival Time: {arr_dep.scheduled_arrival_time}")
+    print(f"Vehicle ID: {arr_dep.vehicle_id}")
+    print("")

examples/arrivals_and_departures_for_stop.py

@@ -0,0 +1,21 @@
+from pprint import pprint
+
+from helpers.load_env import load_settings
+
+from onebusaway import OnebusawaySDK
+
+# Load settings from .env file, if it exists. If not, we'll use the
+# Puget Sound server URL (which is also the default in the SDK) and
+# the 'TEST' API key.
+settings = load_settings(
+    {
+        "api_key": "TEST",
+        "base_url": "https://api.pugetsound.onebusaway.org/",
+    }
+)
+
+# Create a new instance of the OneBusAway SDK with the settings we loaded.
+oba = OnebusawaySDK(**settings)
+
+response = oba.config.retrieve()
+pprint(response)

examples/config.py

@@ -0,0 +1,21 @@
+from pprint import pprint
+
+from helpers.load_env import load_settings
+
+from onebusaway import OnebusawaySDK
+
+# Load settings from .env file, if it exists. If not, we'll use the
+# Puget Sound server URL (which is also the default in the SDK) and
+# the 'TEST' API key.
+settings = load_settings(
+    {
+        "api_key": "TEST",
+        "base_url": "https://api.pugetsound.onebusaway.org/",
+    }
+)
+
+# Create a new instance of the OneBusAway SDK with the settings we loaded.
+oba = OnebusawaySDK(**settings)
+
+response = oba.current_time.retrieve()
+pprint(response)

examples/current_time.py

@@ -0,0 +1,74 @@
+from typing import Any, Dict, Optional
+from pathlib import Path
+
+
+def load_settings(default_settings: Dict[str, Any]) -> Dict[str, Any]:
+    """
+    Load settings by merging default settings with environment variables.
+
+    Args:
+        default_settings (Dict[str, Any]): The default settings to use.
+
+    Returns:
+        Dict[str, Any]: The merged settings.
+    """
+    env_variables = load_env()
+    if env_variables:
+        return {**default_settings, **env_variables}
+    else:
+        return default_settings
+
+
+def load_env() -> Optional[Dict[str, Any]]:
+    """
+    Loads environment variables from a .env file located in the parent directory of the current file.
+
+    Returns:
+        A dictionary containing the loaded environment variables, or None if the .env file does not exist.
+    """
+    dirname = Path(__file__).resolve().parent
+    env_path = dirname.parent / ".env"
+
+    if env_path.exists():
+        return load_env_from_path(str(env_path))
+    else:
+        return None
+
+
+def load_env_from_path(file_path: str) -> Dict[str, str]:
+    """
+    Load environment variables from a file.
+
+    Args:
+        file_path (str): The path to the file containing environment variables.
+
+    Returns:
+        dict: A dictionary containing the loaded environment variables, where the keys are the variable names
+        and the values are the variable values.
+
+    """
+    env = {}
+    with open(file_path, "r", encoding="utf8") as file:
+        lines = file.readlines()
+
+    for line in lines:
+        # Remove comments and trim whitespace
+        trimmed_line = line.split("#")[0].strip()
+
+        if not trimmed_line:
+            continue
+
+        key_value = trimmed_line.split("=", 1)
+        if len(key_value) != 2:
+            continue
+
+        key, value = key_value
+        value = value.strip()
+
+        # Remove surrounding quotes if they exist
+        if (value.startswith('"') and value.endswith('"')) or (value.startswith("'") and value.endswith("'")):
+            value = value[1:-1]
+
+        env[key.strip()] = value
+
+    return env  # type: ignore

examples/helpers/load_env.py

@@ -1,15 +1,24 @@
-import onebusaway
+from pprint import pprint
 
+from helpers.load_env import load_settings
 
-def main_sync() -> None:
-    client = onebusaway.OnebusawaySDK(api_key="TEST")
-    stop = client.stop.retrieve("1_75403")
+from onebusaway import OnebusawaySDK
 
-    if stop.data and stop.data.entry:
-        print(stop.data.entry)
-    else:
-        print("stop not found")
+# Load settings from .env file, if it exists. If not, we'll use the
+# Puget Sound server URL (which is also the default in the SDK) and
+# the 'TEST' API key.
+settings = load_settings(
+    {
+        "api_key": "TEST",
+        "base_url": "https://api.pugetsound.onebusaway.org/",
+    }
+)
 
+# Create a new instance of the OneBusAway SDK with the settings we loaded.
+oba = OnebusawaySDK(**settings)
 
-if __name__ == "__main__":
-    main_sync()
+stop_id = "1_75403"
+stop = oba.stop.retrieve(stop_id)
+
+if stop.data and stop.data.entry:
+    pprint(stop.data.entry)