sing-box-cli 0.0.27__tar.gz → 0.0.29__tar.gz

{sing_box_cli-0.0.27 → sing_box_cli-0.0.29}/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.0.29 - 2025-03-22
+
+### 🚀 Features
+
+- Add update option for `run` and `service restart` to update config automatically
+- Add `--restart` option for `config add-sub`
+
+### 📚 Documentation
+
+- Fix email
+
+### ⚙️ Miscellaneous Tasks
+
+- Rename dir sing_box_service as sing_box_cli
+- Replace creating service  instance manually with context object
+
+## 0.0.28 - 2025-03-21
+
+### ⚙️ Miscellaneous Tasks
+
+- Remove commands about capture logs in windows
+
 ## 0.0.27 - 2025-03-21
 
 ### 🐛 Bug Fixes

{sing_box_cli-0.0.27 → sing_box_cli-0.0.29}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: sing-box-cli
-Version: 0.0.27
-Summary: cross-platform sing-box-service manager.
+Version: 0.0.29
+Summary: cross-platform sing-box manager.
 Project-URL: Homepage, https://github.com/aittcuszz/sing-box-service
 Project-URL: Issues, https://github.com/atticuszz/sing-box-service/issues
 Project-URL: documentation, https://atticuszz.github.io/sing-box-service/
 Project-URL: Changelog, https://github.com/atticuszz/sing-box-service/blob/main/CHANGELOG.md
-Author-email: "A.J.Zeller" <zhouge1831@gmail.com>
-Maintainer-email: "A.J.Zeller" <zhouge1831@gmail.com>
+Author-email: "A.J.Zeller" <hello@atticux.me>
+Maintainer-email: "A.J.Zeller" <hello@atticux.me>
 License: MIT License
         
         Copyright (c) 2024 A.J.Zeller

{sing_box_cli-0.0.27 → sing_box_cli-0.0.29}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "sing-box-cli"
-description = "cross-platform sing-box-service manager."
+description = "cross-platform sing-box manager."
 classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python",
