gitwebhooks 2.1.4__tar.gz → 2.2.0__tar.gz

{gitwebhooks-2.1.4 → gitwebhooks-2.2.0}/CLAUDE.md

@@ -42,7 +42,7 @@ sudo gitwebhooks-cli service uninstall
 # 方式1: 使用模块入口
 python3 -m gitwebhooks.cli -c /path/to/config.ini
 
-# 方式2: 使用 CLI 工具（使用默认配置）
+# 方式2: 使用 CLI 工具（自动查找配置文件）
 gitwebhooks-cli
 
 # 方式3: 指定配置文件
@@ -55,6 +55,14 @@ systemctl restart gitwebhooks
 systemctl status gitwebhooks
 ```
 
+**配置文件自动查找**：
+- 不指定 `-c` 参数时，系统按优先级自动查找配置文件：
+  1. `~/.gitwebhooks.ini`（用户级，最高优先级）
+  2. `/usr/local/etc/gitwebhooks.ini`（本地级）
+  3. `/etc/gitwebhooks.ini`（系统级）
+- 启动时会显示正在使用的配置文件路径
+- 找不到配置文件时显示友好的错误消息
+
 ### 测试开发
 ```bash
 # 直接运行（开发模式）
@@ -292,6 +300,7 @@ gitwebhooks/
 - INI 配置文件，systemd 服务单元文件 (001-install-method-guidance)
 - Python 3.7+ (项目要求) + Python 标准库仅（无外部依赖） (001-fix-config-init-bug)
 - INI 配置文件 (configparser) (001-fix-config-init-bug)
+- Python 3.7+ (项目要求) + Python 标准库（pathlib, configparser, argparse） (001-config-priority)
 
 ## Recent Changes
 - 001-config-init-wizard: 添加 `config init` 交互式向导，支持配置级别选择、平台配置和仓库配置

{gitwebhooks-2.1.4 → gitwebhooks-2.2.0}/PKG-INFO

@@ -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 → gitwebhooks-2.2.0}/README.md

@@ -251,9 +251,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]
@@ -267,7 +305,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 → gitwebhooks-2.2.0}/README.zh.md

@@ -251,9 +251,47 @@ pip uninstall gitwebhooks
 
 ## 使用
 
+### 配置文件自动查找
+
+`gitwebhooks-cli` 会自动按以下顺序（优先级）搜索配置文件：
+
+1. **用户级**：`~/.gitwebhooks.ini`（最高优先级）
+2. **本地级**：`/usr/local/etc/gitwebhooks.ini`
+3. **系统级**：`/etc/gitwebhooks.ini`（最低优先级）
+
+您可以直接运行 `gitwebhooks-cli` 而无需指定 `-c` 参数，系统会自动使用第一个存在的配置文件。
+
+```bash
+# 自动查找并使用配置文件
+gitwebhooks-cli
+
+# 服务器会显示正在使用的配置文件
+# Using configuration file: /home/user/.gitwebhooks.ini
+```
+
+如果需要使用特定的配置文件，可以使用 `-c` 参数：
+
+```bash
+# 使用指定的配置文件
+gitwebhooks-cli -c /path/to/custom.ini
+```
+
+如果找不到配置文件，会显示友好的错误消息并列出所有搜索路径：
+
+```
+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. 配置仓库
 
-编辑 `~/.gitwebhook.ini`：
+编辑您的配置文件（例如 `~/.gitwebhooks.ini`）：
 
 ```ini
 [your_name/repository]
@@ -267,7 +305,7 @@ cmd=git fetch --all && git reset --hard origin/master && git pull
 # 如果作为服务运行
 systemctl restart gitwebhooks
 
-# 或直接运行：
+# 或直接运行（自动查找配置文件）：
 gitwebhooks-cli
 ```
 

{gitwebhooks-2.1.4 → gitwebhooks-2.2.0}/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-2.2.0/gitwebhooks/main/__init__.py

@@ -0,0 +1,182 @@
+"""CLI main function
+
+Command-line interface module providing compatibility with the original gitwebhooks.py.
+"""
+
+import argparse
+import sys
+from pathlib import Path
+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:
+    from gitwebhooks.cli import register_subparsers
+    HAS_SUBCOMMANDS = True
+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
+
+    Args:
+        argv: Command-line argument list (defaults to sys.argv[1:])
+
+    Returns:
+        Exit code (0 = success, 1 = error)
+
+    Raises:
+        SystemExit: Exit on error
+
+    Command Line Arguments:
+        -h, --help      Show help message and exit
+        -c, --config    Specify configuration file path (optional)
+        service         Service management subcommands
+        config          Configuration management subcommands
+
+    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
+        gitwebhooks-cli config init
+    """
+    if argv is None:
+        argv = sys.argv[1:]
+
+    # Create main argument parser
+    parser = argparse.ArgumentParser(
+        prog='gitwebhooks-cli',
+        description='Git Webhooks Server - Automated deployment webhook handler',
+        add_help=True
+    )
+    parser.add_argument(
+        '-c', '--config',
+        default=None,
+        help='Path to INI configuration file (default: auto-discover)'
+    )
+
+    # Add subcommands if available
+    if HAS_SUBCOMMANDS:
+        subparsers = parser.add_subparsers(dest='command', help='Subcommands')
+        register_subparsers(subparsers)
+
+    # Parse arguments
+    args = parser.parse_args(argv)
+
+    # If no subcommand, run server (backward compatible behavior)
+    if not hasattr(args, 'func'):
+        return run_server(args.config)
+
+    # Execute subcommand
+    return args.func(args)
+
+
+def run_server(config_file: Optional[str]) -> int:
+    """Run the webhook server
+
+    Args:
+        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()
+
+    # Check configuration file exists
+    if not config_path.exists():
+        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))
+        server.run()
+        return 0
+    except ConfigurationError as e:
+        print(f'Configuration error: {e}', file=sys.stderr)
+        return 1
+    except KeyboardInterrupt:
+        print('\nServer stopped by user')
+        return 0
+    except Exception as e:
+        print(f'Error: {e}', file=sys.stderr)
+        return 1
+
+
+if __name__ == '__main__':
+    sys.exit(main())

{gitwebhooks-2.1.4 → gitwebhooks-2.2.0}/gitwebhooks.egg-info/PKG-INFO

@@ -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 → gitwebhooks-2.2.0}/gitwebhooks.egg-info/SOURCES.txt

@@ -116,6 +116,7 @@ tests/fixtures/gitlab_payloads.py
 tests/fixtures/signature_builder.py
 tests/integration/__init__.py
 tests/integration/test_command_execution.py
+tests/integration/test_config_discovery.py
 tests/integration/test_config_view_integration.py
 tests/integration/test_custom_webhook.py
 tests/integration/test_edge_cases.py
@@ -129,6 +130,7 @@ tests/test_integration/__init__.py
 tests/unit/__init__.py
 tests/unit/test_config_loading.py
 tests/unit/test_data_parsing.py
+tests/unit/test_main.py
 tests/unit/test_provider_detection.py
 tests/unit/test_request_handler.py
 tests/unit/test_signature_verification.py

{gitwebhooks-2.1.4 → gitwebhooks-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gitwebhooks"
-version = "2.1.4"
+version = "2.2.0"
 description = "A lightweight Git webhook server for automated deployment supporting GitHub, Gitee, GitLab, and custom webhooks"
 readme = "README.md"
 license = "MIT"