python-dmon 0.2.2__tar.gz → 0.2.4__tar.gz

{python_dmon-0.2.2 → python_dmon-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: python-dmon
-Version: 0.2.2
+Version: 0.2.4
 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
@@ -38,13 +38,40 @@ 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
 
+`python-dmon` is available on [PyPI](https://pypi.org/project/python-dmon/):
+
 ```sh
 pip install python-dmon
 ```
 
+We recommend installing into an isolated environment, e.g., with `uv` / `pipx`:
+
+```sh
+# Install globally with uv tool
+uv tool install python-dmon
+
+# Or with pipx
+pipx install python-dmon
+
+# Add as a dev dependency in your project
+uv add --dev python-dmon
+```
+
+You can also invoke without installing:
+
+```sh
+# With uvx (uv tool run)
+uvx python-dmon
+
+# Or with pipx
+pipx run python-dmon
+```
+
 To get the latest features, install from source:
 
 ```sh
@@ -59,18 +86,20 @@ 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).
-See [Example Task Configuration](#example-task-configuration) for more configuration options.
+See [Example Configuration](#example-configuration) for more configuration options.
 
 
 ### Run tasks
@@ -91,7 +120,7 @@ dmon status app
 dmon exec app
 ```
 
-If only one task is defined in the config file, you can omit the task name:
+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
@@ -100,11 +129,12 @@ dmon status
 dmon exec
 ```
 
-You can use `--config` to specify a custom config file:
+You can use `--config` to specify a custom config file or the directory containing it:
 
 ```sh
 dmon start --config /path/to/dmon.yaml app  # YAML
 dmon start --config /path/to/pyproject.toml app  # or TOML
+dmon start --config /path/to/dir app  # dir with `dmon.y(a)ml` or `pyproject.toml`
 ```
 
 And yes, you can use `dmon` to run in a nested manner:
@@ -144,7 +174,7 @@ dmon list
 ```
 
 
-## Example Task Configuration
+## Example Configuration
 
 A task can be a **string**, **list**, or **dictionary**.
 
@@ -165,8 +195,23 @@ tasks:
     rotate_log_path: "logs/<task>.rotate.log"  # path to rotation log
     rotate_log_max_size: 5  # max rotation log file size in MB
     meta_path: ".dmon/<task>.meta.json"  # path to meta file
+default_task: your_task_name  # the default task name
+```
+
+In TOML, write like this:
+
+```toml
+[tool.dmon.tasks]
+your_task_name = { cmd = [
+  "python", "-u", "server.py"
+], ... }
+another_task = "cd subdir && ls && bash start.sh"
+
+[tool.dmon]
+default_task = "your_task_name"
 ```
 
+
 ## Under the Hood
 
 Each task is associated with a meta file (e.g. `.dmon/<task>.meta.json`) stored in the current working directory.

{python_dmon-0.2.2 → python_dmon-0.2.4}/README.md

@@ -20,13 +20,40 @@ 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
 
+`python-dmon` is available on [PyPI](https://pypi.org/project/python-dmon/):
+
 ```sh
 pip install python-dmon
 ```
 
+We recommend installing into an isolated environment, e.g., with `uv` / `pipx`:
+
+```sh
+# Install globally with uv tool
+uv tool install python-dmon
+
+# Or with pipx
+pipx install python-dmon
+
+# Add as a dev dependency in your project
+uv add --dev python-dmon
+```
+
+You can also invoke without installing:
+
+```sh
+# With uvx (uv tool run)
+uvx python-dmon
+
+# Or with pipx
+pipx run python-dmon
+```
+
 To get the latest features, install from source:
 
 ```sh
@@ -41,18 +68,20 @@ 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).
-See [Example Task Configuration](#example-task-configuration) for more configuration options.
+See [Example Configuration](#example-configuration) for more configuration options.
 
 
 ### Run tasks
@@ -73,7 +102,7 @@ dmon status app
 dmon exec app
 ```
 
-If only one task is defined in the config file, you can omit the task name:
+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
@@ -82,11 +111,12 @@ dmon status
 dmon exec
 ```
 
-You can use `--config` to specify a custom config file:
+You can use `--config` to specify a custom config file or the directory containing it:
 
 ```sh
 dmon start --config /path/to/dmon.yaml app  # YAML
 dmon start --config /path/to/pyproject.toml app  # or TOML
+dmon start --config /path/to/dir app  # dir with `dmon.y(a)ml` or `pyproject.toml`
 ```
 
 And yes, you can use `dmon` to run in a nested manner:
@@ -126,7 +156,7 @@ dmon list
 ```
 
 
-## Example Task Configuration
+## Example Configuration
 
 A task can be a **string**, **list**, or **dictionary**.
 
@@ -147,8 +177,23 @@ tasks:
     rotate_log_path: "logs/<task>.rotate.log"  # path to rotation log
     rotate_log_max_size: 5  # max rotation log file size in MB
     meta_path: ".dmon/<task>.meta.json"  # path to meta file
+default_task: your_task_name  # the default task name
+```
+
+In TOML, write like this:
+
+```toml
+[tool.dmon.tasks]
+your_task_name = { cmd = [
+  "python", "-u", "server.py"
+], ... }
+another_task = "cd subdir && ls && bash start.sh"
+
+[tool.dmon]
+default_task = "your_task_name"
 ```
 
+
 ## Under the Hood
 
 Each task is associated with a meta file (e.g. `.dmon/<task>.meta.json`) stored in the current working directory.

{python_dmon-0.2.2 → python_dmon-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-dmon"
-version = "0.2.2"
+version = "0.2.4"
 description = "A lightweight, cross-platform daemon manager that runs any command as a background process."
 readme = "README.md"
 authors = [
@@ -23,6 +23,7 @@ Changelog = "https://github.com/atomiechen/python-dmon/blob/main/CHANGELOG.md"
 
 [project.scripts]
 dmon = "dmon.__main__:main"
+python-dmon = "dmon.__main__:main"
 
 [build-system]
 requires = ["uv_build>=0.8.4,<0.9.0"]

{python_dmon-0.2.2 → python_dmon-0.2.4}/src/dmon/cli.py

@@ -191,7 +191,7 @@ def main():
     for sp in [sp_start, sp_stop, sp_restart, sp_status, sp_exec]:
         sp.add_argument(
             "--config",
-            help="Path to config file (YAML or TOML) (default: search from current directory upwards)",
+            help="Path to config file or the directory containing it (default: search from current directory upwards)",
         )
 
     args = parser.parse_args()

{python_dmon-0.2.2 → python_dmon-0.2.4}/src/dmon/config.py

@@ -10,6 +10,21 @@ else:
 from .types import CmdType, DmonTaskConfig
 
 
+def search_config(start_dir: Path, recursive: bool) -> Optional[Path]:
+    """
+    Search for dmon.yaml, dmon.yml, or pyproject.toml from the given directory upwards.
+    Return the path if found, None otherwise.
+    """
+    current = start_dir.resolve()
+    directories = [current] if not recursive else [current, *current.parents]
+    for parent in directories:
+        for filename in ["dmon.yaml", "dmon.yml", "pyproject.toml"]:
+            path = parent / filename
+            if path.is_file():
+                return path
+    return None
+
+
 def load_config(cfg_path: Optional[str] = None):
     """
     Load configuration from the given path, or search it from the current working directory upwards.
@@ -19,20 +34,20 @@ def load_config(cfg_path: Optional[str] = None):
         # Load configuration from the given path
         path = Path(cfg_path).resolve()
         if not path.exists():
-            raise FileNotFoundError(f"Config file '{path}' does not exist.")
+            raise FileNotFoundError(
+                f"Config file or directory '{path}' does not exist."
+            )
+        elif path.is_dir():
+            # If it's a directory, search for config files in it
+            result = search_config(path, recursive=False)
+            if not result:
+                raise FileNotFoundError(
+                    f"No dmon.yaml or pyproject.toml found in directory '{path}'."
+                )
+            path = result
     else:
-        # No path provided, search for config files
-        # starting from the current working directory upwards
-        current = Path.cwd().resolve()
-        path = None
-        for parent in [current, *current.parents]:
-            for filename in ["dmon.yaml", "dmon.yml", "pyproject.toml"]:
-                path = parent / filename
-                if path.is_file():
-                    break
-            else:
-                continue  # Only break out of the inner loop if a file was found
-            break  # Break out of the outer loop if a file was found
+        # No path provided, search from the current working directory upwards
+        path = search_config(Path.cwd(), recursive=True)
         if not path:
             raise FileNotFoundError(
                 "No dmon.yaml or pyproject.toml found in current or any parent directory."
@@ -106,9 +121,9 @@ 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"]
 
@@ -121,11 +136,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"]
 
@@ -154,6 +169,8 @@ 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}")

{python_dmon-0.2.2 → python_dmon-0.2.4}/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.2 → python_dmon-0.2.4}/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"""