# xtop
[](https://pepy.tech/project/pypci-ng)
xtop, a command line xpu hardware monitoring tool that supports CPU, GPU, and NPU.
## Install
Just install it directly by pip.
```shell
pip install xtop
```
To upgrade xtop:
```shell
pip install xtop --upgrade
# or
pip install xtop -U
```
## Usage
### Use as a command line tool
You can use this tool directly from the command line with the following command, just like other programs.
```shell
xtop [Options]
```
For example, use -n flag to open NPU, with -l flag to enable LOG.
```shell
xtop -n -l
```
For more command line flags, see:
```shell
xtop -h
```
Please note that the command line entry for __xtop__ is created by pip, and depending on the user, this entry may not in the __system PATH__. If you encounter this problem, pip will give you a prompt, follow the prompts to add entry to the __system PATH__.
More functionalities are under development.
## Supported (Tested) OS
* Linux
* Windows (Only GPU)
## Build from source
### Build tools
Make sure the following Python build tools are already installed.
* setuptools
* build
* twine
### Build package
clone the project, and run:
```shell
python -m build
```
After the build process, the source package and the binary whl package can be found in the dist folder.
# Windows
install:
```shell
pip install nvidia-ml-py windows-curses
```
Raw data
{
"_id": null,
"home_page": null,
"name": "xtop",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "xtop, xpu, system information, command line tool, python, hardware information, GPU, NPU",
"author": null,
"author_email": "Xiao Ran <xiaoran.007@icloud.com>",
"download_url": "https://files.pythonhosted.org/packages/15/ff/02acdd16e6a0aabd77db72dbf2dbc4b019043c5f1343771e70db90471a7a/xtop-0.0.3.tar.gz",
"platform": null,
"description": "# xtop\n\n\n[](https://pepy.tech/project/pypci-ng)\n\n\n\n\n\nxtop, a command line xpu hardware monitoring tool that supports CPU, GPU, and NPU.\n\n\n## Install\nJust install it directly by pip.\n```shell\npip install xtop\n```\nTo upgrade xtop:\n```shell\npip install xtop --upgrade\n# or\npip install xtop -U\n```\n\n## Usage\n### Use as a command line tool\nYou can use this tool directly from the command line with the following command, just like other programs.\n```shell\nxtop [Options]\n```\nFor example, use -n flag to open NPU, with -l flag to enable LOG.\n```shell\nxtop -n -l\n```\nFor more command line flags, see:\n```shell\nxtop -h\n```\n\nPlease note that the command line entry for __xtop__ is created by pip, and depending on the user, this entry may not in the __system PATH__. If you encounter this problem, pip will give you a prompt, follow the prompts to add entry to the __system PATH__.\n\nMore functionalities are under development.\n\n## Supported (Tested) OS\n* Linux\n* Windows (Only GPU)\n\n\n## Build from source\n### Build tools\nMake sure the following Python build tools are already installed.\n* setuptools\n* build\n* twine\n\n### Build package\nclone the project, and run:\n```shell\npython -m build\n```\nAfter the build process, the source package and the binary whl package can be found in the dist folder.\n\n# Windows\ninstall:\n```shell\npip install nvidia-ml-py windows-curses\n```\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "xtop, a command line xpu hardware monitoring tool that supports CPU, GPU, and NPU.",
"version": "0.0.3",
"project_urls": {
"homepage": "https://github.com/xiaoran007/xtop"
},
"split_keywords": [
"xtop",
" xpu",
" system information",
" command line tool",
" python",
" hardware information",
" gpu",
" npu"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "586cfbe70d57e4cde78e93310b34cabe85a9dd77fef249936556b3f319ce8f06",
"md5": "0dbec81eaf706bf29fd11884319d20c0",
"sha256": "82cc8e234dc55b8bfdd669c4c36f629a4213bed9cb659d7bfd11e2c093d889d5"
},
"downloads": -1,
"filename": "xtop-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0dbec81eaf706bf29fd11884319d20c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20659,
"upload_time": "2024-10-26T11:10:23",
"upload_time_iso_8601": "2024-10-26T11:10:23.503105Z",
"url": "https://files.pythonhosted.org/packages/58/6c/fbe70d57e4cde78e93310b34cabe85a9dd77fef249936556b3f319ce8f06/xtop-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15ff02acdd16e6a0aabd77db72dbf2dbc4b019043c5f1343771e70db90471a7a",
"md5": "e939d8171f9abd8ea923e1855c93f7ae",
"sha256": "5aa6303909aac45e16f9498414272c8e59d7d0a2346192da4aa7557f0eb65012"
},
"downloads": -1,
"filename": "xtop-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "e939d8171f9abd8ea923e1855c93f7ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19059,
"upload_time": "2024-10-26T11:10:25",
"upload_time_iso_8601": "2024-10-26T11:10:25.175162Z",
"url": "https://files.pythonhosted.org/packages/15/ff/02acdd16e6a0aabd77db72dbf2dbc4b019043c5f1343771e70db90471a7a/xtop-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-26 11:10:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xiaoran007",
"github_project": "xtop",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "xtop"
}
JSON
