Skip to main content

A comprehensive system monitoring tool with real-time insights

Project description

System Monitor

A comprehensive system monitoring tool built with Python and the rich library, providing real-time insights into system performance, including CPU usage, memory statistics, network details, disk I/O, and temperature monitoring.

Features

  • Real-time Monitoring: Displays live updates of system metrics.
  • Customizable Display: Toggle visibility of different sections like CPU, memory, network, disk I/O, and temperature.
  • User-friendly Interface: Uses the rich library for a visually appealing console interface.
  • Cross-platform Support: Works on Windows, macOS, and Linux (with some features dependent on platform support).

Installation

  1. Clone the Repository:

    git clone https://github.com/johnniewhite/watchtower.git
    cd watchtower
    
  2. Install Dependencies: Ensure you have Python 3.6 or later installed. Then, install the required packages:

    pip install -r requirements.txt
    

    The requirements.txt should include:

    rich
    psutil
    speedtest-cli
    pynput
    

Usage

Run the system monitor using the following command:

python system_monitor.py

Keyboard Commands

  • q: Quit the application
  • s: Toggle Speed Test display
  • p: Toggle Process List
  • n: Toggle Network Details
  • d: Toggle Disk I/O Statistics
  • t: Toggle Temperature Monitor
  • h: Show help message

Configuration

  • Update Intervals: Adjust the refresh rate by modifying the refresh_per_second parameter in the Live context.
  • Speed Test Interval: Change the SPEED_TEST_INTERVAL variable to set how often speed tests are conducted.

Troubleshooting

  • Temperature Monitoring Not Supported: If you receive an error about temperature monitoring, ensure your system supports it and that psutil is up-to-date.
  • Command Not Responding: Ensure the terminal window is focused and that you are pressing the correct keys.
  • Dependencies Issues: Verify that all dependencies are installed correctly using pip list.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes. Ensure your code follows the existing style and includes appropriate documentation.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or support, please contact your-email@example.com.


### Explanation:

- **Features**: Lists the main capabilities of the application.
- **Installation**: Provides step-by-step instructions to set up the project.
- **Usage**: Explains how to run the application and use its features.
- **Configuration**: Offers guidance on customizing the application.
- **Troubleshooting**: Addresses common issues users might encounter.
- **Contributing**: Encourages community contributions.
- **License**: States the licensing terms.
- **Contact**: Provides a way for users to reach out for support.

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

system_monitor_cli-0.1.0.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

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

system_monitor_cli-0.1.0-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file system_monitor_cli-0.1.0.tar.gz.

File metadata

  • Download URL: system_monitor_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for system_monitor_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5478fc1bb904d05e45a3b31990cc1a3ece35e9e290432c4ed830dc92220a6ced
MD5 0acfc2105bcb87b62c8879b75beaae87
BLAKE2b-256 f4193c6c76f5954d413e81d1b5b1cbb78242483da310090a8da46ee175cdcdac

See more details on using hashes here.

File details

Details for the file system_monitor_cli-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for system_monitor_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51642d48c5cf0a07364ec38844e48210ea97b71b242a7931c85584baf0916310
MD5 52e8c6a800d51e6c6371ec04ab0c5e42
BLAKE2b-256 29fc225d842e48cd38bde671d2049fe6149d84c48e77a04632c3afa04f88e1ec

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