Metadata-Version: 2.4
Name: picomon
Version: 0.1.1
Summary: Minimal curses dashboard for monitoring AMD GPUs via amd-smi
Author-email: Omar Kamali <picomon@omarkama.li>
License: MIT License
        
        Copyright (c) 2025 Omar Kamali
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/omarkamali/picomon
Project-URL: Issues, https://github.com/omarkamali/picomon/issues
Project-URL: Repository, https://github.com/omarkamali/picomon
Keywords: amd,gpu,monitor,cli,curses
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Monitoring
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=7; extra == "dev"
Dynamic: license-file

# picomon

picomon is a tiny terminal dashboard for monitoring AMD GPUs via `amd-smi`. It polls basic metrics (gfx activity, memory usage, and power) and renders them as sparklines inside a curses UI so you can keep an eye on accelerators without launching a full GUI stack. 

Homepage: <https://omarkamali.github.io/picomon/>

## Why?

I like nvtop but the asserts kept crashing it on some AMD devices. picomon is a lightweight alternative that just polls metrics and renders them as sparklines, trading off ironclad accuracy checks for more reliability.

It hasn't been tested on all AMD GPUs. If it fails to run on your GPU, please open a new issue using [this template](https://github.com/omarkamali/picomon/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBug%5D).

## Requirements

- Python 3.9 or newer
- The `amd-smi` CLI available on your PATH (if your GPU is properly setup then you already have this)
- An ANSI-compatible terminal for the curses UI

## Installation

```shell
pip install picomon
```

## Usage

After installation, run the CLI:

```
$ picomon

┌──────────────────────────────────────────┐  ┌──────────────────────────────────────────┐
│ GPU 0  GFX  42%  UMC  21%                │  │ GPU 1  GFX  78%  UMC  66%                │
│ PWR 135/250W (54%)  VRAM 10.0/16.0GB 62% │  │ PWR 210/250W (84%)  VRAM 14.5/16.0GB 90% │
│                                          │  │                                          │
│ GFX ▁▂▂▃▄▄▅▆▆▇█▇▆▅▄▃▂▁                   │  │ GFX ▂▃▄▅▆▇██▇▆▅▄▂▂▃▅▆                    │
│ PWR ▁▁▂▂▃▄▄▅▆▇██▇▆▅▄▂▁                   │  │ PWR ▂▂▃▄▅▆▇██▇▆▅▄▃▂▂▃                    │
│ VRM ▁▁▂▂▃▄▄▅▆▇███▇▆▅▄▂                   │  │ VRM ▂▃▄▅▆▆▇███▇▆▅▄▃▂▂▃                   │
└──────────────────────────────────────────┘  └──────────────────────────────────────────┘
```

Key bindings:
- `q` to quit

Common flags:
- `--update-interval` (seconds between refreshes, default 3)
- `--history-minutes` (rolling window to retain, default 30)
- `--static-timeout` / `--metric-timeout` (seconds to wait for `amd-smi` responses)

These correspond to the `PicomonConfig` dataclass, so you can also import and reuse
picomon as a library:

```python
from picomon import PicomonConfig, run_monitor

config = PicomonConfig(update_interval=1.5)
run_monitor(["--update-interval", str(config.update_interval)])
```

## Development

- Run tests with `pytest` (see the CI workflow for reference)
- Use `scripts/publish.py` to cut a GitHub release once tags are in place

## License

MIT © [Omar Kamali](https://omarkamali.com)

Source: <https://github.com/omarkamali/picomon>
