TermBoard

A beautiful, interactive terminal dashboard for Python projects, environments, and tasks.

Overview

TermBoard addresses common frustrations developers face when managing project workflows through scripts. Typically, the reliance on Makefiles or bash scripts leads to several issues:

1. Context Switching: Developers must remember specific commands or script names and manage extensive output, which can clutter terminal history.
2. Environment Management: Forgetting to activate the appropriate virtual environment (like uv, poetry, or conda) can lead to executing tasks in incorrect contexts.
3. Discoverability: New team members often struggle to understand available scripts and their functions.

Introducing TermBoard

TermBoard redefines workflow management with an interactive Terminal UI (TUI) that enhances usability and efficiency for Python projects:

• 🧠 Smart Environment Detection: Automatically detects the environment (e.g., uv, poetry, pipenv, or .venv) and executes tasks accordingly, minimizing manual setup.
• ⚡ Asynchronous Streaming: Runs tasks in the background while providing real-time output streaming in a user-friendly, scrollable log window, keeping the UI responsive and terminal history clean.
• 🛠️ Fully Customizable: Users can define custom tasks via a termboard.toml file, enabling their teams to clone the repository and access a tailored UI for deploying, testing, and building tasks immediately.

Key Features

• Project Info: Instantly view your project's version, Python requirements, and virtual environment status.
• Dependency Viewer: Displays a clear data table of all dependencies directly parsed from pyproject.toml.
• Dynamic Tasks Engine: Quick access to clickable buttons for workflows such as pytest and ruff, executing those tasks asynchronously for enhanced workflow management.
• In-App Settings: Allows overriding of environment variables, adding new custom tasks, and saving configurations globally without leaving the terminal.

Getting Started

TermBoard is designed for global installation on your machine, usable within any Python project. Simply navigate to your project directory and type:

termboard

If no custom tasks are defined, TermBoard will automatically provide default options for testing and linting.