PyUdisk (Linux)

PyUdisk is a wrapper around the udisksctl command-line tool to generate a comprehensive list of all block devices and drives on a Linux machines.

Recommendations

For monitoring and reporting, use

pip install PyUdisk[standard]

For basic functionality, use

pip install PyUdisk

IDE

import pyudisk


if __name__ == '__main__':
    pyudisk.monitor()

CLI

pyudisk start

Use pyudisk --help for usage instructions.

Environment Variables

Sourcing environment variables from an env file

By default, PyUdisk will look for a .env file in the current working directory.

UDISK_LIB: Path to the udisksctl command-line tool. Default: /usr/bin/udisksctl
METRICS: List of metrics to monitor. Default: []
GMAIL_USER: Gmail username to authenticate SMTP library.
GMAIL_PASS: Gmail password to authenticate SMTP library.
RECIPIENT: Email recipient for email notifications.
PHONE: Phone number for SMS notifications.
NTFY_URL: URL for Ntfy notifications.
NTFY_TOPIC: Topic for Ntfy notifications.
NTFY_USERNAME: Username for Ntfy notifications.
NTFY_PASSWORD: Password for Ntfy notifications.
TELEGRAM_BOT_TOKEN: Telegram bot token for Telegram notifications.
TELEGRAM_CHAT_ID: Telegram chat ID for Telegram notifications.
TELEGRAM_THREAD_ID: Telegram thread ID for Telegram notifications.
DISK_REPORT: Boolean flag to send disk report via email.
REPORT_DIR: Directory to save disk reports. Default: report
REPORT_FILE: Filename for disk reports. Default format: disk_report_%m-%d-%Y_%I:%M_%p.html