gitwebhooks 2.1.4__py3-none-any.whl → 2.2.0__py3-none-any.whl

gitwebhooks/__init__.py

@@ -3,7 +3,7 @@
 Automated deployment server supporting GitHub, Gitee, GitLab, and custom webhooks.
 """
 
-__version__ = '2.0.0'
+__version__ = '2.2.0'
 
 # Export main classes for convenient import paths
 from .server import WebhookServer

gitwebhooks/main/__init__.py

@@ -6,10 +6,11 @@ Command-line interface module providing compatibility with the original gitwebho
 import argparse
 import sys
 from pathlib import Path
-from typing import List
+from typing import List, Optional
 
 from gitwebhooks.server import WebhookServer
 from gitwebhooks.utils.exceptions import ConfigurationError
+from gitwebhooks.utils.constants import CONFIG_SEARCH_PATHS
 
 # Try to import subcommands, may not be available in older versions
 try:
@@ -19,6 +20,56 @@ except ImportError:
     HAS_SUBCOMMANDS = False
 
 
+def find_config_file() -> Optional[str]:
+    """Find configuration file by priority order.
+
+    Searches for configuration files in the following order:
+    1. User level: ~/.gitwebhooks.ini
+    2. Local level: /usr/local/etc/gitwebhooks.ini
+    3. System level: /etc/gitwebhooks.ini
+
+    Returns:
+        Path string of the first existing configuration file, or None if not found.
+
+    Examples:
+        >>> find_config_file()  # doctest: +SKIP
+        '/home/user/.gitwebhooks.ini'
+        >>> find_config_file()  # doctest: +SKIP
+        None
+    """
+    for config_path in CONFIG_SEARCH_PATHS:
+        expanded_path = Path(config_path).expanduser().resolve()
+        if expanded_path.exists():
+            return str(expanded_path)
+    return None
+
+
+def format_config_error(searched_paths: List[Path]) -> str:
+    """Format user-friendly error message for missing configuration file.
+
+    Args:
+        searched_paths: List of paths that were searched.
+
+    Returns:
+        Formatted error message string.
+
+    Examples:
+        >>> paths = [Path('/home/user/.gitwebhooks.ini')]
+        >>> format_config_error(paths)  # doctest: +SKIP
+        'Error: Configuration file not found.\\nSearched paths:\\n  1. /home/user/.gitwebhooks.ini\\n\\nYou can create a configuration file using:\\n  gitwebhooks-cli config init'
+    """
+    lines = [
+        'Error: Configuration file not found.',
+        'Searched paths:'
+    ]
+    for i, path in enumerate(searched_paths, 1):
+        lines.append(f'  {i}. {path}')
+    lines.append('')
+    lines.append('You can create a configuration file using:')
+    lines.append('  gitwebhooks-cli config init')
+    return '\n'.join(lines)
+
+
 def main(argv: List[str] = None) -> int:
     """Main entry point
 
@@ -33,14 +84,18 @@ def main(argv: List[str] = None) -> int:
 
     Command Line Arguments:
         -h, --help      Show help message and exit
-        -c, --config    Specify configuration file path
+        -c, --config    Specify configuration file path (optional)
         service         Service management subcommands
         config          Configuration management subcommands
 
-    Default Config Path:
-        ~/.gitwebhook.ini
+    Config Discovery:
+        When -c is not specified, searches in order:
+        1. ~/.gitwebhooks.ini (user level)
+        2. /usr/local/etc/gitwebhooks.ini (local level)
+        3. /etc/gitwebhooks.ini (system level)
 
     Examples:
+        python3 -m gitwebhooks.main
         python3 -m gitwebhooks.main -c /path/to/config.ini
         gitwebhooks-cli --config /etc/webhooks.ini
         gitwebhooks-cli service install
@@ -49,9 +104,6 @@ def main(argv: List[str] = None) -> int:
     if argv is None:
         argv = sys.argv[1:]
 
-    # Default configuration file path (changed to user home directory)
-    default_config = '~/.gitwebhook.ini'
-
     # Create main argument parser
     parser = argparse.ArgumentParser(
         prog='gitwebhooks-cli',
@@ -60,8 +112,8 @@ def main(argv: List[str] = None) -> int:
     )
     parser.add_argument(
         '-c', '--config',
-        default=default_config,
-        help='Path to INI configuration file (default: ~/.gitwebhook.ini)'
+        default=None,
+        help='Path to INI configuration file (default: auto-discover)'
     )
 
     # Add subcommands if available
