Merge pull request #42 from naylin-dev/main

add geographic distance and estimated travel time calculator

Author: king04aman

Geographic Distance/README.md

@@ -0,0 +1,83 @@
+# Geographic Distance and Travel Time Calculator
+
+This Python script calculates the geodesic distance between two geographic coordinates and estimates travel time based on a given average speed. It uses the geopy library to compute distances.
+
+## Features
+
+-   Input coordinates for two locations (latitude and longitude) interactively.
+-   Calculate the distance between the two coordinates in kilometers.
+-   Estimate the travel time based on a given average speed (in km/h).
+
+## Prerequisites
+
+-   Python 3.x installed on your system.
+
+## Setup
+
+1. Clone the repository
+
+    ```bash
+    git clone https://github.com/king04aman/All-In-One-Python-Projects.git
+    cd All-In-One-Python-Projects/Geographic Distance
+    ```
+
+2. Create and activate a virtual environment
+
+-   For macOS/Linux:
+
+    ```bash
+    python3 -m venv venv
+    source venv/bin/activate
+    ```
+
+-   For Windows:
+
+    ```bash
+    python -m venv venv
+    venv\Scripts\activate
+    ```
+
+3. Install the required dependencies
+
+    The required packages are listed in requirements.txt. Install them using the following command:
+
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+    Note: The main dependency is geopy for calculating distances based on geodesic coordinates.
+
+## Usage
+
+1. Run the script:
+
+    ```bash
+    python geographic_distance.py
+    ```
+
+2. Enter the coordinates (latitude and longitude) of the two locations when prompted.
+3. Enter the average speed in km/h to calculate the travel time.
+
+    Example input:
+
+    ```
+    Enter the latitude and longitude of the first location (lat1, lon1) Example: 40.7128, -74.006: 52.5200, 13.4050
+    Enter the latitude and longitude of the second location (lat2, lon2) Example: 37.7749, -122.4194: 48.8566, 2.3522
+    Enter the average speed in km/h Example: 60: 80
+    ```
+
+    Example output:
+
+    ```
+    Distance between the two coordinates: 878.84 kilometers
+    Estimated travel time: 10.99 hours
+    ```
+
+## Requirements
+
+Here’s a list of Python dependencies in requirements.txt:
+
+```
+geopy==2.2.0
+pytest==8.3.3
+```

Geographic Distance/geographic_distance.py

@@ -0,0 +1,49 @@
+from geopy.distance import geodesic
+
+
+def calculate_distance_and_time(coord1, coord2, avg_speed):
+    """
+    Calculate the distance between two coordinates and estimate travel time.
+    :param coord1: Tuple containing the latitude and longitude of the first location (lat1, lon1)
+    :param coord2: Tuple containing the latitude and longitude of the second location (lat2, lon2)
+    :param avg_speed: Average speed in km/h for estimating travel time
+    :return: Distance in kilometers and estimated travel time in hours
+    """
+
+    # Calculate geodesic distance
+    distance = geodesic(coord1, coord2).kilometers
+    # Estimate travel time (distance / speed)
+    travel_time = distance / avg_speed
+
+    return distance, travel_time
+
+
+def main():
+    # Coordinates (latitude, longitude)
+    try:
+        coord1 = tuple(map(float, input('Enter the latitude and longitude of the first location (lat1, lon1) Example: 40.7128, -74.006: ').split(',')))
+        coord2 = tuple(map(float, input('Enter the latitude and longitude of the second location (lat2, lon2) Example: 37.7749, -122.4194: ').split(',')))
+    except ValueError as e:
+        raise ValueError("Coordinates must be in the format 'lat, lon'") from e
+
+    if not all(-90 <= x <= 90 for x in (coord1[0], coord2[0])) or not all(-180 <= x <= 180 for x in (coord1[1], coord2[1])):
+        raise ValueError('Invalid coordinates')
+
+    # Speed in km/h (e.g., driving speed)
+    try:
+        avg_speed = float(input('Enter the average speed in km/h Example: 60: '))
+    except ValueError as e:
+        raise ValueError('Average speed must be a number') from e
+
+    if avg_speed <= 0:
+        raise ValueError('Average speed must be greater than 0.')
+
+    # Calculate the distance and travel time
+    distance, travel_time = calculate_distance_and_time(coord1, coord2, avg_speed)
+
+    print(f'Distance between the two coordinates: {distance:.2f} kilometers')
+    print(f'Estimated travel time: {travel_time:.2f} hours')
+
+
+if __name__ == '__main__':
+    main()

Geographic Distance/requirements.txt

@@ -0,0 +1,2 @@
+geopy==2.4.1
+pytest==8.3.3

Geographic Distance/runtime.txt

@@ -0,0 +1 @@
+python-3.12.7

Geographic Distance/test_geographic_distance.py

@@ -0,0 +1,72 @@
+from unittest.mock import patch
+
+import pytest
+from geographic_distance import calculate_distance_and_time, main
+
+
+def test_calculate_distance_and_time():
+    # Test with valid coordinates and speed
+    coord1 = (40.7128, -74.006)
+    coord2 = (37.7749, -122.4194)
+    avg_speed = 60
+    distance, travel_time = calculate_distance_and_time(coord1, coord2, avg_speed)
+    assert distance > 0
+    assert travel_time > 0
+
+
+def test_calculate_distance_and_time_invalid_speed():
+    # Test with invalid speed (zero)
+    coord1 = (40.7128, -74.006)
+    coord2 = (37.7749, -122.4194)
+    avg_speed = 0
+    with pytest.raises(ValueError):
+        calculate_distance_and_time(coord1, coord2, avg_speed)
+
+
+def test_calculate_distance_and_time_same_coordinates():
+    # Test with same coordinates
+    coord1 = (40.7128, -74.006)
+    coord2 = (40.7128, -74.006)
+    avg_speed = 60
+    distance, travel_time = calculate_distance_and_time(coord1, coord2, avg_speed)
+    assert distance == 0
+    assert travel_time == 0
+
+
+@pytest.fixture
+def mock_input():
+    with patch('builtins.input', side_effect=['40.7128, -74.006', '37.7749, -122.4194', '60']):
+        yield
+
+
+def test_main(mock_input, capsys):
+    main()
+    captured = capsys.readouterr()
+    assert 'Distance between the two coordinates:' in captured.out
+    assert 'Estimated travel time:' in captured.out
+
+
+def test_main_invalid_coordinates(mock_input, capsys):
+    with patch('builtins.input', side_effect=['abc, def', '37.7749, -122.4194', '60']):
+        with pytest.raises(ValueError):
+            main()
+
+
+def test_main_invalid_speed(mock_input, capsys):
+    with patch('builtins.input', side_effect=['40.7128, -74.006', '37.7749, -122.4194', 'abc']):
+        with pytest.raises(ValueError):
+            main()
+
+
+def test_main_zero_speed(mock_input, capsys):
+    with patch('builtins.input', side_effect=['40.7128, -74.006', '37.7749, -122.4194', '0']):
+        with pytest.raises(ValueError):
+            main()
+
+
+def test_main_same_coordinates(mock_input, capsys):
+    with patch('builtins.input', side_effect=['40.7128, -74.006', '40.7128, -74.006', '60']):
+        main()
+        captured = capsys.readouterr()
+        assert 'Distance between the two coordinates: 0.00 kilometers' in captured.out
+        assert 'Estimated travel time: 0.00 hours' in captured.out