Skip to main content

A terminal dashboard

Project description

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:

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

dboard-0.3.1.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

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

dboard-0.3.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file dboard-0.3.1.tar.gz.

File metadata

  • Download URL: dboard-0.3.1.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for dboard-0.3.1.tar.gz
Algorithm Hash digest
SHA256 23c46ba375cfbb067fea48d1a250e69fbb43597b495447cb2247553896e428f0
MD5 5826b611c11ed8babd3a1422d71195d0
BLAKE2b-256 aa25f7c1358b601f09c367c8d712155852d71ecfdf15133d423777150e8d8e5d

See more details on using hashes here.

File details

Details for the file dboard-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: dboard-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for dboard-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a3ff96421c4bc54dacda1a1dfef58d67fd9dd1b05fa167139884b945d02fb435
MD5 a97e202b8640081d3d8c9d3dcc7941a0
BLAKE2b-256 cdac657f4ce55c9fa96566bb84b8b7523fa76b6f7320436870a1a1ccd2cf204a

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