Skip to main content

A TUI network usage monitor.

Project description

Netwatch TUI (netwatchpy)

PyPI Version License: MIT

A TUI (Text-based User Interface) for monitoring network usage in real-time, with support for data limits and desktop notifications.


netwatch_demo


Features

  • Real-time Dashboard: A clean, terminal-based dashboard showing total download, upload, and current speeds.
  • Historical Analytics: View your usage trends for the last 24 hours with hourly breakdown, peak hour identification, and traffic statistics including download/upload percentages and average usage.
  • Crash-Proof Database: Powered by SQLite with Write-Ahead Logging (WAL) to ensure your data is safe even if your PC loses power.
  • Data Cap Monitoring: Set a data limit (e.g., 10GB) and see your usage on a real-time progress bar.
  • Standalone Binaries: Available as a single .exe or binary file, that way no Python installation is required but no.

Note: Double-clicking the file launches the Basic Monitor (all interfaces, no limit). To set Data Caps or Filters, run the file via Command Prompt/Terminal.

  • Smart Units: Toggle between Bits (Mbps) and Bytes (MB/s) instantly with Ctrl+B to match ISP speeds or file sizes.
  • Desktop Notifications: Get native desktop notifications when you hit 80% and 100% of your data limit.
  • Live Activity Log: An interactive, scrolling log of all network activity, updated every second.
  • Command Palette & Dark Mode: A modern TUI experience with a built-in command palette (Ctrl+P) and dark mode support (Ctrl+D).
  • Auto-Migration: Automatically detects and imports data from older versions (quota.json) so you never lose history.
  • Cross-Platform: Runs perfectly on Windows, macOS, and Linux.

Installation

Option 1: Standalone Binary (Easiest)

No Python required.

  1. Download netwatch-windows.exe from the Releases Page.
  2. Basic Usage: Double-click the file to start monitoring immediately.
  3. Advanced Usage: To set limits (e.g., -l 10GB), open your terminal (PowerShell/CMD) in the download folder and run:
    .\netwatch-windows.exe -l 10GB
    

Option 2: Install via PyPI (Recommended for CLI)

Designed for Python 3.8+ and distributed on PyPI for simple installation with pip.

pip install netwatchpy

Usage

Once installed, the netwatch command will be available in your terminal.

To start the monitor (monitors all interfaces):

netwatch

To see all available options and help:

netwatch --help

Command-Line Arguments

You can control the monitor with these arguments:

  • -h, --help

    • Shows the help message and all options.
  • -i INTERFACE, --interface INTERFACE

    • Monitors a single, specific network interface (e.g., -i "Wi-Fi"). Defaults to "all".
  • -l LIMIT, --limit LIMIT

    • Sets a data cap and shows a progress bar (e.g., -l "10GB" or -l "500MB").
  • --log LOG

    • Saves all network activity to a specified CSV file (e.g., --log "usage.csv").

Examples

Set a 10GB data limit:

netwatch -l "10GB"

Monitor a specific interface ("Wi-Fi") and log to a file:

netwatch -i "Wi-Fi" --log "my_usage.csv"

In-App Keybindings

  • Ctrl+p: Open the Command Palette

  • Ctrl+d: Toggle Dark / Light Mode

  • Ctrl+b: Toggle Bits/Bytes (Mbps ↔ MB/s)

  • r: Refresh the history chart

  • Ctrl+r: Reset all counters and history to zero

  • Ctrl+s: Show save status (Data is auto-saved)

  • Ctrl+q: Quit the application


Understanding the Interface

1. Live Monitor Tab

This is the default view. It shows:

  • Summary Cards: Total Upload, Download, and Combined Usage for the current session + history.

  • Quota Bar: If a limit was set, this bar fills up. It turns Yellow at 80% and Red at 100%.

  • Live Table: A scrolling list of network speeds recorded every second.

2. History Tab (24h)

This tab visualizes your traffic over the last 24 hours.

  • Rows: Each row represents a 1-hour block of time (e.g., 14:00 covers 2:00 PM to 2:59 PM).

  • The Bar:

    • Solid Block (█): Represents Download traffic.

    • Shaded Block (░): Represents Upload traffic.

  • Total: The text on the right shows the exact data transferred during that hour.

Tip: If the graph looks outdated, press r to pull the latest stats from the database.


Bug Reports & Feature Requests

Found a bug or have a great idea? Please open an issue on the GitHub repository.

License

This project is licensed under the MIT License.

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

netwatchpy-1.2.4.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

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

netwatchpy-1.2.4-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file netwatchpy-1.2.4.tar.gz.

File metadata

  • Download URL: netwatchpy-1.2.4.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netwatchpy-1.2.4.tar.gz
Algorithm Hash digest
SHA256 a96b3c2bc8d5effa93b47330e759a8c07efc211db872b34c02402cf234b76ca4
MD5 188e8477c4e0f05098fb1e7575259564
BLAKE2b-256 b716b4a0dfaed3057a16316a30fc93d507cec4ce58dddf4db49a18b9ea4a049e

See more details on using hashes here.

File details

Details for the file netwatchpy-1.2.4-py3-none-any.whl.

File metadata

  • Download URL: netwatchpy-1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netwatchpy-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 66b0a9bcd050dbf477efb18b294188c9bb78109a4c3d33644b8aea7fa3540279
MD5 04f5e94301cedbc6c4b9055af0650b80
BLAKE2b-256 1855b15323bee9d73f5a5d98a472fdbda217200c64dcaeb479eb45cf47e91812

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