feat: implement comprehensive dynamic version management system

yammanhammad · yammanhammad · commit 139fceac3975 · 2025-06-05T20:41:49.000+05:00
- Centralized version control in route_planner/__init__.py
- Added scripts/get_version.py utility for consistent version fetching
- Updated all documentation to use [VERSION] placeholders instead of hardcoded versions
- Enhanced build scripts and GitHub Actions to dynamically extract version
- Improved installer.nsi with dynamic version parameter support
- Eliminated version maintenance overhead across all files
- Updated CHANGELOG.md and RELEASE_NOTES.md with v1.1.2 improvements
diff --git a/.github/workflows/build-windows-executable.yml b/.github/workflows/build-windows-executable.yml
@@ -372,9 +372,13 @@ jobs:
         
     - name: Create ZIP package
       run: |
-        # Get version from tag or use default
-        $version = "${{ github.ref_name }}" -replace '^v', ''
-        if (!$version -or $version -eq "master") { $version = "1.0.3" }
+        # Get version from Python package
+        $version = python -c "import sys; sys.path.insert(0, '.'); from route_planner import __version__; print(__version__)"
+        if (!$version) { 
+          # Fallback: try to get from git tag
+          $version = "${{ github.ref_name }}" -replace '^v', ''
+          if (!$version -or $version -eq "master") { $version = "1.1.2" }
+        }
         
         # Create ZIP file
         $zipName = "RoutePlanner-$version-Windows-Portable.zip"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 *All Windows executables and cross-platform packages are automatically built and published using GitHub Actions.*
 
+## [1.1.2] - 2025-06-05
+
+### Changed
+- **Dynamic Version Management**: Implemented dynamic version fetching across all documentation and build scripts
+- **Reduced Maintenance Overhead**: Removed hardcoded version numbers from installation instructions and documentation
+- **Centralized Version Control**: All version references now dynamically fetch from `route_planner/__init__.py`
+
+### Fixed
+- Eliminated version inconsistencies across documentation files
+- Improved maintainability by centralizing version management
+
 ## [1.1.1] - 2025-06-05
 
 ### Added
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # 🚚 Route Planner - Delivery Route Optimizer
 
