Skip to main content

Extensive disk monitor for Linux OS

Project description

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.

Installation

Recommendations

  • Install python [3.10] or [3.11]
  • Use a dedicated [virtual environment]
pip install PyUdisk

Usage

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.

  • DISK_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

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

PyUdisk-0.0.1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file PyUdisk-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: PyUdisk-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for PyUdisk-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f96cb36b96dbd7469ba5bddada879143338b3031ad0b094b1c403fdadb414dec
MD5 b4fe09be346924751e2aa6c2c00473b3
BLAKE2b-256 ffda1d0346a7b7ec16d49012dc66d1f80a14345d1257948ee9fdb64332a3c543

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