python-dmon 0.2.3__tar.gz → 0.3.0__tar.gz

{python_dmon-0.2.3 → python_dmon-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-dmon
-Version: 0.2.3
+Version: 0.3.0
 Summary: A lightweight, cross-platform daemon manager that runs any command as a background process.
 Keywords: python-dmon,dmon,daemon,background,detach,process management
 Author: Atomie CHEN
@@ -21,6 +21,7 @@ Description-Content-Type: text/markdown
 
 [![GitHub](https://img.shields.io/badge/github-python--dmon-blue?logo=github)](https://github.com/atomiechen/python-dmon)
 [![PyPI](https://img.shields.io/pypi/v/python--dmon?logo=pypi&logoColor=white)](https://pypi.org/project/python-dmon/)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/atomiechen/python-dmon)
 
 
 A lightweight, cross-platform daemon manager that runs any command — called a *task* — as a background process. 
@@ -38,6 +39,8 @@ It is a Python-based and more powerful successor to the [handy-backend shell scr
 - 🧩 **Flexible tasks:** Tasks can be configured in `pyproject.toml` or `dmon.yaml`; or run ad-hoc commands directly.
 - 🪵 **Logging & log rotation:** Automatically manage log files to prevent uncontrolled growth.
 
+![dmon-demo-gif](https://github.com/user-attachments/assets/9bae2f46-5ef4-4784-aced-18d573204efc)
+
 
 ## Installation
 
@@ -84,14 +87,16 @@ Create a `dmon.yaml` file:
 
 ```yaml
 tasks:
-  app: ["python", "-u", "server.py"]
+  app: ["python", "-u", "server.py"]  # option 1: exec form
+  # app: "python -u server.py"  # option 2: shell string
 ```
 
 Or add to your `pyproject.toml`:
 
 ```toml
 [tool.dmon.tasks]
-app = ["python", "-u", "server.py"]
+app = ["python", "-u", "server.py"]  # option 1: exec form
+# app = "python -u server.py"  # option 2: shell string
 ```
 
 Commands can be a single string (run in shell), or list of strings (exec form).
@@ -109,6 +114,9 @@ dmon start app
 # Stop a running task
 dmon stop app
 
+# Restart a task
+dmon restart app
+
 # Check task status
 dmon status app
 
@@ -116,11 +124,23 @@ dmon status app
 dmon exec app
 ```
 
+You can specify multiple tasks at once, e.g.: `dmon start app1 app2 app3`, except for `dmon exec` which only accepts one task.
+
+Or use `--all` to operate on all tasks:
+
+```sh
+# all configured tasks
+dmon start/stop/restart --all
+# all running tasks
+dmon stop/status --all
+```
+
 If you have defined `default_task`, or only one task is defined in the config file, you can omit the task name:
 
 ```sh
 dmon start
 dmon stop
+dmon restart
 dmon status
 dmon exec
 ```

{python_dmon-0.2.3 → python_dmon-0.3.0}/README.md

@@ -3,6 +3,7 @@
 
 [![GitHub](https://img.shields.io/badge/github-python--dmon-blue?logo=github)](https://github.com/atomiechen/python-dmon)
 [![PyPI](https://img.shields.io/pypi/v/python--dmon?logo=pypi&logoColor=white)](https://pypi.org/project/python-dmon/)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/atomiechen/python-dmon)
 
 
 A lightweight, cross-platform daemon manager that runs any command — called a *task* — as a background process. 
@@ -20,6 +21,8 @@ It is a Python-based and more powerful successor to the [handy-backend shell scr
 - 🧩 **Flexible tasks:** Tasks can be configured in `pyproject.toml` or `dmon.yaml`; or run ad-hoc commands directly.
 - 🪵 **Logging & log rotation:** Automatically manage log files to prevent uncontrolled growth.
 
+![dmon-demo-gif](https://github.com/user-attachments/assets/9bae2f46-5ef4-4784-aced-18d573204efc)
+
 
 ## Installation
 
@@ -66,14 +69,16 @@ Create a `dmon.yaml` file:
 
 ```yaml
 tasks:
-  app: ["python", "-u", "server.py"]
+  app: ["python", "-u", "server.py"]  # option 1: exec form
+  # app: "python -u server.py"  # option 2: shell string
 ```
 
 Or add to your `pyproject.toml`:
 
 ```toml
 [tool.dmon.tasks]
-app = ["python", "-u", "server.py"]
+app = ["python", "-u", "server.py"]  # option 1: exec form
+# app = "python -u server.py"  # option 2: shell string
 ```
 
 Commands can be a single string (run in shell), or list of strings (exec form).
@@ -91,6 +96,9 @@ dmon start app
 # Stop a running task
 dmon stop app
 
+# Restart a task
+dmon restart app
+
 # Check task status
 dmon status app
 
@@ -98,11 +106,23 @@ dmon status app
 dmon exec app
 ```
 
+You can specify multiple tasks at once, e.g.: `dmon start app1 app2 app3`, except for `dmon exec` which only accepts one task.
+
+Or use `--all` to operate on all tasks:
+
+```sh
+# all configured tasks
+dmon start/stop/restart --all
+# all running tasks
+dmon stop/status --all
+```
+
 If you have defined `default_task`, or only one task is defined in the config file, you can omit the task name:
 
 ```sh
 dmon start
 dmon stop
+dmon restart
 dmon status
 dmon exec
 ```

{python_dmon-0.2.3 → python_dmon-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-dmon"
-version = "0.2.3"
+version = "0.3.0"
 description = "A lightweight, cross-platform daemon manager that runs any command as a background process."
 readme = "README.md"
 authors = [

{python_dmon-0.2.3 → python_dmon-0.3.0}/src/dmon/cli.py

@@ -1,11 +1,20 @@
 import argparse
+from pathlib import Path
 import shlex
 import sys
 
 from colorama import just_fix_windows_console
 
 from .config import check_name_in_config, get_task_config
-from .control import execute, list_processes, restart, start, stop, status
+from .control import (
+    execute,
+    get_meta_paths,
+    list_processes,
+    restart,
+    start,
+    stop,
+    status,
+)
 from .constants import (
     DEFAULT_META_DIR,
     DEFAULT_RUN_NAME,
@@ -50,7 +59,7 @@ def main():
     sp_start.add_argument(
         "task",
         help="Configured task name (default: the only task if there's just one)",
-        nargs="?",
+        nargs="*",
     )
     sp_start.add_argument(
         "--meta-file",
@@ -60,20 +69,26 @@ def main():
         "--log-file",
         help=f"Path to log file (default: task configured or {LOG_PATH_TEMPLATE})",
     )
+    sp_start.add_argument("--all", action="store_true", help="Start all processes")
 
     # stop subcommand
     sp_stop = subparsers.add_parser(
         "stop",
-        help="Stop a background process",
-        description="Stop a background process given name or meta file",
+        help="Stop background process(es)",
+        description="Stop background process(es) given name or meta file",
         # formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     sp_stop.add_argument(
         "task",
         help="Configured task name (default: the only task if there's just one)",
-        nargs="?",
+        nargs="*",
     )
     sp_stop.add_argument("--meta-file", help="Path to meta file")
+    sp_stop.add_argument(
+        "--all",
+        action="store_true",
+        help=f"Stop all processes in meta dir ({DEFAULT_META_DIR})",
+    )
 
     # restart subcommand
     sp_restart = subparsers.add_parser(
@@ -85,7 +100,7 @@ def main():
     sp_restart.add_argument(
         "task",
         help="Configured task name (default: the only task if there's just one)",
-        nargs="?",
+        nargs="*",
     )
     sp_restart.add_argument(
         "--meta-file",
@@ -95,23 +110,30 @@ def main():
         "--log-file",
         help=f"Path to log file (default: task configured or {LOG_PATH_TEMPLATE})",
     )
+    sp_restart.add_argument("--all", action="store_true", help="Restart all processes")
 
     # status subcommand
     sp_status = subparsers.add_parser(
         "status",
-        help="Check process status",
-        description="Check status of a background process given name or meta file",
+        help="Check status of background process(es)",
+        description="Check status of background process(es) given name or meta file",
         # formatter_class=argparse.ArgumentDefaultsHelpFormatter,
     )
     sp_status.add_argument(
         "task",
         help="Configured task name (default: the only task if there's just one)",
-        nargs="?",
+        nargs="*",
     )
     sp_status.add_argument(
         "--meta-file",
         help=f"Path to meta file (default: {META_PATH_TEMPLATE})",
     )
+    sp_status.add_argument(
+        "-a",
+        "--all",
+        action="store_true",
+        help=f"Check status of all processes in meta dir ({DEFAULT_META_DIR})",
+    )
 
     # list subcommand
     sp_list = subparsers.add_parser(
@@ -199,46 +221,71 @@ def main():
     if args.command in ["start", "restart"]:
         sp = sp_start if args.command == "start" else sp_restart
         try:
-            task, task_cfg = get_task_config(args.task, args.config)
+            tasks, task_cfgs = get_task_config(args.task, args.config, args.all)
         except Exception as e:
             sp.error(str(e))
 
-        task_cfg.meta_path = (
-            args.meta_file or task_cfg.meta_path or META_PATH_TEMPLATE.format(task=task)
-        )
-        task_cfg.log_path = (
-            args.log_file or task_cfg.log_path or LOG_PATH_TEMPLATE.format(task=task)
-        )
-        task_cfg.rotate_log_path = (
-            task_cfg.rotate_log_path or ROTATE_LOG_PATH_TEMPLATE.format(task=task)
-        )
+        # check if meta_file or log_file path is provided;
+        # if so, only one task should be specified
+        if args.meta_file or args.log_file:
+            if len(tasks) == 1:
+                task_cfgs[0].meta_path = args.meta_file or task_cfgs[0].meta_path
+                task_cfgs[0].log_path = args.log_file or task_cfgs[0].log_path
+            else:
+                sp.error(
+                    f"'--meta-file' and '--log-file' can only be specified when {args.command}ing a single task"
+                )
+        # fill in default values if not provided
+        for task, task_cfg in zip(tasks, task_cfgs):
+            task_cfg.meta_path = task_cfg.meta_path or META_PATH_TEMPLATE.format(
+                task=task
+            )
+            task_cfg.log_path = task_cfg.log_path or LOG_PATH_TEMPLATE.format(task=task)
+            task_cfg.rotate_log_path = (
+                task_cfg.rotate_log_path or ROTATE_LOG_PATH_TEMPLATE.format(task=task)
+            )
         if args.command == "start":
-            sys.exit(start(task_cfg))
+            sys.exit(start(task_cfgs))
         else:
-            sys.exit(restart(task_cfg))
+            sys.exit(restart(task_cfgs))
     elif args.command == "exec":
         try:
-            task, task_cfg = get_task_config(args.task, args.config)
+            _, task_cfgs = get_task_config(args.task, args.config)
         except Exception as e:
             sp_exec.error(str(e))
-        sys.exit(execute(task_cfg))
+        sys.exit(execute(task_cfgs[0]))
     elif args.command in ["stop", "status"]:
         sp = sp_stop if args.command == "stop" else sp_status
+        meta_paths = []
+
+        # Collect meta paths from --all
+        if args.all:
+            meta_paths.extend(get_meta_paths(DEFAULT_META_DIR))
+
+        # Collect meta paths from --meta-file
         if args.meta_file:
-            meta_path = args.meta_file
-        else:
-            if args.task:
-                task = args.task
-            else:
-                try:
-                    task, _ = get_task_config(args.task, args.config)
-                except Exception as e:
-                    sp.error(str(e))
-            meta_path = META_PATH_TEMPLATE.format(task=task)
+            meta_paths.append(args.meta_file)
+
+        # Collect meta paths from task names
+        if len(args.task) > 0:
+            tasks = args.task
+            meta_paths.extend([META_PATH_TEMPLATE.format(task=task) for task in tasks])
+
+        # If no meta paths collected, use default task
+        if len(meta_paths) == 0:
+            try:
+                tasks, _ = get_task_config(args.task, args.config)
+            except Exception as e:
+                sp.error(str(e))
+            meta_paths.extend([META_PATH_TEMPLATE.format(task=task) for task in tasks])
+
+        # Remove duplicates
+        unique_meta_paths = sorted(set(Path(p).resolve() for p in meta_paths))
+
         if args.command == "stop":
-            sys.exit(stop(meta_path))
+            sys.exit(stop(unique_meta_paths))
         else:
-            sys.exit(status(meta_path))
+            sys.exit(status(unique_meta_paths))
     elif args.command == "list":
         dir = args.dir or DEFAULT_META_DIR
         sys.exit(list_processes(dir, args.full))
@@ -260,7 +307,7 @@ def main():
             rotate_log_path=args.rotate_log_path
             or ROTATE_LOG_PATH_TEMPLATE.format(task=args.name),
         )
-        sys.exit(start(task_cfg))
+        sys.exit(start([task_cfg]))
     else:
         parser.print_help()
         sys.exit(1)

{python_dmon-0.2.3 → python_dmon-0.3.0}/src/dmon/config.py

@@ -1,6 +1,6 @@
 import sys
 from pathlib import Path
-from typing import Dict, Optional, cast
+from typing import Dict, List, Optional, Sequence, Tuple, Union, cast
 
 if sys.version_info >= (3, 11):
     import tomllib
@@ -121,9 +121,12 @@ def validate_task(task, name: str) -> DmonTaskConfig:
             ret.log_rotate = task["log_rotate"]
 
         if "log_max_size" in task:
-            if not isinstance(task["log_max_size"], int) or task["log_max_size"] <= 0:
+            if (
+                not isinstance(task["log_max_size"], (int, float))
+                or task["log_max_size"] <= 0
+            ):
                 raise TypeError(
-                    f"Task '{name}' 'log_max_size' field must be a positive integer"
+                    f"Task '{name}' 'log_max_size' field must be a positive number"
                 )
             ret.log_max_size = task["log_max_size"]
 
@@ -136,11 +139,11 @@ def validate_task(task, name: str) -> DmonTaskConfig:
 
         if "rotate_log_max_size" in task:
             if (
-                not isinstance(task["rotate_log_max_size"], int)
+                not isinstance(task["rotate_log_max_size"], (int, float))
                 or task["rotate_log_max_size"] <= 0
             ):
                 raise TypeError(
-                    f"Task '{name}' 'rotate_log_max_size' field must be a positive integer"
+                    f"Task '{name}' 'rotate_log_max_size' field must be a positive number"
                 )
             ret.rotate_log_max_size = task["rotate_log_max_size"]
 
@@ -155,11 +158,14 @@ def validate_task(task, name: str) -> DmonTaskConfig:
     return ret
 
 
-def get_task_config(name: Optional[str], cfg_path: Optional[str]):
+def get_task_config(
+    names: Union[Sequence[str], str, None], cfg_path: Optional[str], all: bool = False
+) -> Tuple[Sequence[str], List[DmonTaskConfig]]:
     """
-    Get the validated task configuration for the given task name.
-    If name is None or empty, and there is only one task, return that task; otherwise, raise ValueError.
-    If the task is not found, or required fields are missing, raise TypeError or ValueError.
+    Get the validated task configurations for the given task names.
+    If 'all' is True, return all tasks.
+    If no name specified, and there is only one task, return that task; otherwise, raise ValueError.
+    If any task is not found, or required fields are missing, raise TypeError or ValueError.
 
     The config is loaded from the given path, or searched for dmon.yaml or pyproject.toml.
     """
@@ -169,23 +175,35 @@ def get_task_config(name: Optional[str], cfg_path: Optional[str]):
     if not isinstance(tasks, dict):
         raise TypeError("'tasks' must be a table")
 
-    name = name or cfg.get("default_task", None)
-
-    if not name:
-        if len(tasks) == 0:
-            raise ValueError(f"No task found in {path}")
-        elif len(tasks) == 1:
-            name = next(iter(tasks))
+    if all:
+        names = list(tasks.keys())
+    elif isinstance(names, str):
+        names = [names]
+    elif names is None or len(names) == 0:
+        default_task_name = cfg.get("default_task", None)
+        if default_task_name:
+            if not isinstance(default_task_name, str):
+                raise TypeError("'default_task' must be a string")
+            names = [default_task_name]
         else:
-            raise ValueError(f"Multiple tasks found in {path}; please specify one.")
-    else:
+            if len(tasks) == 0:
+                raise ValueError(f"No task found in {path}")
+            elif len(tasks) == 1:
+                name = next(iter(tasks))
+                assert isinstance(name, str)
+                names = [name]
+            else:
+                raise ValueError(f"Multiple tasks found in {path}; please specify one.")
+
+    ret_tasks = []
+    for name in names:
         name = name.lower()
         if name not in tasks:
             raise ValueError(f"Task '{name}' not found in {path}")
 
-    assert isinstance(name, str)
-    task = validate_task(tasks[name], name)
-    return name, task
+        task = validate_task(tasks[name], name)
+        ret_tasks.append(task)
+    return names, ret_tasks
 
 
 def check_name_in_config(name: str) -> bool:

{python_dmon-0.2.3 → python_dmon-0.3.0}/src/dmon/control.py

@@ -6,7 +6,7 @@ import signal
 import sys
 import subprocess
 import time
-from typing import List
+from typing import List, Sequence
 
 import psutil
 from termcolor import colored
@@ -33,7 +33,17 @@ def ensure_log_dir(log_path: Path):
     log_path.parent.mkdir(parents=True, exist_ok=True)
 
 
-def start(cfg: DmonTaskConfig):
+def start(cfgs: Sequence[DmonTaskConfig]):
+    ret = 0
+    for idx, cfg in enumerate(cfgs):
+        # non-zero if any start() fails
+        ret |= start_single(cfg)
+        if idx < len(cfgs) - 1:
+            print("---", file=sys.stderr)  # print a blank line between tasks
+    return ret
+
+
+def start_single(cfg: DmonTaskConfig):
     meta_path = Path(cfg.meta_path).resolve()
     log_path = Path(cfg.log_path).resolve()
     cwd = Path(cfg.cwd).resolve()
@@ -166,7 +176,17 @@ def start(cfg: DmonTaskConfig):
     return 0
 
 
-def stop(
+def stop(meta_paths: Sequence[PathType], timeout=5.0):
+    ret = 0
+    for idx, meta_path in enumerate(meta_paths):
+        # non-zero if any stop() fails
+        ret |= stop_single(meta_path=meta_path, timeout=timeout)
+        if idx < len(meta_paths) - 1:
+            print(file=sys.stderr)  # print a blank line between tasks
+    return ret
+
+
+def stop_single(
     meta_path: PathType,
     timeout=5.0,
 ):
@@ -345,33 +365,41 @@ def terminate_win(proc: psutil.Process, timeout):
 
 
 def restart(
-    cfg: DmonTaskConfig,
+    cfgs: Sequence[DmonTaskConfig],
     timeout=5.0,
 ):
-    stop(cfg.meta_path, timeout)
+    meta_paths = [cfg.meta_path for cfg in cfgs]
+    stop(meta_paths, timeout=timeout)
     print("--- Restarting ---", file=sys.stderr)
-    return start(cfg)
+    return start(cfgs)
 
 
-def status(meta_path: PathType):
-    meta_path = Path(meta_path).resolve()
-    meta = DmonMeta.load(meta_path)
-    if meta is None:
-        print(
-            colored(
-                "Status failed: meta file not found (maybe not started)\n",
-                color="red",
-                attrs=["bold"],
+def status(meta_paths: Sequence[PathType]):
+    ret = 0
+    metas = []
+    for idx, meta_path in enumerate(meta_paths):
+        meta_path = Path(meta_path).resolve()
+        meta = DmonMeta.load(meta_path)
+        if meta is None:
+            print(
+                colored(
+                    "Status failed: meta file not found (maybe not started)\n",
+                    color="red",
+                    attrs=["bold"],
+                )
+                + str(meta_path),
+                file=sys.stderr,
             )
-            + str(meta_path),
-            file=sys.stderr,
-        )
-        return 1
-
-    print_status(meta)
-    print("\nProcess Tree:", file=sys.stderr)
-    print_process_table([meta])
-    return 0
+            ret |= 1
+        else:
+            print_status(meta)
+            metas.append(meta)
+        if idx < len(meta_paths) - 1:
+            print("---", file=sys.stderr)
+    if metas:
+        print("\nProcess Tree:", file=sys.stderr)
+        print_process_table(metas)
+    return ret
 
 
 def check_same_process(proc: psutil.Process, create_time: float) -> bool:
@@ -523,14 +551,23 @@ def print_process_table(metas: List[DmonMeta], full_width: bool = False):
     return processes
 
 
-def list_processes(dir: PathType, full_width: bool):
+def get_meta_paths(dir: PathType) -> List[Path]:
     target_dmon_dir = Path(dir).resolve()
-    metas: List[DmonMeta] = []
+    meta_paths: List[Path] = []
     if target_dmon_dir.exists() and target_dmon_dir.is_dir():
         for meta_file in target_dmon_dir.glob(f"*{META_SUFFIX}"):
-            meta = DmonMeta.load(meta_file)
-            if meta is not None:
-                metas.append(meta)
+            meta_paths.append(meta_file)
+    return meta_paths
+
+
+def list_processes(dir: PathType, full_width: bool):
+    target_dmon_dir = Path(dir).resolve()
+    meta_paths = get_meta_paths(target_dmon_dir)
+    metas = []
+    for meta_path in meta_paths:
+        meta = DmonMeta.load(meta_path)
+        if meta is not None:
+            metas.append(meta)
     # sort by name (case-insensitive)
     metas.sort(key=lambda m: m.task.lower())
     n_task = len(metas)

{python_dmon-0.2.3 → python_dmon-0.3.0}/src/dmon/runner.py

@@ -167,7 +167,7 @@ if __name__ == "__main__":
     parser.add_argument(
         "--max-log-size",
         help="Max log file size (MB); 0 for no rotation",
-        type=int,
+        type=float,
         default=5,
     )
     parser.add_argument(
@@ -178,15 +178,15 @@ if __name__ == "__main__":
     parser.add_argument(
         "--max-rotate-log-size",
         help="Max file size (MB) for this rotation log; 0 for no rotation",
-        type=int,
+        type=float,
         default=5,
     )
     args = parser.parse_args()
     main(
         " ".join(args.command) if args.shell else args.command,
         args.log_path,
-        args.max_log_size * 1024 * 1024,
+        int(args.max_log_size * 1024 * 1024),
         args.rotate_log_path,
-        args.max_rotate_log_size * 1024 * 1024,
+        int(args.max_rotate_log_size * 1024 * 1024),
     )
     logger.info("Process finished.")

{python_dmon-0.2.3 → python_dmon-0.3.0}/src/dmon/types.py

@@ -31,11 +31,11 @@ class DmonTaskConfig:
     """Path to log file"""
     log_rotate: bool = False
     """Whether to rotate log file"""
-    log_max_size: int = 5
+    log_max_size: float = 5
     """Size in MB to rotate log file"""
     rotate_log_path: str = ""
     """Path to rotation log file"""
-    rotate_log_max_size: int = 5
+    rotate_log_max_size: float = 5
     """Size in MB to rotation log file"""
     meta_path: str = ""
     """Path to meta file"""