Metadata-Version: 2.1
Name: dboard
Version: 0.3.0
Summary: A terminal dashboard
Author: Marcelo Félix
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic >=2.9.2
Requires-Dist: pyyaml >=6.0.2
Requires-Dist: rich >=13.9.2

# dboard

`dboard` is a terminal dashboard, using python's [textualize/rich](https://github.com/textualize/rich) library and inspired by [wtfutil/wtf](https://github.com/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](docs/img/example.gif)


### Usage

* Clone this repo and run `python3 -m dboard`
  * A binary alternative is also available in [releases](https://github.com/marcelofpfelix/dboard/releases/latest)
* Edit the config file in `~/.config/dboard/config.yml`
  * You can set a custom config path with `dboard -c /path/config.yml`

### Features

* [x] execute multiple commands asynchronously
* [x] configure with a YAML file


### Development

Run locally:

```yml
# 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
```

```sh
# add dependecies
uv add rich PyYAML pydantic
uv add --dev pytest coverage pytest-cov pytest-xdist ruff mypy types-PyYAML
```


##### Dashboard alternatives:

* [wtfutil/wtf](https://github.com/wtfutil/wtf)
* [sqshq/sampler](https://github.com/sqshq/sampler)
* [mum4k/termdash](https://github.com/mum4k/termdash)
* [fdehau/tui-rs](https://github.com/fdehau/tui-rs)
* [yaronn/blessed-contrib](https://github.com/yaronn/blessed-contrib)
