Skip to content

marcelofpfelix/dboard

Repository files navigation

dboard

dboard is a terminal dashboard, using python's textualize/rich library and inspired by wtfutil/wtf.

Allows to execute multiple commands, configured with a simple YAML file, and display the data output. Useful a way to visualize and monitor stats, systems changes, and service status.

dboard

Usage

  • Clone this repo and run python3 -m dboard
    • A binary alternative is also available in releases
  • Edit the config file in ~/.config/dboard/config.yml
    • You can set a custom config path with dboard -c /path/config.yml

Features

  • execute multiple commands asynchronously
  • configure with a YAML file

Development

Run locally:

# make help
Usage:
  env            :  create venv and install dependencies locally
  app            :  run app locally
  req            :  update requirements.txt
  bin            :  create binary file
  lint           :  lint code
  help           :  show help message
# add dependecies
poetry add python rich PyYAML pydantic
poetry add --dev pytest coverage pytest-cov ruff black mypy types-PyYAML pre-commit
Dashboard alternatives: