Metadata-Version: 2.4
Name: tpustat
Version: 0.1.1
Summary: A gpustat-style TPU status CLI built on top of google-smi.
Author: Minho Ryu
License: MIT
Project-URL: Homepage, https://github.com/bzantium/tpustat
Project-URL: Repository, https://github.com/bzantium/tpustat
Keywords: tpu,google-smi,monitoring,cli,status
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: google-smi>=0.1.0
Requires-Dist: psutil>=5.9
Requires-Dist: shtab>=1.7
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Dynamic: license-file
Dynamic: requires-python

# tpustat

`tpustat` is the TPU equivalent of the `gpustat` workflow:

- `nvidia-smi` -> `gpustat`
- `google-smi` -> `tpustat`

It turns the verbose TPU table into a compact one-line-per-device view, while still supporting JSON output, watch mode, and richer process details when needed. By default it uses the local `google_smi` Python package and falls back to `google-smi --json`.

![Color preview](assets/tpustat-preview.png)

## Install

```bash
# install from GitHub
pip install git+https://github.com/bzantium/tpustat.git

# or install locally for development
pip install -e .
```

## Quick Start

```bash
# compact default view
tpustat

# include bus / NUMA / IOMMU details
tpustat --show-all

# show explicit process fields
tpustat -c -u -p

# machine-readable output
tpustat --json

# refresh continuously
tpustat -i
tpustat -i 0.5

# generate shell completion
tpustat --print-completion bash
tpustat --print-completion zsh
```
