devboard 0.2.0__tar.gz → 0.3.0__tar.gz

devboard-0.3.0/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+<!-- insertion marker -->
+## [0.3.0](https://github.com/pawamoy/devboard/releases/tag/0.3.0) - 2026-09-23
+
+<small>[Compare with 0.2.0](https://github.com/pawamoy/devboard/compare/0.2.0...0.3.0)</small>
+
+### Features
+
+- Render Rich content in modals ([fb2393e](https://github.com/pawamoy/devboard/commit/fb2393e75edc21b71e4684b82394f4516785499c) by Timothée Mazzucotelli).
+- Let columns report status bar progress ([08a6943](https://github.com/pawamoy/devboard/commit/08a6943c6ab66bde2699c116e22a1ab025c11f7a) by Timothée Mazzucotelli).
+- Add maximize/unmaximize keybinding to all columns ([8fd99d4](https://github.com/pawamoy/devboard/commit/8fd99d48d715189c5679cb97edb07806964738d5) by Timothée Mazzucotelli). [Issue-2](https://github.com/pawamoy/devboard/issues/2)
+- Allow collapsing/expanding column with keybinding ([51160e1](https://github.com/pawamoy/devboard/commit/51160e152a9bcbcc3a77ede5ee2878252b7a6946) by Timothée Mazzucotelli).
+- Add progress bar (scanning/fetching) ([34290ea](https://github.com/pawamoy/devboard/commit/34290ea4b1bfb04ac9560b47d5fbd0244034e5a6) by Timothée Mazzucotelli).
+
+### Bug Fixes
+
+- Update cache after each (batch) row operation ([25b1370](https://github.com/pawamoy/devboard/commit/25b13703240c94107146d1de2fcff7a20f16d6c3) by Timothée Mazzucotelli).
+- Emptied columns are collapsed ([6e49906](https://github.com/pawamoy/devboard/commit/6e49906ba1dcdb3cedc04d92909c838c4b9e1627) by Timothée Mazzucotelli).
+- Always encode in UTF8 ([fe0f17f](https://github.com/pawamoy/devboard/commit/fe0f17f8016b55c8edff96dbcba2d12975987511) by Timothée Mazzucotelli).
+- Support restoring cache with moved columns ([a014e82](https://github.com/pawamoy/devboard/commit/a014e82f49b4d3f3d47a0f5bf4d5edda1eacb5b0) by Timothée Mazzucotelli).
+- Identify projects by their paths, to avoid redundant work ([2708a80](https://github.com/pawamoy/devboard/commit/2708a80282ef5a37b9a1b62efa081542bd1ef39f) by Timothée Mazzucotelli).
+- Save to cache after each reload ([091a229](https://github.com/pawamoy/devboard/commit/091a2296ac968ba92ef562b50eb4b67db4165114) by Timothée Mazzucotelli).
+
+### Code Refactoring
+
+- Let each board declare its own bindings ([cf7a6a9](https://github.com/pawamoy/devboard/commit/cf7a6a928a6fb50bc50d4caa5d010117305e8eae) by Timothée Mazzucotelli).
+- Declare keybindings with Textual actions ([5b1ec54](https://github.com/pawamoy/devboard/commit/5b1ec548daf2fc3c5db6171f35a1c680fa91b429) by Timothée Mazzucotelli).
+- Generalize refresh/force-refresh ([342ef55](https://github.com/pawamoy/devboard/commit/342ef552ccbf3e151750ef44800fe68d0f6f8e20) by Timothée Mazzucotelli).
+- Make columns generic ([6532042](https://github.com/pawamoy/devboard/commit/6532042da615c7f9c54ffa1cd9f713db552c77c3) by Timothée Mazzucotelli).
+- Restructure app to separate concerns ([c11b897](https://github.com/pawamoy/devboard/commit/c11b897a3a5e45aad0e78b9c7a6749e0bbed7e91) by Timothée Mazzucotelli).
+
+## [0.2.0](https://github.com/pawamoy/devboard/releases/tag/0.2.0) - 2026-09-10
+
+<small>[Compare with 0.1.0](https://github.com/pawamoy/devboard/compare/0.1.0...0.2.0)</small>
+
+The project is update to support latest version of Textual.
+
+### Bug Fixes
+
+- Prevent event propagation from modal ([e61eadd](https://github.com/pawamoy/devboard/commit/e61eaddaca58f91c02150c2f11465fcb82d576d1) by Timothée Mazzucotelli).
+- Fix script entrypoint ([acb054d](https://github.com/pawamoy/devboard/commit/acb054d11395861c34a60e2a60711379a3b48019) by Timothée Mazzucotelli).
+
+### Performance Improvements
+
+- Start faster (cache), scan faster ([9a740e5](https://github.com/pawamoy/devboard/commit/9a740e55aff8add3016b438d1b0912376a5552aa) by Timothée Mazzucotelli).
+
+## [0.1.0](https://github.com/pawamoy/devboard/releases/tag/0.1.0) - 2025-11-08
+
+<small>[Compare with first commit](https://github.com/pawamoy/devboard/compare/286120e957168a9162d5a8dc19c7dd72fb0a6d65...0.1.0)</small>
+
+### Features
+
+- Release Insiders project to the public ([ce7aad4](https://github.com/pawamoy/devboard/commit/ce7aad4c6c2da3924aebcf143f3a0d1068573297) by Timothée Mazzucotelli).
+
+### Code Refactoring
+
+- Update imports ([976e578](https://github.com/pawamoy/devboard/commit/976e57897d92431c60f510efbe6d8be5516747cd) by Timothée Mazzucotelli).
+- Move submodules under internal folder ([9ec90e1](https://github.com/pawamoy/devboard/commit/9ec90e11392d86022213e7dc4cfcfd520fa7783c) by Timothée Mazzucotelli).

{devboard-0.2.0 → devboard-0.3.0}/CONTRIBUTING.md

@@ -38,6 +38,7 @@ As usual:
 1. run `make format` to auto-format the code
 1. run `make check` to check everything (fix any warning)
 1. run `make test` to run the tests (fix any issue)
+1. if you changed the terminal layout, run `.venv/bin/pytest tests/test_snapshots.py -c config/pytest.ini --snapshot-update` and review the updated SVG files
 1. if you updated the documentation or the project dependencies:
     1. run `make docs`
     1. go to http://localhost:8000 and check that everything looks good

{devboard-0.2.0 → devboard-0.3.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: devboard
-Version: 0.2.0
-Summary: A development dashboard for your projects.
+Version: 0.3.0
+Summary: A development dashboard for projects, issues, pull requests, and other work.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License-Expression: ISC
 License-File: LICENSE
@@ -28,7 +28,7 @@ Project-URL: Discussions, https://github.com/pawamoy/devboard/discussions
 Project-URL: Gitter, https://gitter.im/devboard/community
 Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.10
-Requires-Dist: textual>=0.40
+Requires-Dist: textual>=8.2
 Requires-Dist: gitpython>=3.1
 Requires-Dist: appdirs>=1.4.4
 Requires-Dist: tomli>=2.0; python_version < "3.11"
@@ -41,7 +41,7 @@ Description-Content-Type: text/markdown
 [![pypi version](https://img.shields.io/pypi/v/devboard.svg)](https://pypi.org/project/devboard/)
 [![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#devboard:gitter.im)
 
-A development dashboard for your projects.
+A development dashboard for projects, issues, pull requests, and other work.
 
 ## Installation
 

{devboard-0.2.0 → devboard-0.3.0}/README.md

@@ -5,7 +5,7 @@
 [![pypi version](https://img.shields.io/pypi/v/devboard.svg)](https://pypi.org/project/devboard/)
 [![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#devboard:gitter.im)
 
-A development dashboard for your projects.
+A development dashboard for projects, issues, pull requests, and other work.
 
 ## Installation
 

{devboard-0.2.0 → devboard-0.3.0}/config/pytest.ini

@@ -12,5 +12,7 @@ filterwarnings =
   error
   default::EncodingWarning
   error::EncodingWarning:devboard
+  # pytest-textual-snapshot 1.1 uses datetime.utcnow while building a failure report.
+  ignore:datetime.datetime.utcnow\(\) is deprecated.*:DeprecationWarning:pytest_textual_snapshot
   # TODO: remove once pytest-xdist 4 is released
   ignore:.*rsyncdir:DeprecationWarning:xdist

{devboard-0.2.0 → devboard-0.3.0}/docs/examples/columns/commit.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 from pathlib import Path
 
+from devboard import Board
 from devboard._internal.default_board import ToCommit
 from devboard._internal.projects import Project as BaseProject
 
@@ -11,15 +12,15 @@ BASE_DIR = Path(os.environ["PROJECTS_DIR"])
 
 class Project(BaseProject):
     @classmethod
-    def list_projects(cls):
+    def list_items(cls):
         for filedir in BASE_DIR.iterdir():
             if filedir.is_dir() and filedir.joinpath(".git").is_dir():
                 yield cls(filedir)
 
 
 class ToCommit(ToCommit):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
-columns = [ToCommit]
+board = Board([ToCommit])

{devboard-0.2.0 → devboard-0.3.0}/docs/examples/columns/commit_pull.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 from pathlib import Path
 
+from devboard import Board
 from devboard._internal.default_board import ToCommit, ToPull
 from devboard._internal.projects import Project as BaseProject
 
@@ -11,20 +12,20 @@ BASE_DIR = Path(os.environ["PROJECTS_DIR"])
 
 class Project(BaseProject):
     @classmethod
-    def list_projects(cls):
+    def list_items(cls):
         for filedir in BASE_DIR.iterdir():
             if filedir.is_dir() and filedir.joinpath(".git").is_dir():
                 yield cls(filedir)
 
 
 class ToCommit(ToCommit):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
 class ToPull(ToPull):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
-columns = [ToCommit, ToPull]
+board = Board([ToCommit, ToPull])

{devboard-0.2.0 → devboard-0.3.0}/docs/examples/columns/commit_pull_push.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 from pathlib import Path
 
+from devboard import Board
 from devboard._internal.default_board import ToCommit, ToPull, ToPush
 from devboard._internal.projects import Project as BaseProject
 
@@ -11,25 +12,25 @@ BASE_DIR = Path(os.environ["PROJECTS_DIR"])
 
 class Project(BaseProject):
     @classmethod
-    def list_projects(cls):
+    def list_items(cls):
         for filedir in BASE_DIR.iterdir():
             if filedir.is_dir() and filedir.joinpath(".git").is_dir():
                 yield cls(filedir)
 
 
 class ToCommit(ToCommit):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
 class ToPull(ToPull):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
 class ToPush(ToPush):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
-columns = [ToCommit, ToPull, ToPush]
+board = Board([ToCommit, ToPull, ToPush])

devboard-0.3.0/docs/examples/columns/commit_pull_push_release.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+from devboard._internal.default_board import ProjectsBoard, ToCommit, ToPull, ToPush, ToRelease
+from devboard._internal.projects import Project as BaseProject
+
+BASE_DIR = Path(os.environ["PROJECTS_DIR"])
+
+
+class Project(BaseProject):
+    @classmethod
+    def list_items(cls):
+        for filedir in BASE_DIR.iterdir():
+            if filedir.is_dir() and filedir.joinpath(".git").is_dir():
+                yield cls(filedir)
+
+
+class ToCommit(ToCommit):
+    def list_items(self):
+        yield from Project.list_items()
+
+
+class ToPull(ToPull):
+    def list_items(self):
+        yield from Project.list_items()
+
+
+class ToPush(ToPush):
+    def list_items(self):
+        yield from Project.list_items()
+
+
+class ToRelease(ToRelease):
+    def list_items(self):
+        yield from Project.list_items()
+
+
+board = ProjectsBoard(
+    [ToCommit, ToPull, ToPush, ToRelease],
+    bindings=[
+        ("question_mark", "show_help", "Help"),
+        ("ctrl+q, q, escape", "exit", "Exit"),
+        ("ctrl+r", "refresh", "Refresh"),
+        ("ctrl+shift+r", "force_refresh", "Force refresh"),
+    ],
+    force_refresh_on_startup=True,
+)

{devboard-0.2.0 → devboard-0.3.0}/docs/examples/columns/notify.py

@@ -4,7 +4,8 @@ import os
 import time
 from pathlib import Path
 
-from devboard._internal.default_board import ToCommit, ToPull, ToPush, ToRelease
+from devboard import row_action
+from devboard._internal.default_board import ProjectsBoard, ToCommit, ToPull, ToPush, ToRelease
 from devboard._internal.projects import Project as BaseProject
 
 BASE_DIR = Path(os.environ["PROJECTS_DIR"])
@@ -12,22 +13,23 @@ BASE_DIR = Path(os.environ["PROJECTS_DIR"])
 
 class Project(BaseProject):
     @classmethod
-    def list_projects(cls):
+    def list_items(cls):
         for filedir in BASE_DIR.iterdir():
             if filedir.is_dir() and filedir.joinpath(".git").is_dir():
                 yield cls(filedir)
 
 
 class ToCommit(ToCommit):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
 class ToPull(ToPull):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
-    def apply(self, action, row):
+    @row_action
+    def action_pull(self, row):
         project, branch, _ = row.data
         message = f"Pulling branch [i]{branch}[/] in [i]{project}[/]"
         if not project.is_dirty:
@@ -51,13 +53,22 @@ class ToPull(ToPull):
 
 
 class ToPush(ToPush):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
 class ToRelease(ToRelease):
-    def list_projects(self):
-        yield from Project.list_projects()
-
-
-columns = [ToCommit, ToPull, ToPush, ToRelease]
+    def list_items(self):
+        yield from Project.list_items()
+
+
+board = ProjectsBoard(
+    [ToCommit, ToPull, ToPush, ToRelease],
+    bindings=[
+        ("question_mark", "show_help", "Help"),
+        ("ctrl+q, q, escape", "exit", "Exit"),
+        ("ctrl+r", "refresh", "Refresh"),
+        ("ctrl+shift+r", "force_refresh", "Force refresh"),
+    ],
+    force_refresh_on_startup=True,
+)

{devboard-0.2.0 → devboard-0.3.0}/docs/examples/columns/pull.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 from pathlib import Path
 
+from devboard import Board
 from devboard._internal.default_board import ToPull
 from devboard._internal.projects import Project as BaseProject
 
@@ -11,15 +12,15 @@ BASE_DIR = Path(os.environ["PROJECTS_DIR"])
 
 class Project(BaseProject):
     @classmethod
-    def list_projects(cls):
+    def list_items(cls):
         for filedir in BASE_DIR.iterdir():
             if filedir.is_dir() and filedir.joinpath(".git").is_dir():
                 yield cls(filedir)
 
 
 class ToPull(ToPull):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
-columns = [ToPull]
+board = Board([ToPull])

{devboard-0.2.0 → devboard-0.3.0}/docs/examples/columns/push.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 from pathlib import Path
 
+from devboard import Board
 from devboard._internal.default_board import ToPush
 from devboard._internal.projects import Project as BaseProject
 
@@ -11,15 +12,15 @@ BASE_DIR = Path(os.environ["PROJECTS_DIR"])
 
 class Project(BaseProject):
     @classmethod
-    def list_projects(cls):
+    def list_items(cls):
         for filedir in BASE_DIR.iterdir():
             if filedir.is_dir() and filedir.joinpath(".git").is_dir():
                 yield cls(filedir)
 
 
 class ToPush(ToPush):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
-columns = [ToPush]
+board = Board([ToPush])

{devboard-0.2.0 → devboard-0.3.0}/docs/examples/columns/release.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import os
 from pathlib import Path
 
+from devboard import Board
 from devboard._internal.default_board import ToRelease
 from devboard._internal.projects import Project as BaseProject
 
@@ -11,15 +12,15 @@ BASE_DIR = Path(os.environ["PROJECTS_DIR"])
 
 class Project(BaseProject):
     @classmethod
-    def list_projects(cls):
+    def list_items(cls):
         for filedir in BASE_DIR.iterdir():
             if filedir.is_dir() and filedir.joinpath(".git").is_dir():
                 yield cls(filedir)
 
 
 class ToRelease(ToRelease):
-    def list_projects(self):
-        yield from Project.list_projects()
+    def list_items(self):
+        yield from Project.list_items()
 
 
-columns = [ToRelease]
+board = Board([ToRelease])

devboard-0.3.0/docs/examples/screenshot.py

@@ -0,0 +1,75 @@
+import asyncio
+import hashlib
+import inspect
+import os
+from collections.abc import Hashable
+from pathlib import Path
+from tempfile import gettempdir
+
+from textual.pilot import Pilot
+
+from devboard import Devboard
+
+TMP_DIR = Path(gettempdir(), "devboard")
+SCREENSHOT_CACHE = TMP_DIR / "screenshots"
+REPOSITORIES_DIR = TMP_DIR / "repositories"
+PROJECTS_DIR = TMP_DIR / "projects"
+SCREENSHOT_SOURCE = Path("docs/examples/screenshot.py")
+
+
+def _get_cache_key(path: Path, *args: Hashable, **kwargs: Hashable) -> str:
+    hash = hashlib.md5()  # noqa: S324
+    package_dir = Path(inspect.getfile(Devboard)).parent
+    sources = [path, SCREENSHOT_SOURCE, *sorted(package_dir.glob("*.py")), *sorted(package_dir.glob("*.tcss"))]
+    for source in sources:
+        hash.update(source.read_bytes())
+    hash.update(f"{args}-{kwargs}".encode("utf-8"))
+    return f"{hash.hexdigest()}.svg"
+
+
+def screenshot(
+    board: str,
+    size: tuple[int, int] = (80, 24),
+    press: tuple[str, ...] = (),
+    env: tuple[tuple[str, str], ...] = (),
+) -> str:
+    """Render a documentation example as an SVG screenshot."""
+    path = Path("docs/examples", board).with_suffix(".py")
+    SCREENSHOT_CACHE.mkdir(parents=True, exist_ok=True)
+
+    screenshot_path = SCREENSHOT_CACHE / _get_cache_key(path, size, press, env)
+    if screenshot_path.exists():
+        return screenshot_path.read_text(encoding="utf-8")
+
+    environment = {"PROJECTS_DIR": str(PROJECTS_DIR), **dict(env)}
+    previous_environment = {name: os.environ.get(name) for name in environment}
+    os.environ.update(environment)
+    try:
+        app = Devboard(board=path, background_tasks=False)
+        svg = _take_svg_screenshot(app, size=size, press=press)
+        screenshot_path.write_text(svg, encoding="utf-8")
+        return svg
+    finally:
+        for name, value in previous_environment.items():
+            if value is None:
+                os.environ.pop(name, None)
+            else:
+                os.environ[name] = value
+
+
+def _take_svg_screenshot(app: Devboard, *, size: tuple[int, int], press: tuple[str, ...]) -> str:
+    """Run an app headlessly and export its final screen."""
+
+    async def capture(pilot: Pilot) -> None:
+        await pilot.pause()
+        await asyncio.wait_for(pilot.app.workers.wait_for_complete(), timeout=30)
+        if press:
+            await pilot.press(*press)
+        await pilot.wait_for_scheduled_animations()
+        await pilot.pause()
+        pilot.app.exit(pilot.app.export_screenshot())
+
+    svg = app.run(headless=True, size=size, auto_pilot=capture)
+    if not isinstance(svg, str):
+        raise TypeError("The screenshot run ended without SVG output")
+    return svg

{devboard-0.2.0 → devboard-0.3.0}/docs/index.md

@@ -11,9 +11,12 @@ hide:
 Devboard displays columns stacked horizontally, like a Kanban board.
 Each column is a "To Do Something" and presents information in a data table.
 Data tables have a header line with labels, and multiple rows
-presenting the information collected in your projects.
-Projects are supposed to be Git repositories from which we can collect information
-such as status, commits, branches, tags, etc.
+presenting information collected from source items. An item can be a project,
+an issue, a pull request, or an object from another provider.
+The default board uses Git projects and collects their status, commits,
+branches, and tags.
+
+Press ++ctrl+r++ to scan the current project data again. Press ++ctrl+shift+r++ to fetch and then scan each project.
 
 To start using Devboard, try to run the `devboard` command
 in your terminal. It will show you a default board with four columns:
@@ -142,4 +145,4 @@ Finally, you can also pass a path to a board module:
 
 ```bash
 devboard ./path/to/myboard.py
-```
+```