@@ -80,15 +132,25 @@ def main(argv: List[str] = None) -> int:
     return args.func(args)
 
 
-def run_server(config_file: str) -> int:
+def run_server(config_file: Optional[str]) -> int:
     """Run the webhook server
 
     Args:
-        config_file: Path to configuration file
+        config_file: Path to configuration file, or None to auto-discover
 
     Returns:
         Exit code (0 = success, 1 = error)
     """
+    # Auto-discover config file if not specified
+    if config_file is None:
+        config_file = find_config_file()
+        if config_file is None:
+            # No config found - format error with all search paths
+            searched_paths = [Path(p).expanduser().resolve() for p in CONFIG_SEARCH_PATHS]
+            error_msg = format_config_error(searched_paths)
+            print(error_msg, file=sys.stderr)
+            return 1
+
     # Expand user path
     config_path = Path(config_file).expanduser()
 
@@ -97,6 +159,9 @@ def run_server(config_file: str) -> int:
         print(f'Error: Configuration file not found: {config_path}', file=sys.stderr)
         return 1
 
+    # Print configuration file being used
+    print(f'Using configuration file: {config_path}')
+
     # Create and run server
     try:
         server = WebhookServer(config_path=str(config_path))

{gitwebhooks-2.1.4.dist-info → gitwebhooks-2.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitwebhooks
-Version: 2.1.4
+Version: 2.2.0
 Summary: A lightweight Git webhook server for automated deployment supporting GitHub, Gitee, GitLab, and custom webhooks
 Author-email: Troy Tse <troy@holyhi.net>
 Maintainer-email: Troy Tse <troy@holyhi.net>
@@ -291,9 +291,47 @@ pip uninstall gitwebhooks
 
 ## Usage
 
+### Configuration File Auto-Discovery
+
+The `gitwebhooks-cli` automatically searches for configuration files in the following order (priority):
+
+1. **User level**: `~/.gitwebhooks.ini` (highest priority)
+2. **Local level**: `/usr/local/etc/gitwebhooks.ini`
+3. **System level**: `/etc/gitwebhooks.ini` (lowest priority)
+
+You can run `gitwebhooks-cli` without specifying `-c` parameter, and it will automatically use the first existing configuration file.
+
+```bash
+# Auto-discover and use configuration file
+gitwebhooks-cli
+
+# The server will display which config file is being used
+# Using configuration file: /home/user/.gitwebhooks.ini
+```
+
+If you want to use a specific configuration file, use the `-c` parameter:
+
+```bash
+# Use a specific configuration file
+gitwebhooks-cli -c /path/to/custom.ini
+```
+
+If no configuration file is found, a friendly error message will display all searched paths:
+
+```
+Error: Configuration file not found.
+Searched paths:
+  1. /home/user/.gitwebhooks.ini
+  2. /usr/local/etc/gitwebhooks.ini
+  3. /etc/gitwebhooks.ini
+
+You can create a configuration file using:
+  gitwebhooks-cli config init
+```
+
 ### 1. Configure Repository
 
-Edit `~/.gitwebhook.ini`:
+Edit your configuration file (e.g., `~/.gitwebhooks.ini`):
 
 ```ini
 [your_name/repository]
@@ -307,7 +345,7 @@ cmd=git fetch --all && git reset --hard origin/master && git pull
 # If running as a service
 systemctl restart gitwebhooks
 
-# Or run directly:
+# Or run directly (auto-discovers config file):
 gitwebhooks-cli
 ```
 

{gitwebhooks-2.1.4.dist-info → gitwebhooks-2.2.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-gitwebhooks/__init__.py,sha256=lBuLRzIrUhawp8mQG3IB5HZiksNeUmuuDBRK5_hcZvw,422
+gitwebhooks/__init__.py,sha256=KUi3jpqSom1NA9r8du8t2kG1mZ0NN8Jtdbl9wlxr5bg,422
 gitwebhooks/__main__.py,sha256=DW1lmngPDSFHJKSyaG2Dd5k3UguGSuYPUM2xKR8DhTo,189
 gitwebhooks/server.py,sha256=keQcfOysoitx7cINcTkaDvhe6nScIFL2K8dCCViFF-o,3986
 gitwebhooks/auth/__init__.py,sha256=Hu88BS6aOickrWBBWM2ppTzy2xOJfWODYkp752bPTPM,532
@@ -28,7 +28,7 @@ gitwebhooks/handlers/gitlab.py,sha256=UkK3R_KSKSt0s7XAtH1_G_uid85tqiL12qND8_Pnos
 gitwebhooks/handlers/request.py,sha256=GsKH-R7L7j7h9GKEAse-O4tnmXeQMkbsT8WK_J8ACl8,9184
 gitwebhooks/logging/__init__.py,sha256=CmL5WD2RgZ76uhrxzwnIfOEd_HgTZMTtTjjqYSY06GA,146
 gitwebhooks/logging/setup.py,sha256=scu4nfEJTLR6QpmO4exXbKaMcTU11qHR2Jv8fEpEMD8,2095
-gitwebhooks/main/__init__.py,sha256=PVKE1vo5PcWmnxwUNSOWlvNrUUEdEYWRkKiHIWYHe-U,3155
+gitwebhooks/main/__init__.py,sha256=kg7QtoWHljnEkysei5XoIwXMjveNHf_bdPwfei5Vypw,5559
 gitwebhooks/main/__main__.py,sha256=qE-72BSpj15NeV6-oWpMXR3ARmATeSGUO8VUB98sxF8,223
 gitwebhooks/models/__init__.py,sha256=DmZBPoNeh7eB9Ntr6d4T9QY6-LckvrHNGg8FVcpuvP0,273
 gitwebhooks/models/provider.py,sha256=lmjJvGjklD1VTKB6UF9V-gZCPwXhiip8DR8qXs_A-F8,451
@@ -39,9 +39,9 @@ gitwebhooks/utils/constants.py,sha256=V_SFYrHpkX-fKSfVwx8fXwBjZe2f4EjoVz925RZryr
 gitwebhooks/utils/exceptions.py,sha256=Mfz-FOCiHZiYmpSQDw36S9HarLE2wPLfFbkeHfWJnkk,627
 gitwebhooks/utils/executor.py,sha256=-zQUV5t-eq0JF6T4EvsUlvg4lnBtahRGrV8N3iVgx_c,923
 gitwebhooks/utils/systemd.py,sha256=00k55_vcstkTmJi99RrSfx-RIuI1dwTlggCPRPfbhNU,7901
-gitwebhooks-2.1.4.dist-info/licenses/LICENSE,sha256=NV5F0xpN-DVJuhc0qzOsXtLjf3l8X18zehW_7F4qI50,1083
-gitwebhooks-2.1.4.dist-info/METADATA,sha256=IOdS_ka6_1Bmojj31aqxfOC41x6gtivD8R77DBIQcMM,13155
-gitwebhooks-2.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gitwebhooks-2.1.4.dist-info/entry_points.txt,sha256=kcbGwiZPNGnfEYlsrOaNQinGC1rTkiaDOF2NJ6S_5MU,58
-gitwebhooks-2.1.4.dist-info/top_level.txt,sha256=9a6CxnHxBD53HL38GUeZETIvnUhUKcgDRIGJkCqwc3o,12
-gitwebhooks-2.1.4.dist-info/RECORD,,
+gitwebhooks-2.2.0.dist-info/licenses/LICENSE,sha256=NV5F0xpN-DVJuhc0qzOsXtLjf3l8X18zehW_7F4qI50,1083
+gitwebhooks-2.2.0.dist-info/METADATA,sha256=gPht52jk7aXxx3AhQEZCHNpij_IrFY97UUYHEIvOyLM,14346
+gitwebhooks-2.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gitwebhooks-2.2.0.dist-info/entry_points.txt,sha256=kcbGwiZPNGnfEYlsrOaNQinGC1rTkiaDOF2NJ6S_5MU,58
+gitwebhooks-2.2.0.dist-info/top_level.txt,sha256=9a6CxnHxBD53HL38GUeZETIvnUhUKcgDRIGJkCqwc3o,12
+gitwebhooks-2.2.0.dist-info/RECORD,,