Dashify 0.1.0__tar.gz

dashify-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Icecreambobcat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dashify-0.1.0/PKG-INFO

@@ -0,0 +1,251 @@
+Metadata-Version: 2.4
+Name: Dashify
+Version: 0.1.0
+Summary: A configurable terminal dashboard built with Textual.
+License-Expression: MIT
+License-File: LICENSE
+Keywords: dashboard,terminal,textual,tui
+Author: Icecreambobcat
+Author-email: icekingrex123@gmail.com
+Requires-Python: >=3.14,<3.16
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Utilities
+Requires-Dist: psutil (>=7.2.2,<8.0.0)
+Requires-Dist: pydantic (>=2.13.4,<3.0.0)
+Requires-Dist: textual (>=7.5.0,<8.0.0)
+Requires-Dist: tomlkit (>=0.15.0,<0.16.0)
+Project-URL: Issues, https://github.com/Icecreambobcat/dashify/issues
+Project-URL: Repository, https://github.com/Icecreambobcat/dashify
+Description-Content-Type: text/markdown
+
+# Dashify
+
+Dashify is a configurable terminal dashboard built with
+[Textual](https://textual.textualize.io/). 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](https://docs.astral.sh/uv/getting-started/installation/), then
+install Dashify as an isolated command-line tool. uv will obtain a compatible
+Python interpreter when one is not already available:
+
+```console
+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:
+
+```console
+uv tool update-shell
+```
+
+To install directly from a source checkout instead:
+
+```console
+git clone https://github.com/Icecreambobcat/dashify.git
+cd dashify
+uv tool install --python 3.14 .
+```
+
+Upgrade or remove Dashify with:
+
+```console
+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:
+
+```console
+mkdir -p ~/.config/dashify
+cp defaults/dashify.toml ~/.config/dashify/dashify.toml
+```
+
+Users who installed from PyPI can download the same versioned default:
+
+```console
+mkdir -p ~/.config/dashify
+curl -L https://raw.githubusercontent.com/Icecreambobcat/dashify/v0.1.0/defaults/dashify.toml \
+  -o ~/.config/dashify/dashify.toml
+```
+
+Press <kbd>Ctrl</kbd>+<kbd>Q</kbd> 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.
+
+```toml
+[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.
+
+```toml
+[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.
+
+```toml
+[widgets.timer]
+kind = "Timer"
+```
+
+### Stopwatch
+
+`Stopwatch` provides Start, Stop, and Reset controls. Reset remains visible but
+is disabled while the stopwatch is running.
+
+```toml
+[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.
+
+```toml
+[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.
+
+```toml
+[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.
+
+```toml
+[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.
+
+```toml
+[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:
+
+```console
+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`.
+

dashify-0.1.0/README.md

@@ -0,0 +1,228 @@
+# Dashify
+
+Dashify is a configurable terminal dashboard built with
+[Textual](https://textual.textualize.io/). 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](https://docs.astral.sh/uv/getting-started/installation/), then
+install Dashify as an isolated command-line tool. uv will obtain a compatible
+Python interpreter when one is not already available:
+
+```console
+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:
+
+```console
+uv tool update-shell
+```
+
+To install directly from a source checkout instead:
+
+```console
+git clone https://github.com/Icecreambobcat/dashify.git
+cd dashify
+uv tool install --python 3.14 .
+```
+
+Upgrade or remove Dashify with:
+
+```console
+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:
+
+```console
+mkdir -p ~/.config/dashify
+cp defaults/dashify.toml ~/.config/dashify/dashify.toml
+```
+
+Users who installed from PyPI can download the same versioned default:
+
+```console
+mkdir -p ~/.config/dashify
+curl -L https://raw.githubusercontent.com/Icecreambobcat/dashify/v0.1.0/defaults/dashify.toml \
+  -o ~/.config/dashify/dashify.toml
+```
+
+Press <kbd>Ctrl</kbd>+<kbd>Q</kbd> 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.
+
+```toml
+[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.
+
+```toml
+[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.
+
+```toml
+[widgets.timer]
+kind = "Timer"
+```
+
+### Stopwatch
+
+`Stopwatch` provides Start, Stop, and Reset controls. Reset remains visible but
+is disabled while the stopwatch is running.
+
+```toml
+[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.
+
+```toml
+[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.
+
+```toml
+[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.
+
+```toml
+[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.
+
+```toml
+[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:
+
+```console
+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`.

dashify-0.1.0/defaults/dashify.toml

@@ -0,0 +1,55 @@
+# The root layout has a timer and todos on the left. The right column nests a
+# clock and system monitor beside a stopwatch, above the weather widget.
+[widgets]
+kind = "Hbox"
+
+[widgets.left]
+kind = "Vbox"
+
+[widgets.right]
+kind = "Vbox"
+
+# A countdown timer. Click the digits while stopped, enter up to six digits in
+# HHMMSS order, then press Enter to confirm the duration.
+[widgets.left.timer]
+kind = "Timer"
+
+# Persistent local todos. Select Manage todos in the widget to create and use
+# the SQLite database at ~/.local/state/dashify/todo.db.
+[widgets.left.todo]
+kind = "Todo"
+
+# A vertical custom arrangement. Widget defaults remain in the app; uncomment
+# switches and text below to enable them in this one-layer custom widget.
+# [widgets.left.custom]
+# kind = "Custom"
+# opts = { text = "Focus time", clock = true, timezone = "Australia/Sydney", timer = true, stopwatch = true, system_monitor = true, todo = true, weather = true }
+
+# The right column's top tile places the clock and system monitor in one
+# vertical tile beside the stopwatch.
+[widgets.right.top]
+kind = "Hbox"
+
+# Widget defaults are supplied by the app. Uncomment opts below to override the
+# Clock's local timezone with "UTC", a UTC offset, or an IANA timezone name.
+[widgets.right.top.status]
+kind = "Vbox"
+
+[widgets.right.top.status.clock]
+kind = "Clock"
+# opts = { timezone = "UTC+0" }
+
+# A live CPU utilisation monitor. The graph retains the latest 38 samples,
+# updates once per second, and marks low, medium, and high load in green,
+# yellow, and red respectively.
+[widgets.right.top.status.system_monitor]
+kind = "SystemMonitor"
+
+# A stopwatch with Start, Stop, and Reset controls. It has no options yet.
+[widgets.right.top.stopwatch]
+kind = "Stopwatch"
+
+# Current weather for the app-supplied default location. Use inline opts to
+# override location, units (metric or imperial), or refresh_minutes.
+[widgets.right.weather]
+kind = "Weather"

dashify-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "Dashify"
+description = "A configurable terminal dashboard built with Textual."
+version = "0.1.0"
+authors = [
+    {name = "Icecreambobcat",email = "icekingrex123@gmail.com"}
+]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.14,<3.16"
+keywords = ["dashboard", "terminal", "textual", "tui"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Operating System :: OS Independent",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "textual (>=7.5.0,<8.0.0)",
+    "tomlkit (>=0.15.0,<0.16.0)",
+    "pydantic (>=2.13.4,<3.0.0)",
+    "psutil (>=7.2.2,<8.0.0)"
+]
+
+[project.urls]
+Repository = "https://github.com/Icecreambobcat/dashify"
+Issues = "https://github.com/Icecreambobcat/dashify/issues"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = [
+    "pytest (>=9.1.1,<10.0.0)",
+    "pyinstaller (>=6.22.2,<7.0.0)",
+    "pyright (>=1.1.411,<2.0.0)",
+    "black (>=26.5.1,<27.0.0)"
+]
+
+[project.scripts]
+dashify = "main:main"
+
+[tool.poetry]
+packages = [
+    { include = "main.py", from = "src" },
+    { include = "modules", from = "src" },
+]
+include = [
+    { path = "defaults/dashify.toml", format = ["sdist", "wheel"] },
+]
+
+[tool.black]
+target-version = ["py314"]

dashify-0.1.0/src/main.py

@@ -0,0 +1,13 @@
+import sys
+
+from modules.app import Dashify
+
+
+def main() -> int:
+    """Run Dashify and return a process-compatible exit code."""
+    exit_code = Dashify().run()
+    return int(exit_code) if exit_code is not None else 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

dashify-0.1.0/src/modules/app.py

@@ -0,0 +1,47 @@
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+from textual.containers import Container
+from textual.widgets import Footer, Header, Static
+
+from modules.composer import compose_from_config
+from modules.conf import make_config
+
+
+class Dashify(App):
+    """Compose and run the configured terminal dashboard."""
+
+    TITLE = "Dashify"
+    BINDINGS = [Binding("ctrl+q", "quit", "Quit", key_display="^q")]
+
+    DEFAULT_CSS = """
+    #config-warning-screen {
+        width: 1fr;
+        height: 1fr;
+        align: center middle;
+    }
+
+    #config-warning {
+        width: 50;
+        height: 5;
+        border: round $warning;
+        padding: 1;
+        color: $warning;
+        content-align: center middle;
+        text-align: center;
+    }
+    """
+
+    def compose(self) -> ComposeResult:
+        """Compose the configured layout or a recoverable warning screen."""
+        yield Header()
+        config = make_config()
+        if config is not None and (layout := compose_from_config(config)) is not None:
+            yield layout
+        else:
+            with Container(id="config-warning-screen"):
+                yield Static(
+                    "Configuration could not be loaded.\n"
+                    "Check dashify.toml and restart.",
+                    id="config-warning",
+                )
+        yield Footer()