v2

Author: PawanKrGunjan

Heuristics/Makefile

@@ -1,24 +1,37 @@
-.PHONY: install test format lint refactor all clean help
+.PHONY: install test format format-check lint refactor all clean help
 
+# Install all dependencies
 install:
 	@pip install --upgrade pip
 	@pip install -r requirements.txt
 
+# Run tests with coverage
 test:
 	@pytest -vv --cov=TSP --cov-report=term-missing --cov-report=html tests/
 
+# Autoformat code
 format:
 	@black TSP/ tests/
 
+# Check code formatting (non-destructive)
+format-check:
+	@black --check TSP/ tests/
+
+# Lint Python code
 lint:
 	@pylint --disable=R,C --ignore-patterns='test_.*\.py' TSP tests
 
+# Format + lint
 refactor: format lint
 
-all: install lint test
+# Full pipeline: install, format, check, lint, test, clean
+all: install format format-check lint test clean
 
+# Remove caches and coverage reports
 clean:
 	@rm -rf __pycache__ *.pyc *.pyo .pytest_cache htmlcov coverage.xml .coverage
 
+# Show help for each target
 help:
-	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | \
+	awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

Heuristics/TSP/__init__.py

@@ -23,7 +23,6 @@
     my_cities,
     create_cities_dataframe,
     main,
-
 )
 
 # CLI entry
@@ -39,5 +38,5 @@
     "my_cities",
     "create_cities_dataframe",
     "cli",
-    "main"
+    "main",
 ]

Heuristics/TSP/cli.py

@@ -4,6 +4,7 @@
 
 import click
 import warnings
+
 warnings.filterwarnings("ignore", category=RuntimeWarning)
 from .tsp_pandas import create_cities, tsp_pandas
 from .visualization import plot_path
@@ -13,6 +14,7 @@
 def cli():
     """TSP command-line tool."""
 
+
 @cli.command()
 @click.option("--count", default=1, type=int, help="Number of simulations to run")
 @click.option("--plot", is_flag=True, help="Plot the best route")
@@ -34,7 +36,6 @@ def simulate(count, plot):
         plot_path(best_route_order)
 
 
-
 @cli.command()
 @click.option(
     "--city",

Heuristics/TSP/tsp_pandas.py

@@ -48,6 +48,8 @@ def create_cities():
 
 def euclidean_distance(lat1, lon1, lat2, lon2):
     return np.sqrt((lat1 - lat2) ** 2 + (lon1 - lon2) ** 2)
+
+
 #
 #
 # def tsp_pandas(df: pd.DataFrame):
@@ -83,6 +85,7 @@ def euclidean_distance(lat1, lon1, lat2, lon2):
 #     # ✅ Return distance first, then route list
 #     return float(total_distance), route_list
 
+
 def tsp_pandas(df: pd.DataFrame):
     df = df.copy()
     random.seed(42)  # deterministic for testing

Heuristics/TSP/visualization.py

@@ -1,9 +1,24 @@
+import os
+import matplotlib
 import matplotlib.pyplot as plt
 from .tsp_pandas import create_cities
 
-def plot_path(route):
+# Use non-interactive backend in CI / headless environments
+if os.environ.get("CI"):
+    matplotlib.use("Agg")
+
+
+def plot_path(route, save_path="tsp_route.png"):
     """
-    route: list of city names in order
+    Plots the TSP route.
+
+    Parameters:
+    - route: list of city names in order
+    - save_path: file path to save the plot (default: tsp_route.png)
+
+    Behavior:
+    - In CI (headless), the plot is saved automatically.
+    - Locally, the plot window is displayed for interactive viewing.
     """
     df = create_cities()
     df = df.set_index("city").loc[route]  # order cities
@@ -12,10 +27,20 @@ def plot_path(route):
     plt.plot(df["longitude"], df["latitude"], marker="o", linestyle="-", color="blue")
 
     for i, city in enumerate(df.index):
-        plt.text(df.loc[city, "longitude"], df.loc[city, "latitude"], f"{i+1}. {city}")
+        plt.text(
+            df.loc[city, "longitude"], df.loc[city, "latitude"], f"{i + 1}. {city}"
+        )
 
     plt.xlabel("Longitude")
     plt.ylabel("Latitude")
     plt.title("TSP Route")
     plt.grid(True)
-    plt.show()
+
+    # Save the plot to file
+    plt.savefig(save_path)
+
+    # Only show the plot locally (not in CI)
+    if not os.environ.get("CI"):
+        plt.show()
+
+    plt.close()

Heuristics/tests/test_cli.py

@@ -3,10 +3,9 @@
 from click.testing import CliRunner
 from TSP import cli
 
+
 def test_simulate_command():
     runner = CliRunner()
     # Only use existing --plot option
     result = runner.invoke(cli, ["simulate", "--plot"])
     assert result.exit_code == 0
-
-

Heuristics/tests/test_coin.py

@@ -1,4 +1,5 @@
 from TSP import greedy_coin_change
 
+
 def test_coin_change():
     assert greedy_coin_change(0.41) == 4

Heuristics/tests/test_tsp_dict.py

@@ -34,9 +34,6 @@ def cities():
     }
 
 
-
-
-
 def test_tsp_dict():
     cities = {
         "A": {"A": 0, "B": 1, "C": 2},

Heuristics/tests/test_tsp_pandas.py

@@ -16,6 +16,3 @@ def test_tsp_pandas(cities):
     assert distance > 0
     assert isinstance(route, list)
     assert len(route) == len(cities)
-
-
-