Skip to main content

A lightweight, cross-platform daemon manager that runs any command as a background process.

Project description

python-dmon

GitHub PyPI

A lightweight, cross-platform daemon manager that runs any command — called a task — as a background process. It also supports logging and log rotation out of the box. No Docker or extra dependencies required.

Shipped as the CLI tool dmon. It is a Python-based and more powerful successor to the handy-backend shell scripts.

Features

  • 🖥️ Cross-platform: Works on Linux, macOS, and Windows.
  • Lightweight: Pure Python, no Docker or external dependencies needed.
  • 🧩 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.

Installation

pip install python-dmon

To get the latest features, install from source:

pip install git+https://github.com/atomiechen/python-dmon.git

Getting Started

Prepare Configuration

Create a dmon.yaml file:

tasks:
  app: ["python", "-u", "server.py"]

Or add to your pyproject.toml:

[tool.dmon.tasks]
app = ["python", "-u", "server.py"]

Commands can be a single string (run in shell), or list of strings (exec form). See Example Task Configuration for more configuration options.

Run tasks

Run a configured task by its name:

# Start a task
dmon start app

# Stop a running task
dmon stop app

# Check task status
dmon status app

# Execute a task in the foreground (useful for debugging)
dmon exec app

If only one task is defined in the config file, you can omit the task name:

dmon start
dmon stop
dmon status
dmon exec

You can use --config to specify a custom config file:

dmon start --config /path/to/dmon.yaml app  # YAML
dmon start --config /path/to/pyproject.toml app  # or TOML

And yes, you can use dmon to run in a nested manner:

tasks:
  app: ["python", "-u", "server.py"]
  nested: pwd && dmon exec app  # nest `dmon exec`
  subdir_task1:
    cwd: /path/to/dir
    cmd: ["dmon", "exec", "app"]  # run task defined in another folder
  subdir_task2: dmon exec app --config /path/to/dir/dmon.yaml  # like above

Run an ad-hoc command

# Run a command with arguments in the background
dmon run --name myserver python -u server.py

# Run a shell command in the background
dmon run --shell echo "Hello World"

# Run a shell script in the background
dmon run --cwd /path/to/script bash myscript.sh

[!NOTE] If no name is provided, dmon automatically assigns a fixed task name default_run to prevent duplicate runs.

List all running tasks

dmon list

Example Task Configuration

A task can be a string, list, or dictionary.

Here is a more complete example with default values:

tasks:
  your_task_name:
    # Command to run; can be a string (run in shell) or list of strings (exec form)
    cmd: ["python", "server.py"]  # required
    cwd: "/path/to/working/dir"  # (default: current dir)
    env:  # (default: inherit from parent process)
      PYTHONUNBUFFERED: "1"
    override_env: false  # override parent env and only use env defined here
    log_path: "logs/<task>.log" # path to log file
    log_rotate: false  # enable log rotation
    log_max_size: 5  # max log file size before rotation in MB
    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

Under the Hood

Each task is associated with a meta file (e.g. .dmon/<task>.meta.json) stored in the current working directory. The file contains details such as the command, PID, log path, and more. Do not modify or delete these files manually.

License

python-dmon © 2025 by Atomie CHEN is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_dmon-0.2.2.tar.gz (13.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_dmon-0.2.2-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file python_dmon-0.2.2.tar.gz.

File metadata

  • Download URL: python_dmon-0.2.2.tar.gz
  • Upload date:
  • Size: 13.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for python_dmon-0.2.2.tar.gz
Algorithm Hash digest
SHA256 a01ea6d5272236ff7acf585fe84f465b83ec44782f6541470b4f84777a781a92
MD5 9edf911557e8d38ee38c886d5c7f55f3
BLAKE2b-256 2db0e6d3292c5f10cfcb9c73475e31b3b90fb244db1cbc2cd8cf6f52ba19beca

See more details on using hashes here.

File details

Details for the file python_dmon-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: python_dmon-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for python_dmon-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 759c1163675943919c320268842a20a1640fc0b06e35130202989d149ca6ec3f
MD5 9dd5674ae4d1f12fd82fe81556ca95dc
BLAKE2b-256 2eeabc2889af220c8973245d0ffb89ab5937a20f71c1f8a48bc58cb68a778ee6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page