🎯 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 links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.0.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for heyshinde from gravatar.com heyshinde

Credits

Author: Aditya Shinde

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License

Requires

Python >=3.13

Tags

dashboard python task-runner terminal textual tui virtual-environment

Classifiers

Report project as malware

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.1.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.1-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: termboard-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 de64b0a0226a7803d584b519f62f081eac90b0b01371d26c9126ee3e2625369f
MD5 0c6fe2f53bd18ebcb707cd017ac7f208
BLAKE2b-256 e749ae643ba9e20d303e51890e670d423d571f2a0f89c57dad9f0b13d71da61a

See more details on using hashes here.

Provenance

The following attestation bundles were made for termboard-0.1.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: termboard-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5703a1ce8a5ea8c30d1a723b9132b64a2c164cef936235573326c09201cd41c6
MD5 1b07329eb2581afa80297c94f285cf61
BLAKE2b-256 525e5e106d94804a383fad441f8772ddd62dee6045f78825a07c2d5cf8646b8d

See more details on using hashes here.

Provenance

The following attestation bundles were made for termboard-0.1.1-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