Metadata-Version: 2.1
Name: systracker
Version: 0.2.5
Summary: Real-time system statistics monitoring.
Home-page: https://github.com/VenturaSync/SysTrack
Author: Mrinaal Arora
Author-email: marora16@asu.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Monitoring
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: appnope (==0.1.4)
Requires-Dist: asttokens (==2.4.1)
Requires-Dist: click (==8.1.7)
Requires-Dist: colorama (==0.4.6)
Requires-Dist: comm (==0.2.2)
Requires-Dist: debugpy (==1.8.1)
Requires-Dist: decorator (==5.1.1)
Requires-Dist: exceptiongroup (==1.2.1)
Requires-Dist: executing (==2.0.1)
Requires-Dist: importlib-metadata (==7.1.0)
Requires-Dist: ipykernel (==6.29.4)
Requires-Dist: ipython (==8.18.1)
Requires-Dist: py-cpuinfo (==9.0.0)
Requires-Dist: jedi (==0.19.1)
Requires-Dist: jupyter-client (==8.6.2)
Requires-Dist: jupyter-core (==5.7.2)
Requires-Dist: markdown-it-py (==3.0.0)
Requires-Dist: matplotlib-inline (==0.1.7)
Requires-Dist: mdurl (==0.1.2)
Requires-Dist: nest-asyncio (==1.6.0)
Requires-Dist: packaging (==24.1)
Requires-Dist: pyfiglet (==1.0.2)
Requires-Dist: parso (==0.8.4)
Requires-Dist: pexpect (==4.9.0)
Requires-Dist: platformdirs (==4.2.2)
Requires-Dist: prompt-toolkit (==3.0.47)
Requires-Dist: psutil (==5.9.8)
Requires-Dist: ptyprocess (==0.7.0)
Requires-Dist: pure-eval (==0.2.2)
Requires-Dist: Pygments (==2.18.0)
Requires-Dist: python-dateutil (==2.9.0.post0)
Requires-Dist: pyzmq (==26.0.3)
Requires-Dist: rich (==13.7.1)
Requires-Dist: shellingham (==1.5.4)
Requires-Dist: six (==1.16.0)
Requires-Dist: stack-data (==0.6.3)
Requires-Dist: tabulate (==0.9.0)
Requires-Dist: tornado (==6.4.1)
Requires-Dist: traitlets (==5.14.3)
Requires-Dist: typer (==0.12.3)
Requires-Dist: typing-extensions (==4.12.2)
Requires-Dist: wcwidth (==0.2.13)
Requires-Dist: zipp (==3.19.2)

<p align="center">
  <img src="/systrack/images/main.png" alt="alt text">
</p>

<h1 align="center">SysTrack</h1>

<p align='center'>SysTrack is a powerful CLI tool for monitoring and tracking system resources in real-time.</p>

## Features

- Memory usage statistics
- CPU usage tracking
- Disk usage information
- Network statistics
- Hardware information
- Temperature sensors (Linux and FreeBSD)
- Live system dashboard

## Installation

```bash
pip install systracker
```

# SysTrack CLI Commands

This section provides an overview of all available commands in the SysTrack CLI tool.

## systrack help

![systrack help command output](/systrack/images/systrack_help.png)

The `systrack help` command provides an overview of all available commands in the SysTrack CLI tool. It displays a stylized ASCII art logo of "SysTrack" followed by usage instructions, available options, and a list of all commands with brief descriptions. This command is essential for users to quickly understand the tool's capabilities and how to use each feature. The help output includes information on CPU, dashboard, disk, hardware, memory, network, and temperature commands, giving users a comprehensive guide to monitoring various aspects of their system.

## systrack cpu

![systrack cpu command output](/systrack/images/systrack_cpu.png)

The `systrack cpu` command provides a quick and visually appealing snapshot of the system's CPU statistics. It displays information in a neatly formatted table with two key metrics:

1. **CPU Cores**: Shows the total number of CPU cores available on the system. In this example, the system has 8 cores.

2. **CPU Usage**: Displays the current CPU utilization as a percentage. The screenshot shows a 24.0% usage, indicating the current load on the CPU.

This command is particularly useful for quickly assessing the CPU's capacity and its current workload. The clear, color-coded output makes it easy to read and interpret at a glance, making it an excellent tool for system administrators and users who need to monitor CPU performance regularly.

## systrack dashboard

![systrack dashboard command output](/systrack/images/systrack_dashboard.png)

The `systrack dashboard` command provides a comprehensive real-time overview of key system metrics. This dynamic dashboard displays:

- Total and Available Memory: Shows the system's total RAM (8.0 GB) and currently available memory.
- Used Memory: Indicates the amount of RAM currently in use.
- CPU Usage: Displays current CPU utilization as a percentage (31.3% in this example).
- Disk Free: Shows the amount of free storage space on the system.
- Network Statistics: Provides data on network usage, including sent and received data.

This command is invaluable for system administrators and users who need a quick, all-in-one view of their system's current state and performance.

## systrack disk

![systrack disk command output](/systrack/images/systrack_disk.png)

The `systrack disk` command offers a detailed snapshot of the system's disk usage. It presents information in a clear, tabular format:

- Total: Displays the total disk capacity (228.27 GB in this case).
- Used: Shows the amount of disk space currently in use (19.23 GB).
- Free: Indicates the available disk space (28.50 GB).
- Used %: Provides the percentage of disk space utilized (40.3%).

This command is essential for monitoring storage utilization, helping users manage their disk space effectively and plan for future storage needs.

## systrack hardware

![systrack hardware command output](/systrack/images/systrack_hardware.png)

The `systrack hardware` command delivers key information about the system's CPU hardware:

- CPU Brand: Identifies the processor (Apple M1 in this instance).
- Cores: Shows the number of CPU cores (8 cores).
- Bits: Indicates the processor architecture bit-depth (64-bit).
- Architecture: Specifies the CPU architecture (ARM_8).

This command is particularly useful for quickly identifying the system's hardware capabilities, which is valuable for software compatibility checks, performance expectations, and system requirements assessments.

## systrack memory

![systrack memory command output](/systrack/images/systrack_memory.png)


The `systrack memory` command provides a comprehensive overview of the system's memory statistics. It displays information in a neatly formatted table with the following metrics:

- **Total**: Total system memory (8.0 GB)
- **Available**: Current available memory
- **Used %**: Percentage of memory in use (80.7%)
- **Used**: Amount of memory currently in use
- **Free**: Amount of free memory
- **Active**: Amount of active memory
- **Inactive**: Amount of inactive memory
- **Wired**: Amount of wired memory

This command is useful for quickly assessing memory usage and availability, helping users identify potential memory constraints or optimization opportunities.

## systrack network

![systrack network command output](/systrack/images/systrack_network.png)

The `systrack network` command offers a snapshot of the system's network activity. It presents network statistics in a clear, tabular format with four key metrics:

1. **Bytes Sent**: Total number of bytes sent over the network
2. **Bytes Received**: Total number of bytes received from the network
3. **Packets Sent**: Total count of packets sent
4. **Packets Received**: Total count of packets received

This command is valuable for monitoring network traffic, troubleshooting connectivity issues, or analyzing data transfer patterns. The color-coded output enhances readability, making it easy to quickly interpret network activity at a glance.


