|
| 1 | +#!/usr/bin/env python3 |
| 2 | +""" |
| 3 | +Cross-platform installation script for Vantor QGIS Plugin. |
| 4 | +
|
| 5 | +Usage: |
| 6 | + python install.py # Install the plugin |
| 7 | + python install.py --remove # Remove the plugin |
| 8 | +""" |
| 9 | + |
| 10 | +import os |
| 11 | +import sys |
| 12 | +import shutil |
| 13 | +import argparse |
| 14 | +from pathlib import Path |
| 15 | + |
| 16 | + |
| 17 | +def get_qgis_plugin_dir() -> Path: |
| 18 | + """Get the QGIS plugin directory based on the current platform. |
| 19 | +
|
| 20 | + Returns: |
| 21 | + Path to the QGIS plugins directory. |
| 22 | + """ |
| 23 | + home = Path.home() |
| 24 | + |
| 25 | + if sys.platform == "linux" or sys.platform == "linux2": |
| 26 | + plugin_dir = home / ".local/share/QGIS/QGIS3/profiles/default/python/plugins" |
| 27 | + elif sys.platform == "darwin": |
| 28 | + plugin_dir = ( |
| 29 | + home |
| 30 | + / "Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins" |
| 31 | + ) |
| 32 | + elif sys.platform == "win32": |
| 33 | + appdata = os.environ.get("APPDATA", "") |
| 34 | + if appdata: |
| 35 | + plugin_dir = Path(appdata) / "QGIS/QGIS3/profiles/default/python/plugins" |
| 36 | + else: |
| 37 | + plugin_dir = ( |
| 38 | + home / "AppData/Roaming/QGIS/QGIS3/profiles/default/python/plugins" |
| 39 | + ) |
| 40 | + else: |
| 41 | + raise RuntimeError(f"Unsupported platform: {sys.platform}") |
| 42 | + |
| 43 | + return plugin_dir |
| 44 | + |
| 45 | + |
| 46 | +def install_plugin( |
| 47 | + source_dir: Path, plugin_dir: Path, plugin_name: str = "vantor" |
| 48 | +) -> bool: |
| 49 | + """Install the plugin to the QGIS plugins directory. |
| 50 | +
|
| 51 | + Args: |
| 52 | + source_dir: Path to the plugin source directory. |
| 53 | + plugin_dir: Path to the QGIS plugins directory. |
| 54 | + plugin_name: Name of the plugin folder in QGIS plugins directory. |
| 55 | +
|
| 56 | + Returns: |
| 57 | + True if installation was successful, False otherwise. |
| 58 | + """ |
| 59 | + target_dir = plugin_dir / plugin_name |
| 60 | + |
| 61 | + # Create plugin directory if it doesn't exist |
| 62 | + plugin_dir.mkdir(parents=True, exist_ok=True) |
| 63 | + |
| 64 | + # Remove existing installation |
| 65 | + if target_dir.exists(): |
| 66 | + print(f"Removing existing installation: {target_dir}") |
| 67 | + shutil.rmtree(target_dir) |
| 68 | + |
| 69 | + # Copy plugin |
| 70 | + print(f"Installing plugin to: {target_dir}") |
| 71 | + shutil.copytree(source_dir, target_dir) |
| 72 | + |
| 73 | + return True |
| 74 | + |
| 75 | + |
| 76 | +def remove_plugin(plugin_dir: Path, plugin_name: str = "vantor") -> bool: |
| 77 | + """Remove the plugin from the QGIS plugins directory. |
| 78 | +
|
| 79 | + Args: |
| 80 | + plugin_dir: Path to the QGIS plugins directory. |
| 81 | + plugin_name: Name of the plugin folder in QGIS plugins directory. |
| 82 | +
|
| 83 | + Returns: |
| 84 | + True if removal was successful, False otherwise. |
| 85 | + """ |
| 86 | + target_dir = plugin_dir / plugin_name |
| 87 | + |
| 88 | + if target_dir.exists(): |
| 89 | + print(f"Removing plugin: {target_dir}") |
| 90 | + shutil.rmtree(target_dir) |
| 91 | + print("Plugin removed successfully.") |
| 92 | + return True |
| 93 | + else: |
| 94 | + print("Plugin not found. Nothing to remove.") |
| 95 | + return False |
| 96 | + |
| 97 | + |
| 98 | +def main(): |
| 99 | + parser = argparse.ArgumentParser(description="Install or remove Vantor QGIS Plugin") |
| 100 | + parser.add_argument( |
| 101 | + "--remove", |
| 102 | + action="store_true", |
| 103 | + help="Remove the plugin instead of installing", |
| 104 | + ) |
| 105 | + parser.add_argument( |
| 106 | + "--plugin-dir", |
| 107 | + type=str, |
| 108 | + default=None, |
| 109 | + help="Custom QGIS plugin directory (optional)", |
| 110 | + ) |
| 111 | + parser.add_argument( |
| 112 | + "--name", |
| 113 | + type=str, |
| 114 | + default="vantor", |
| 115 | + help="Plugin folder name in QGIS plugins directory (default: vantor)", |
| 116 | + ) |
| 117 | + args = parser.parse_args() |
| 118 | + |
| 119 | + # Get script directory |
| 120 | + script_dir = Path(__file__).parent.resolve() |
| 121 | + source_dir = script_dir / "vantor" |
| 122 | + |
| 123 | + if not source_dir.exists(): |
| 124 | + print(f"Error: Plugin source directory not found: {source_dir}") |
| 125 | + sys.exit(1) |
| 126 | + |
| 127 | + # Get plugin directory |
| 128 | + if args.plugin_dir: |
| 129 | + plugin_dir = Path(args.plugin_dir) |
| 130 | + else: |
| 131 | + try: |
| 132 | + plugin_dir = get_qgis_plugin_dir() |
| 133 | + except RuntimeError as e: |
| 134 | + print(f"Error: {e}") |
| 135 | + print("Please specify the plugin directory with --plugin-dir") |
| 136 | + sys.exit(1) |
| 137 | + |
| 138 | + print(f"Platform: {sys.platform}") |
| 139 | + print(f"Plugin directory: {plugin_dir}") |
| 140 | + print(f"Plugin name: {args.name}") |
| 141 | + print() |
| 142 | + |
| 143 | + if args.remove: |
| 144 | + success = remove_plugin(plugin_dir, args.name) |
| 145 | + else: |
| 146 | + success = install_plugin(source_dir, plugin_dir, args.name) |
| 147 | + |
| 148 | + if success: |
| 149 | + print() |
| 150 | + print("=" * 60) |
| 151 | + print("Installation complete!") |
| 152 | + print("=" * 60) |
| 153 | + print() |
| 154 | + print("To use the plugin:") |
| 155 | + print(" 1. Restart QGIS") |
| 156 | + print(" 2. Go to Plugins -> Manage and Install Plugins...") |
| 157 | + print(f" 3. Enable '{args.name}'") |
| 158 | + print() |
| 159 | + |
| 160 | + sys.exit(0 if success else 1) |
| 161 | + |
| 162 | + |
| 163 | +if __name__ == "__main__": |
| 164 | + main() |
![pre-commit-ci[bot]](https://avatars.githubusercontent.com/in/68672?v=4&size=40){kind=avatar}
0 commit comments