-![Version](https://img.shields.io/badge/version-1.1.1-blue.svg)
+![Version](https://img.shields.io/github/v/release/yammanhammad/Route_Planner?style=flat&logo=github)
 ![License](https://img.shields.io/badge/license-MIT-green.svg)
 ![Python](https://img.shields.io/badge/python-3.8%2B-blue.svg)
 ![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)
@@ -49,7 +49,7 @@ Choose the installation method that works best for you. **For non-technical user
 
 **Linux/macOS:**
 1. **Download** the cross-platform Python package from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
-   - `route_planner-1.1.1-py3-none-any.whl` (Recommended)
+   - `route_planner-[VERSION]-py3-none-any.whl` (Recommended)
    - `install.py` (Automatic installer script)
 2. **Easy Installation** (Recommended):
    ```bash
@@ -61,7 +61,7 @@ Choose the installation method that works best for you. **For non-technical user
    ```bash
    python3 -m venv route-planner-env
    source route-planner-env/bin/activate
-   pip install route_planner-1.1.1-py3-none-any.whl
+   pip install route_planner-[VERSION]-py3-none-any.whl
    ```
 4. **Run**: 
    - Find "Route Planner" in your application menu
diff --git a/docs/README.md b/docs/README.md
@@ -28,13 +28,13 @@ This directory contains comprehensive documentation for the Route Planner applic
    - Extract/install and run `RoutePlanner.exe`
    
    **Linux/macOS:**
-   - Download `route_planner-1.1.1-py3-none-any.whl` from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
+   - Download `route_planner-[VERSION]-py3-none-any.whl` from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
    - Create a virtual environment (recommended):
      ```bash
      python3 -m venv route-planner-env
      source route-planner-env/bin/activate
      ```
-   - Install: `pip install route_planner-1.1.1-py3-none-any.whl`
+   - Install: `pip install route_planner-[VERSION]-py3-none-any.whl`
    - Run: `route-planner`
    
    *✨ All executables and packages are automatically built using GitHub Actions CI/CD - no compilation needed!*
diff --git a/docs/RELEASE_NOTES.md b/docs/RELEASE_NOTES.md
@@ -4,11 +4,26 @@ This document contains all release notes for Route Planner, with the most recent
 
 **🚀 Quick Installation:** Download the latest version from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest):
 - **Windows**: Choose `RoutePlanner-Bundled.zip` for the easiest installation experience
-- **Linux/macOS**: Choose `route_planner-1.1.1-py3-none-any.whl` for easy pip installation
+- **Linux/macOS**: Choose the latest `.whl` package for easy pip installation
 
 *All Windows executables and cross-platform packages are automatically built and published using GitHub Actions.*
 
-## Route Planner v1.1.1 (Latest)
+## Route Planner v1.1.2 (Latest)
+
+**Release Date:** June 2025
+
+### 🔧 Version Management Modernization
+- **Dynamic Version Control**: Implemented centralized version management system
+- **Reduced Maintenance Overhead**: Eliminated hardcoded version numbers from documentation
+- **Automated Version Fetching**: All build scripts and documentation now dynamically fetch version from package
+- **Consistency Improvements**: Centralized version control prevents version mismatches
+
+### 📦 Technical Improvements
+- **Build System Enhancement**: Version numbers automatically extracted from `route_planner/__init__.py`
+- **Documentation Cleanup**: Removed version-specific package names from installation instructions
+- **Future-Proof Design**: Version updates now require changes in only one location
+
+## Route Planner v1.1.1
 
 **Release Date:** June 2025
 
@@ -19,7 +34,7 @@ This document contains all release notes for Route Planner, with the most recent
 
 ### 📦 Installation Options
 - **Windows**: Download executable packages (`RoutePlanner-Bundled.zip` or `RoutePlanner-Setup.exe`)
-- **Linux/macOS**: Download Python wheel (`route_planner-1.1.1-py3-none-any.whl`) and install with pip
+- **Linux/macOS**: Download the latest Python wheel package and install with pip
 - **All Platforms**: Standard PyPI installation (`pip install route-planner`) also available
 
 ## Route Planner v1.1.0
diff --git a/route_planner/__init__.py b/route_planner/__init__.py
@@ -6,7 +6,7 @@
 and comprehensive offline support.
 """
 
-__version__ = "1.1.1"
+__version__ = "1.1.2"
 __author__ = "Route Planner Development Team"
 
 # Ensure config is available at package level
diff --git a/route_planner/app.py b/route_planner/app.py
@@ -56,7 +56,7 @@
 
 Author: Route Planner Development Team
 License: MIT
-Version: 1.0.3
+Version: Dynamic (from package __version__)
 """
 
 # =============================================================================
@@ -96,6 +96,12 @@
 import urllib.error       # URL error handling
 import socket             # Low-level networking interface
 
+# Version information
+try:
+    from route_planner import __version__
+except ImportError:
+    __version__ = "unknown"
+
 # =============================================================================
 # CONFIGURATION AND CONSTANTS
 # =============================================================================
@@ -3564,10 +3570,10 @@ def _show_about_dialog(self):
         QtWidgets.QMessageBox.about(
             self,
             "About Route Planner",
-            """
+            f"""
             <div style="font-family: Arial, sans-serif; max-width: 500px;">
                 <h2 style="color: #4a86e8; margin-bottom: 10px;">Delivery Route Planner</h2>
-                <p style="font-size: 14px; color: #666;"><b>Version 1.0.3</b> (June 2025)</p>
+                <p style="font-size: 14px; color: #666;"><b>Version {__version__}</b> (June 2025)</p>
                 
                 <p style="margin-top: 15px; line-height: 1.4;">
                     A sophisticated application for optimizing delivery routes through advanced
@@ -4254,7 +4260,7 @@ def main():
     
     # Set application properties
     app.setApplicationName("Delivery Route Planner")
-    app.setApplicationVersion("1.0.3")
+    app.setApplicationVersion(__version__)
     app.setOrganizationName("Route Optimization Solutions")
     
     # Create and show main window
diff --git a/scripts/README.md b/scripts/README.md
@@ -44,7 +44,7 @@ These scripts serve three main functions:
 **Method 1: Pre-built Executables & Packages (Easiest)**
 - Download from [GitHub Releases](https://github.com/yammanhammad/Route_Planner/releases/latest)
 - **Windows**: Run `RoutePlanner.exe` 
-- **Linux/macOS**: Install `route_planner-1.1.1-py3-none-any.whl` with pip and run `route-planner`
+- **Linux/macOS**: Install the latest `.whl` package with pip and run `route-planner`
 - *No technical setup required!*
 
 **Method 2: Python Package**
diff --git a/scripts/get_version.py b/scripts/get_version.py
@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+"""
+Utility script to get the current version from the package.
+This ensures version consistency across all files and documentation.
+"""
+
+import sys
+from pathlib import Path
+
+def get_version():
+    """Get the current version from route_planner/__init__.py"""
+    # Add parent directory to path to import route_planner
+    script_dir = Path(__file__).parent
+    project_dir = script_dir.parent
+    sys.path.insert(0, str(project_dir))
+    
+    try:
+        from route_planner import __version__
+        return __version__
+    except ImportError:
+        # Fallback: read directly from file
+        init_file = project_dir / "route_planner" / "__init__.py"
+        if init_file.exists():
+            import re
+            with open(init_file, 'r', encoding='utf-8') as f:
+                content = f.read()
+            match = re.search(r'^__version__ = [\'"]([^\'"]*)[\'"]', content, re.MULTILINE)
+            if match:
+                return match.group(1)
+    
+    raise RuntimeError("Unable to determine version")
+
+if __name__ == "__main__":
+    print(get_version())
diff --git a/scripts/installer.nsi b/scripts/installer.nsi
@@ -2,7 +2,10 @@
 ;Creates a professional Windows installer with Visual C++ Redistributable
 
 !define APP_NAME "Route Planner"
-!define APP_VERSION "1.1.1"
+; APP_VERSION will be passed as a command line parameter via /DAPP_VERSION=x.x.x
+!ifndef APP_VERSION
+  !define APP_VERSION "1.1.2"  ; Fallback version
+!endif
 !define APP_PUBLISHER "Route Planner Team"
 !define APP_URL "https://github.com/yammanhammad/Route_Planner"
 !define APP_EXECUTABLE "RoutePlanner.exe"
@@ -53,7 +56,7 @@ RequestExecutionLevel admin
 !insertmacro MUI_LANGUAGE "English"
 
 ;Version Information
-VIProductVersion "1.1.0.0"
+VIProductVersion "${APP_VERSION}.0"
 VIAddVersionKey /LANG=${LANG_ENGLISH} "ProductName" "${APP_NAME}"
 VIAddVersionKey /LANG=${LANG_ENGLISH} "CompanyName" "${APP_PUBLISHER}"
 VIAddVersionKey /LANG=${LANG_ENGLISH} "LegalCopyright" "© 2025 ${APP_PUBLISHER}"
diff --git a/scripts/prepare_release.py b/scripts/prepare_release.py
diff --git a/setup.py b/setup.py
