[](https://github.com/dhanushk-offl/guro/actions/workflows/python-package.yml) [](https://scorecard.dev/viewer/?uri=github.com/dhanushk-offl/guro) [](https://github.com/dhanushk-offl/guro/actions/workflows/codeql.yml) [](https://pypi.org/project/guro/) 
[](https://buymeacoffee.com/itzmedhanu)
# Guro - A Simple System Monitoring & Benchmarking Toolkit π
Welcome to **Guro**, the ultimate toolkit for **system monitoring** and **benchmarking**. Itβs simple, fast, and designed for developers and enthusiasts who want to monitor system performance, run benchmarks, and visualize system heatmaps in an intuitive way.
### Features:
- π **Real-time system monitoring** β Monitor CPU, memory, and disk usage in real-time.
- π₯ **Performance benchmarking** β Run benchmarks with mini and full-scale tests for your CPU and GPU.
- π‘οΈ **Hardware heatmap** β Visualize your system's temperature with a heatmap in real-time.
- πΎ **Export data** β Export monitoring data to CSV for analysis.
### Installation
For General Installation:
```bash
pip install guro
```
For **Linux** & **MacOS** users, we recommend installing via `pipx` for better isolation or use can virtual environments:
```bash
pipx install guro
```
For **Windows** users, use a virtual environment to manage the CLI-based package:
```bash
python -m venv guro_env
source guro_env/bin/activate # On Windows: guro_env\Scripts\activate
pip install guro
```
### Usage
Run the following commands for monitoring, benchmarking, or heatmap analysis:
#### 1. **Monitor System Resources**
```bash
guro monitor --interval 1.0 --duration 60
```
- **Options**:
- `--interval/-i`: Monitoring interval in seconds (default: 1.0).
- `--duration/-d`: Monitoring duration in seconds.
- `--export/-e`: Export monitoring data to a CSV file.
#### 2. **Run Benchmark Tests**
```bash
guro benchmark --type mini --cpu-only
```
- **Options**:
- `--type/-t`: Type of benchmark test to run (`mini` or `god`).
- `--cpu-only`: Run only CPU benchmark.
- `--gpu-only`: Run only GPU benchmark.
#### 3. **Visualize System Heatmap**
```bash
guro heatmap --interval 1.0 --duration 30
```
- **Options**:
- `--interval/-i`: Update interval in seconds (must be greater than 0.1).
- `--duration/-d`: Duration to run in seconds (default: 10).
#### 4. **List All Commands**
```bash
guro list
```
- Displays all available commands and options for the toolkit.
#### 5. **About Guro**
```bash
guro about
```
- Displays information about Guro, including version, author, and features.
### License
MIT License. See [[LICENSE](https://github.com/dhanushk-offl/guro/LICENSE)] for more details.
For more details, check out our [[documentation](https://github.com/dhanushk-offl/guro/wiki)].
Raw data
{
"_id": null,
"home_page": "https://github.com/dhanushk-offl/guro",
"name": "guro",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "system-monitoring, gpu-optimization, performance-tuning, hardware-monitoring, system-administration, nvidia-gpu, amd-gpu, intel-gpu, resource-monitoring, system-optimization",
"author": "Dhanush Kandhan",
"author_email": "dhanushkandhan75@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/50/39/9565079234fc7af8661d4cad11271863420d519af38ca01edb935e848b5a/guro-1.0.3.tar.gz",
"platform": null,
"description": "[](https://github.com/dhanushk-offl/guro/actions/workflows/python-package.yml) [](https://scorecard.dev/viewer/?uri=github.com/dhanushk-offl/guro) [](https://github.com/dhanushk-offl/guro/actions/workflows/codeql.yml) [](https://pypi.org/project/guro/) \r\n\r\n\r\n[](https://buymeacoffee.com/itzmedhanu)\r\n\r\n# Guro - A Simple System Monitoring & Benchmarking Toolkit \ud83d\ude80\r\n\r\nWelcome to **Guro**, the ultimate toolkit for **system monitoring** and **benchmarking**. It\u2019s simple, fast, and designed for developers and enthusiasts who want to monitor system performance, run benchmarks, and visualize system heatmaps in an intuitive way.\r\n\r\n### Features:\r\n- \ud83d\udcca **Real-time system monitoring** \u2013 Monitor CPU, memory, and disk usage in real-time.\r\n- \ud83d\udd25 **Performance benchmarking** \u2013 Run benchmarks with mini and full-scale tests for your CPU and GPU.\r\n- \ud83c\udf21\ufe0f **Hardware heatmap** \u2013 Visualize your system's temperature with a heatmap in real-time.\r\n- \ud83d\udcbe **Export data** \u2013 Export monitoring data to CSV for analysis.\r\n\r\n### Installation\r\n\r\nFor General Installation:\r\n```bash\r\npip install guro\r\n```\r\n\r\nFor **Linux** & **MacOS** users, we recommend installing via `pipx` for better isolation or use can virtual environments:\r\n```bash\r\npipx install guro\r\n```\r\n\r\nFor **Windows** users, use a virtual environment to manage the CLI-based package:\r\n```bash\r\npython -m venv guro_env\r\nsource guro_env/bin/activate # On Windows: guro_env\\Scripts\\activate\r\npip install guro\r\n```\r\n\r\n### Usage\r\n\r\nRun the following commands for monitoring, benchmarking, or heatmap analysis:\r\n\r\n#### 1. **Monitor System Resources**\r\n```bash\r\nguro monitor --interval 1.0 --duration 60\r\n```\r\n- **Options**:\r\n - `--interval/-i`: Monitoring interval in seconds (default: 1.0).\r\n - `--duration/-d`: Monitoring duration in seconds.\r\n - `--export/-e`: Export monitoring data to a CSV file.\r\n\r\n#### 2. **Run Benchmark Tests**\r\n```bash\r\nguro benchmark --type mini --cpu-only\r\n```\r\n- **Options**:\r\n - `--type/-t`: Type of benchmark test to run (`mini` or `god`).\r\n - `--cpu-only`: Run only CPU benchmark.\r\n - `--gpu-only`: Run only GPU benchmark.\r\n\r\n#### 3. **Visualize System Heatmap**\r\n```bash\r\nguro heatmap --interval 1.0 --duration 30\r\n```\r\n- **Options**:\r\n - `--interval/-i`: Update interval in seconds (must be greater than 0.1).\r\n - `--duration/-d`: Duration to run in seconds (default: 10).\r\n\r\n#### 4. **List All Commands**\r\n```bash\r\nguro list\r\n```\r\n- Displays all available commands and options for the toolkit.\r\n\r\n#### 5. **About Guro**\r\n```bash\r\nguro about\r\n```\r\n- Displays information about Guro, including version, author, and features.\r\n\r\n\r\n### License\r\n\r\nMIT License. See [[LICENSE](https://github.com/dhanushk-offl/guro/LICENSE)] for more details.\r\n\r\nFor more details, check out our [[documentation](https://github.com/dhanushk-offl/guro/wiki)].\r\n",
"bugtrack_url": null,
"license": null,
"summary": "A Simple System Monitoring & Benchmarking Toolkit",
"version": "1.0.3",
"project_urls": {
"Bug Reports": "https://github.com/dhanushk-offl/guro/issues",
"Documentation": "https://github.com/dhanushk-offl/guro/wiki",
"Homepage": "https://github.com/dhanushk-offl/guro",
"Source": "https://github.com/dhanushk-offl/guro"
},
"split_keywords": [
"system-monitoring",
" gpu-optimization",
" performance-tuning",
" hardware-monitoring",
" system-administration",
" nvidia-gpu",
" amd-gpu",
" intel-gpu",
" resource-monitoring",
" system-optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb62114ff51ce43d6f851e810b64ba05bbec5f648f3cd55b1d55526b7ea9ab35",
"md5": "fe7731e6cccabfd00d689a56f50cad70",
"sha256": "eb06fbbe0f6a178025c74f711245eb9e932ecf4137d9cd30efc4fc218cb541cf"
},
"downloads": -1,
"filename": "guro-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe7731e6cccabfd00d689a56f50cad70",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 16574,
"upload_time": "2025-01-24T18:27:42",
"upload_time_iso_8601": "2025-01-24T18:27:42.482500Z",
"url": "https://files.pythonhosted.org/packages/cb/62/114ff51ce43d6f851e810b64ba05bbec5f648f3cd55b1d55526b7ea9ab35/guro-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "50399565079234fc7af8661d4cad11271863420d519af38ca01edb935e848b5a",
"md5": "656ae2c905cf8146e4c5ae001fae0608",
"sha256": "7b9527550cce82ab66ad44051f58f7f9d2aca9ee3491ff83f9d2e935ceaae39b"
},
"downloads": -1,
"filename": "guro-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "656ae2c905cf8146e4c5ae001fae0608",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 21740,
"upload_time": "2025-01-24T18:27:44",
"upload_time_iso_8601": "2025-01-24T18:27:44.334894Z",
"url": "https://files.pythonhosted.org/packages/50/39/9565079234fc7af8661d4cad11271863420d519af38ca01edb935e848b5a/guro-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 18:27:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dhanushk-offl",
"github_project": "guro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pytest",
"specs": [
[
">=",
"7.0.0"
]
]
},
{
"name": "pytest-mock",
"specs": [
[
">=",
"3.10.0"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
">=",
"4.0.0"
]
]
},
{
"name": "pytest-timeout",
"specs": [
[
">=",
"2.1.0"
]
]
},
{
"name": "click",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
">=",
"10.0.0"
]
]
},
{
"name": "psutil",
"specs": [
[
">=",
"5.8.0"
]
]
},
{
"name": "gputil",
"specs": [
[
">=",
"1.4.0"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.5.0"
]
]
},
{
"name": "nvidia-ml-py",
"specs": [
[
">=",
"11.515.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.3.0"
]
]
},
{
"name": "plotly",
"specs": [
[
">=",
"5.5.0"
]
]
},
{
"name": "termcolor",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.8.9"
]
]
},
{
"name": "py-cpuinfo",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "setproctitle",
"specs": [
[
">=",
"1.2.2"
]
]
},
{
"name": "keyboard",
"specs": [
[
">=",
"0.13.5"
]
]
},
{
"name": "py3nvml",
"specs": [
[
">=",
"0.2.7"
]
]
},
{
"name": "pyamdgpuinfo",
"specs": [
[
">=",
"2.1.6"
]
]
},
{
"name": "distro",
"specs": [
[
">=",
"1.7.0"
]
]
}
],
"test_requirements": [
{
"name": "pytest",
"specs": [
[
">=",
"7.0.0"
]
]
},
{
"name": "pytest-mock",
"specs": [
[
">=",
"3.10.0"
]
]
},
{
"name": "pytest-cov",
"specs": [
[
">=",
"4.0.0"
]
]
},
{
"name": "pytest-timeout",
"specs": [
[
">=",
"2.1.0"
]
]
},
{
"name": "click",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
">=",
"10.0.0"
]
]
},
{
"name": "psutil",
"specs": [
[
">=",
"5.8.0"
]
]
},
{
"name": "gputil",
"specs": [
[
">=",
"1.4.0"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.5.0"
]
]
},
{
"name": "nvidia-ml-py",
"specs": [
[
">=",
"11.515.0"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"1.3.0"
]
]
},
{
"name": "plotly",
"specs": [
[
">=",
"5.5.0"
]
]
},
{
"name": "termcolor",
"specs": [
[
">=",
"2.0.0"
]
]
},
{
"name": "tabulate",
"specs": [
[
">=",
"0.8.9"
]
]
},
{
"name": "py-cpuinfo",
"specs": [
[
">=",
"8.0.0"
]
]
},
{
"name": "setproctitle",
"specs": [
[
">=",
"1.2.2"
]
]
},
{
"name": "keyboard",
"specs": [
[
">=",
"0.13.5"
]
]
},
{
"name": "py3nvml",
"specs": [
[
">=",
"0.2.7"
]
]
},
{
"name": "pyamdgpuinfo",
"specs": [
[
">=",
"2.1.6"
]
]
},
{
"name": "distro",
"specs": [
[
">=",
"1.7.0"
]
]
}
],
"lcname": "guro"
}