Skip to main content

Dashify

Dashify is a configurable terminal dashboard built with Textual. It arranges clocks, timers, todos, weather, and system information into nested horizontal and vertical tiles.

Requirements

  • Python 3.14 or 3.15
  • A terminal with mouse support and Unicode glyphs
  • Internet access for the Weather widget

Installation

Install uv, then install Dashify as an isolated command-line tool. uv will obtain a compatible Python interpreter when one is not already available:

uv tool install --python 3.14 dashify
dashify

If dashify is not found after installation, add uv's executable directory to your shell path and restart the shell:

uv tool update-shell

To install directly from a source checkout instead:

git clone https://github.com/Icecreambobcat/dashify.git
cd dashify
uv tool install --python 3.14 .

Upgrade or remove Dashify with:

uv tool upgrade dashify
uv tool uninstall dashify

Dashify loads ~/.config/dashify/dashify.toml when that file exists. Otherwise, it uses its packaged default configuration. From a source checkout, copy the documented default before customising your dashboard:

mkdir -p ~/.config/dashify
cp defaults/dashify.toml ~/.config/dashify/dashify.toml

Users who installed from PyPI can download the same versioned default:

mkdir -p ~/.config/dashify
curl -L https://raw.githubusercontent.com/Icecreambobcat/dashify/v0.1.0/defaults/dashify.toml \
  -o ~/.config/dashify/dashify.toml

Press Ctrl+Q to quit.

Configuration

The dashboard is a tree rooted at the [widgets] table. Every widget table requires a kind. HBox divides its space equally from left to right, while VBox divides its space equally from top to bottom. Any other nested table name is simply a readable identifier for a child.

[widgets]
kind = "HBox"

[widgets.left]
kind = "VBox"

[widgets.left.clock]
kind = "Clock"
opts = { timezone = "Australia/Sydney" }

[widgets.left.timer]
kind = "Timer"

[widgets.right]
kind = "VBox"

[widgets.right.weather]
kind = "Weather"
opts = { location = "Melbourne", units = "metric", refresh_minutes = 15 }

[widgets.right.todos]
kind = "Todo"

Only HBox and VBox treat named nested tables as children. Child tables on ordinary widgets are ignored. The optional opts value must be a TOML table; inline tables are preferred because they visually distinguish widget options from layout children.

Malformed roots produce a centred warning screen. An invalid child or invalid opts value produces a warning in that child's tile so that the rest of the dashboard remains usable.

The widget snippets below are child tables intended to be added beneath an HBox or VBox root such as the one in the complete example above.

Built-in widgets

Clock

Clock displays a 24-hour clock. It uses the local timezone by default. timezone accepts local, UTC, a UTC offset, or an IANA timezone name.

[widgets.clock]
kind = "Clock"
opts = { timezone = "Europe/London" }

Timer

Timer is a countdown with one Start/Stop/Reset button. While stopped, click the digits, enter up to six digits in HHMMSS order, and press Enter. Input is right-aligned, so 130 becomes 00:01:30. Invalid minutes and seconds are rejected. The border flashes yellow when the countdown finishes.

[widgets.timer]
kind = "Timer"

Stopwatch

Stopwatch provides Start, Stop, and Reset controls. Reset remains visible but is disabled while the stopwatch is running.

[widgets.stopwatch]
kind = "Stopwatch"

System monitor

SystemMonitor samples total CPU utilisation once per second. Its 38-sample history graph uses green, yellow, and red threshold colours.

[widgets.system_monitor]
kind = "SystemMonitor"

Weather

Weather uses Open-Meteo to display current conditions. No API key is needed. The default location is Sydney, units are metric, and the refresh interval is 15 minutes. units accepts metric or imperial; the Refresh button requests an immediate update.

[widgets.weather]
kind = "Weather"
opts = { location = "Perth", units = "metric", refresh_minutes = 10 }

The configured location is sent to Open-Meteo's geocoding and forecast APIs. Network and response errors are shown inside the widget without stopping the dashboard.

Todo

Todo stores a title, optional notes, and an optional ISO-format due date in a local SQLite database at ~/.local/state/dashify/todo.db. Todos remain in insertion order.

Select Manage todos to enter the widget's interaction context. Menus support the arrow keys and these Vim-inspired bindings:

  • j / k: move down / up
  • g / G: move to the first / last option
  • l or Enter: select
  • Esc: go back

Dashify asks before creating the database. Todo deletion and database deletion are permanent; deleting the database requires a separate warning screen.

[widgets.todos]
kind = "Todo"

Custom

Custom is a single-layer vertical arrangement. Its Boolean switches enable available elements in a fixed order; text adds a short heading and timezone configures an enabled clock. Each enabled widget otherwise retains its built-in defaults.

[widgets.focus]
kind = "Custom"
opts = { text = "Focus", clock = true, timezone = "UTC", timer = true, weather = true }

Available switches are clock, timer, stopwatch, system_monitor, todo, and weather. Horizontal custom layouts are intentionally unsupported; use an HBox in the main widget tree instead.

Development

Install the development dependencies and run all release checks with:

poetry install
poetry run black --check src tests
poetry run pyright
poetry run pytest
poetry check
poetry build

Source files live in src, tests in tests, and the documented default layout in defaults/dashify.toml.

Licence

Dashify is released under the MIT Licence. See LICENSE.

Download files

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

Source Distribution

dashify-0.1.2.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

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

dashify-0.1.2-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file dashify-0.1.2.tar.gz.

File metadata

  • Download URL: dashify-0.1.2.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dashify-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f59c1d0ba881f8338a2241115f4c78f3ba22f665af402d6e5c13c378be1c540f
MD5 f79d836037519d6cb50a0f7af5aaa47e
BLAKE2b-256 59192cbc26586c4e1fb2e03f0b83edd6cdc73ddd311c54a30066a852cf22134e

See more details on using hashes here.

Provenance

The following attestation bundles were made for dashify-0.1.2.tar.gz:

Publisher: release.yml on Icecreambobcat/dashify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dashify-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: dashify-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 24.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dashify-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3532599979690087cd89b6821662b4d601cff13b454b8360914e5237645d8728
MD5 a48d2ec3a4380430efacd506e0eec77f
BLAKE2b-256 80c0011daa824e24bba892b177244dc0c467213b32b4c8296aaae0d2ab9025d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for dashify-0.1.2-py3-none-any.whl:

Publisher: release.yml on Icecreambobcat/dashify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page