Skip to main content

A beautiful terminal UI dashboard for managing Python projects, virtual environments, and tasks.

Project description

🎯 TermBoard

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


TermBoard Tasks UI
TermBoard Settings UI

The Problem: "Why not just use a script?"

As developers, we often write Makefiles or bash scripts (like test.sh or lint.sh) to manage our project workflows. While scripts work, they have severe limitations:

  1. Context Switching: You have to remember the exact command or script name, type it out, and watch it vomit hundreds of lines of output into your terminal, erasing your history.
  2. Environment Hell: Did you remember to activate your virtual environment? Are you using uv, poetry, or conda? Running the wrong script in the wrong environment is a daily frustration.
  3. Discoverability: New developers joining your project don't know what scripts exist or what they do.

The Solution: TermBoard

TermBoard replaces your scripts with a persistent, interactive Terminal UI (TUI).

  • 🧠 Smart Environment Detection: TermBoard automatically detects if you are using uv, poetry, pipenv, or a standard .venv, and executes your tasks in the correct environment—no manual activation required.
  • Asynchronous Streaming: Tasks run asynchronously in the background. Their output is streamed directly into a beautiful, scrollable Rich Log window without freezing the UI or polluting your terminal history.
  • 🛠️ Fully Customizable: Define custom tasks in a termboard.toml file. Your team can clone the repo, run termboard, and instantly have a UI with clickable buttons for deploying, testing, and building.

Features

  • Project Info: Instantly see your project's version, python requirements, and virtual environment status.
  • Dependency Viewer: A clean data table of all your project's dependencies parsed directly from pyproject.toml.
  • Dynamic Tasks Engine: Clickable buttons for your workflows (e.g., pytest, ruff) that execute asynchronously.
  • In-App Settings: Override environment variables, add new custom tasks, and save configurations globally without leaving the terminal.

Installation

TermBoard is designed to be installed globally on your machine so you can run it inside any Python project.

Using uv (Recommended):

uv tool install termboard

Using pipx:

pipx install termboard

Quick Start

Navigate to any Python project directory and simply type:

termboard

(If you don't have any custom tasks defined, TermBoard will automatically provide defaults for testing and linting).

Project details


Download files

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

Source Distribution

termboard-0.1.2.tar.gz (6.5 MB view details)

Uploaded Source

Built Distribution

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

termboard-0.1.2-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for termboard-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f8fe923e1870f62ecd1b02b37bcc698e71cb65ee91a453490ca989535f218364
MD5 12bd50540dde544b542d5d5455d489c8
BLAKE2b-256 eb35d996cff6c7f255454e0fa3407fb8f96fcd1d5d8b54cc6ef878d0163d7782

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on HeyShinde/TermBoard

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

File details

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

File metadata

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

File hashes

Hashes for termboard-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 649eb19183deb76d5c2d7362b2dda30d23cb2abde68cec3bb77162bc3eff128c
MD5 9d40979554916f89e6b25bf6130b425b
BLAKE2b-256 7955744d6d53a45d88741c7979e73e82a35e1b4f6a0826bd002455229f6ac611

See more details on using hashes here.

Provenance

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

Publisher: publish.yml on HeyShinde/TermBoard

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page