@@ -19,8 +19,8 @@ classifiers = [
 readme = "README.md"
 requires-python = ">=3.10"
 license = { file = "LICENSE" }
-authors = [{ name = "A.J.Zeller", email = "zhouge1831@gmail.com" }]
-maintainers = [{ name = "A.J.Zeller", email = "zhouge1831@gmail.com" }]
+authors = [{ name = "A.J.Zeller", email = "hello@atticux.me" }]
+maintainers = [{ name = "A.J.Zeller", email = "hello@atticux.me" }]
 
 dynamic = ["version"] # https://hatch.pypa.io/latest/config/metadata/#version
 dependencies = [
@@ -39,7 +39,7 @@ documentation = "https://atticuszz.github.io/sing-box-service/"
 Changelog = "https://github.com/atticuszz/sing-box-service/blob/main/CHANGELOG.md"
 
 [project.scripts] # build-backend config needed
-sing-box-cli = "sing_box_service:main" # equal to from python import main; then run main()
+sing-box-cli = "sing_box_cli:main" # equal to from python import main; then run main()
 # FROM: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
 
 [tool.uv]
@@ -65,11 +65,11 @@ dev = [
 ]
 
 [tool.hatch.version]
-path = "src/sing_box_service/__init__.py"
+path = "src/sing_box_cli/__init__.py"
 # FROM: https://hatch.pypa.io/latest/version/
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/sing_box_service"]
+packages = ["src/sing_box_cli"]
 # FROM: https://hatch.pypa.io/latest/build/
 
 
@@ -213,7 +213,7 @@ sort_commits = "oldest"
 
 
 [tool.bumpversion]
-current_version = "0.0.27"
+current_version = "0.0.29"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"
@@ -234,7 +234,7 @@ pre_commit_hooks = []
 post_commit_hooks = []
 
 [[tool.bumpversion.files]]
-filename = "src/sing_box_service/__init__.py"
+filename = "src/sing_box_cli/__init__.py"
 
 [[tool.bumpversion.files]]
 filename = "CHANGELOG.md"

{sing_box_cli-0.0.27/src/sing_box_service → sing_box_cli-0.0.29/src/sing_box_cli}/__init__.py

@@ -2,4 +2,4 @@ from .main import main
 
 __all__ = ["main"]
 
-__version__ = "0.0.27"
+__version__ = "0.0.29"

{sing_box_cli-0.0.27/src/sing_box_service → sing_box_cli-0.0.29/src/sing_box_cli}/common.py

@@ -1,7 +1,13 @@
 import os
 from enum import Enum
+from typing import Annotated
+
+import typer
 
 StrOrNone = str | None
+UpdateConfigOption = Annotated[
+    bool, typer.Option("--update", "-u", help="Update configuration before running.")
+]
 
 
 class LogLevel(str, Enum):

{sing_box_cli-0.0.27/src/sing_box_service → sing_box_cli-0.0.29/src/sing_box_cli}/config/__init__.py

@@ -7,22 +7,33 @@ from .config import SingBoxConfig, get_config
 
 __all__ = ["config", "SingBoxConfig", "get_config"]
 
+SubUrlArg = Annotated[str, typer.Argument(help="Subscription URL")]
+RestartServiceOption = Annotated[
+    bool, typer.Option("--restart", "-r", help="Restart service after update.")
+]
+
 config = typer.Typer(help="Configuration management commands")
 
 
 @config.command("add-sub")
-def config_add_sub(ctx: typer.Context, url: Annotated[str, typer.Argument()]) -> None:
-    """Add subscription URL"""
-    ensure_root()
+def config_add_sub(
+    ctx: typer.Context, url: SubUrlArg, restart: RestartServiceOption = False
+) -> None:
+    """Add subscription URL, download configuration and restart service if needed"""
     if ctx.obj.config.add_subscription(url):
-        # restart service if subscription is updated
-        if not ctx.obj.service.check_service():
-            ctx.obj.service.create_service()
-            print("⌛ Service created successfully.")
+        # download config
         if ctx.obj.config.update_config():
-            ctx.obj.service.restart()
+            print("✅ Configuration updated.")
         else:
+            print("❌ Failed to update configuration.")
             raise typer.Exit(1)
+        if restart:
+            ensure_root()
+            # init service
+            if not ctx.obj.service.check_service():
+                ctx.obj.service.create_service()
+                print("⌛ Service created successfully.")
+            ctx.obj.service.restart()
     else:
         print("❌ Failed to add subscription.")
         raise typer.Exit(1)

{sing_box_cli-0.0.27/src/sing_box_service → sing_box_cli-0.0.29/src/sing_box_cli}/main.py

@@ -5,7 +5,7 @@ import typer
 from rich import print
 
 from .api import api as api_app
-from .common import ensure_root
+from .common import UpdateConfigOption, ensure_root
 from .config import SingBoxConfig, config as config_app, get_config
 from .service import (
     LinuxServiceManager,
@@ -35,26 +35,22 @@ def callback(ctx: typer.Context) -> None:
 
 
 @app.command()
-def run(ctx: typer.Context) -> None:
+def run(ctx: typer.Context, update: UpdateConfigOption = False) -> None:
     """Run sing-box if host's service unavailable"""
     ensure_root()
     cfg = ctx.obj.config
-    if cfg.update_config():
-        cmd = [
-            cfg.bin_path,
-            "run",
-            "-C",
-            str(cfg.install_dir),
-            "-D",
-            str(cfg.install_dir),
-        ]
-        if cfg.is_windows:
-            subprocess.run(["pwsh"] + cmd)
+    if update:
+        if cfg.update_config():
+            print("✅ Configuration updated.")
         else:
-            subprocess.run(cmd)
+            print("❌ Failed to update configuration.")
+            raise typer.Exit(1)
+
+    cmd = [cfg.bin_path, "run", "-C", str(cfg.config_dir), "-D", str(cfg.config_dir)]
+    if cfg.is_windows:
+        subprocess.run(["pwsh"] + cmd)
     else:
-        print("❌ Failed to update configuration.")
-        raise typer.Exit(1)
+        subprocess.run(cmd)
 
 
 @app.command()

{sing_box_cli-0.0.27/src/sing_box_service → sing_box_cli-0.0.29/src/sing_box_cli}/service/__init__.py

@@ -1,6 +1,6 @@
 import typer
 
-from ..common import ensure_root
+from ..common import UpdateConfigOption, ensure_root
 from .manager import LinuxServiceManager, WindowsServiceManager, create_service
 
 __all__ = ["service", "WindowsServiceManager", "LinuxServiceManager", "create_service"]
@@ -14,7 +14,7 @@ def service_enable(ctx: typer.Context) -> None:
     """Create sing-box service, enable autostart and start service"""
     ensure_root()
     config = ctx.obj.config
-    service = create_service(config)
+    service = ctx.obj.service
     service.create_service()
     service.start()
     print("🔥 Service started.")
@@ -26,26 +26,28 @@ def service_enable(ctx: typer.Context) -> None:
 def service_disable(ctx: typer.Context) -> None:
     """Stop service, disable sing-box service autostart and remove service"""
     ensure_root()
-    config = ctx.obj.config
-    service = create_service(config)
+    service = ctx.obj.service
     service.stop()
     service.disable()
     print("✋ Autostart disabled.")
 
 
 @service.command("restart")
-def service_restart(ctx: typer.Context) -> None:
+def service_restart(ctx: typer.Context, update: UpdateConfigOption = False) -> None:
     """Restart sing-box service, update configuration if needed, create service if not exists"""
     ensure_root()
     config = ctx.obj.config
-    service = create_service(config)
+    service = ctx.obj.service
     if not service.check_service():
         service.create_service()
-    if config.update_config():
-        service.restart()
-    else:
-        print("❌ Failed to update configuration.")
-        raise typer.Exit(1)
+    if update:
+        if config.update_config():
+            print("✅ Configuration updated.")
+        else:
+            print("❌ Failed to update configuration.")
+            raise typer.Exit(1)
+
+    service.restart()
     print("🔥 Service restarted.")
     if config.api_base_url:
         print(f"🔌 Default API: {config.api_base_url}")
@@ -55,8 +57,7 @@ def service_restart(ctx: typer.Context) -> None:
 def service_stop(ctx: typer.Context) -> None:
     """Stop sing-box service"""
     ensure_root()
-    config = ctx.obj.config
-    service = create_service(config)
+    service = ctx.obj.service
     service.stop()
     print("✋ Service stopped.")
 
@@ -65,7 +66,6 @@ def service_stop(ctx: typer.Context) -> None:
 def service_status(ctx: typer.Context) -> None:
     """Check service status"""
     ensure_root()
-    config = ctx.obj.config
-    service = create_service(config)
+    service = ctx.obj.service
     status = service.status()
     print(f"🏃 Service status: {status}")

{sing_box_cli-0.0.27/src/sing_box_service → sing_box_cli-0.0.29/src/sing_box_cli}/service/manager.py

@@ -38,7 +38,6 @@ class WindowsServiceManager(ServiceManager):
     def __init__(self, config: SingBoxConfig) -> None:
         super().__init__(config)
         self.task_name = "sing-box-service"
-        self.log_file = self.config.config_dir / "sing-box.log"
 
     def create_service(self) -> None:
         start_script = self.config.config_dir / "start-singbox.ps1"
@@ -52,21 +51,9 @@ public static extern bool ShowWindow(IntPtr hWnd, Int32 nCmdShow);
 $console = [Console.Window]::GetConsoleWindow()
 [Console.Window]::ShowWindow($console, 0)
 
-[Console]::OutputEncoding = [System.Text.Encoding]::UTF8
-$OutputEncoding = [System.Text.Encoding]::UTF8
-chcp 65001 | Out-Null
-
 Set-Location "{self.config.config_dir}"
 
-if (Test-Path "{self.log_file}") {{
-    Clear-Content "{self.log_file}"
-}}
-
-try {{
-    & "{self.config.bin_path}" run -C "{self.config.config_dir}" *>&1 | Tee-Object -FilePath "{self.log_file}" -Append
-}} catch {{
-    $_ | Out-File -FilePath "{self.log_file}" -Append
-}}
+& "{self.config.bin_path}" run -C "{self.config.config_dir}"
 """
         start_script.write_text(script_content, encoding="utf-8")
 

{sing_box_cli-0.0.27 → sing_box_cli-0.0.29}/tests/test_config.py

@@ -1,6 +1,6 @@
 import pytest
 
-from sing_box_service.config.utils import show_diff_config
+from sing_box_cli.config.utils import show_diff_config
 
 
 def test_show_diff_config(capsys: pytest.CaptureFixture[str]) -> None: