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

# > # virtual environment
python3 -m venv .venv
source .venv/bin/activate
# or simply use uv
# uvx dboard
# > # install
pip install dboard
dboard --help
  • 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:

  • Use source: clone this repo and run python3 -m dboard or make app
# 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
uv add rich PyYAML pydantic
uv add --dev pytest coverage pytest-cov pytest-xdist ruff mypy types-PyYAML
Dashboard alternatives:

About

A terminal dashboard

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •