Skip to main content

A simple system monitor in Python, using Textual

Project description

Textual System Monitor

A beautiful system monitoring terminal app created in Python, using Textual.

This is the main page, where you can see live-updating readouts for all system stats:

Somewhat Feature Complete Design

Note: Personal info has been censored. Screenshot from Windows.

Getting Started

This is a terminal app, so you should have a terminal to use and knowledge of how to use it.

You should have Python >= 3.12 and Pipx.

Easily install with Pipx because this is a standalone package not intended to be used in a larger app.

  pipx install textual-system-monitor

Run with

  tsm

That's it!

You could probably also install with normal Pip if you wanted to.

Features

For this project, Windows is a first-class citizen and features are developed with Windows in mind. It also works on Linux (at least Ubuntu), but GPU information is not implemented.

  • All information live-updates. Some information updates slowly to be more performant. Other information, like CPU load, updates multiple times a second.
  • Percentages (indicating load) are color-coordinated according to certain thresholds. High percentages are red, medium percentages are yellow, and low percentages are green.
  • Quantities of bytes are automatically shown in human-readable formats, such as KiB and GiB. Can switch a kilobyte to be defined as 1000 bytes (KB) or 1024 bytes (KiB).
  • If the window is too small, all panes have vertical scroll bars, such as the one in the Processes section in this screenshot.
  • At any time, press q to exit the app. Crtl-C also works.
  • In-app Guide screen.
  • Each system stat has its own dedicated page that can be seen with by hitting the corresponding key, or by clicking the corresponding pane on the main screen.
  • Footer, which always show what keys can be pressed and what they do.
  • Header, which shows a clock.
  • Multiple colour themes!

Check out EXAMPLES.md for a guide on each screen.

Main Page Overview

The main page is the page that is shown when the app first starts and is the one in the above screenshot. It has simple views for all system stats.

Processes

The left-hand side shows information about current processes on the system. Shows the top 10 heaviest processes, as sorted by CPU load.

Stats

The right-hand side shows various system stats.

  • Drive Usage: Shows info on the current drives on your system. Includes both storage and media drives.
  • Memory Usage: Shows the current status of the system's memory.
  • CPU Usage: Shows the current load of each system core, as well as overall CPU load.
  • Network Info: Shows the status of each connected network interface.
  • GPU Info: Shows the status of the GPU.

Stack

  • Python (language)
  • UV (Python environment, package, and version manager)
  • Bash (shell. As this is a terminal app, the shell matters. I assume Bash throughout the app)
  • Textual (framework)
  • Pytest (test framework)
  • Ruff (linter and formatter)
  • Make (build tool/ command runner)
  • Just (optional command runner)

Desired Features

  • Make all panels live-update
  • Add CPU load info to Processes and sort by the highest load
  • Make certain panels searchable as necessary
  • Make panels clickable to open a new screen showing more info
  • Add GPU info
  • Add temperature info
  • Add support for Linux
  • Add support for macOS
  • Make all command-line duties possible in make
  • Add the ability to switch between 1000 and 1024-byte kilobytes

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

textual_system_monitor-1.0.6.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

textual_system_monitor-1.0.6-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file textual_system_monitor-1.0.6.tar.gz.

File metadata

  • Download URL: textual_system_monitor-1.0.6.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for textual_system_monitor-1.0.6.tar.gz
Algorithm Hash digest
SHA256 9c7b1a233acc4afd39acd10b5f193801878ee7be49c9160292b391504ded4107
MD5 1c6936f329819cc661f35be1985f7245
BLAKE2b-256 249a06484c549e804e3b85b7780d2f1208f22abde71540eff62b8eb05a8808d1

See more details on using hashes here.

File details

Details for the file textual_system_monitor-1.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for textual_system_monitor-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4d8fa9ce00ada64e06f33ef910f54a1cc1dadb0fa92432d6cc864a3913e2180a
MD5 5d44477d8da5291ecb5042e458c00689
BLAKE2b-256 71178e73e59ca51569babb0b3711c84dc9aa61a2ef5814683e4ba87afb80ba62

See more details on using hashes here.

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