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.

  • Persistent Quota: Automatically saves your total usage, so you can track a monthly data cap across multiple sessions.

  • 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

  • Ctrl+s: 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.3.1.tar.gz (9.8 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.3.1-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for netwatchpy-0.3.1.tar.gz
Algorithm Hash digest
SHA256 0a01612cd74ba417d38d48b053c6c7107d02d3219e07608515275b35e5c9a048
MD5 7c5ba98e7c6c0a83f97b1c1ce2ee9382
BLAKE2b-256 a00d4554878d0b8175695c7ce7e68cfb1a0405e68b539e730c316474ffcba679

See more details on using hashes here.

File details

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

File metadata

  • Download URL: netwatchpy-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 9.1 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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a3366ff1da18ce1f79100a76c4ecf668b08e8025e21b98bbe4992da4c2b5453b
MD5 ccdf989b0caf858d6363c10a49ffb46e
BLAKE2b-256 1bb36f1a810b248284b4c2090dc68e5ba9d6b51256f7e58cf7b4e050be966e94

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