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.
  • Data Cap Monitoring: Set a data limit (e.g., 10GB) and see your usage on a real-time progress bar.
  • 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).
  • CSV Logging: Optionally log all network traffic to a CSV file for later analysis.
  • Cross-Platform: Runs on Windows, macOS, and Linux.

Installation

netwatchpy is available on PyPI. All you need is Python 3.8+ and 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

  • r: Reset all counters back to zero

  • Ctrl+Q: Quit the application


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-0.1.2.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

netwatchpy-0.1.2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netwatchpy-0.1.2.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for netwatchpy-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ce9a2da3571c0f3c0da66ba2a9dc31bbdb35051763ca9f05f9e91aa791b7ae65
MD5 4b1bd248dc29245952dcaa640ee4c45f
BLAKE2b-256 1f43883debb21ee76cbb6a4933d90b1e4ec94b92589bbaec7207b10d17104951

See more details on using hashes here.

File details

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

File metadata

  • Download URL: netwatchpy-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for netwatchpy-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 302bc8c02289a07b489b535d1344a92cce6487ffcaaa80229a87243679c98c49
MD5 12fad2018b876f9fdb8de9fbd3575daa
BLAKE2b-256 bb39a41b6eccc659aa38eadb1a08d0cc04dcff85030ea7f7da3f6ca889665557

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