# PyHw
[![Downloads](https://static.pepy.tech/badge/pyhw)](https://pepy.tech/project/pyhw)
![PyPI - Version](https://img.shields.io/pypi/v/pyhw?label=version)
![Static Badge](https://img.shields.io/badge/macOS-brightgreen)
![Static Badge](https://img.shields.io/badge/Linux-blue)
PyHw, a neofetch-like command line tool for fetching system information but written mostly in Python. **Currently, this project is still in the initial stage, only part of the linux systems and macOS are supported.**
This project is a Python reimplementation of [neofetch](https://github.com/dylanaraps/neofetch) and references the [fastfetch](https://github.com/fastfetch-cli/fastfetch) project for logo style settings. Since this project is implemented in Python, it will be easier to maintain and extend than bash and c implementation. Also, this project only relies on the Python standard library, so you can run it on any device that has a Python environment (I hope so 🤔).
[//]: # (![demo](https://i2.imgs.ovh/d/BQACAgUAAx0EUvSR8wACMvpmyFVohzKxLcUdLiJaEa3wlo_OrQACuw4AAoX-QVaSpG0-rTAeRTUE))
![demo](https://files.catbox.moe/xx58xy.jpg)
## Install
There are already a lot of similar tools so you can choose any of them; they're all essentially no different. If you want to try this tool, just install it directly by pip.
```shell
pip install pyhw
```
To upgrade pyhw:
```shell
pip install pyhw --upgrade
```
You can then use this tool directly from the command line with the following command, just like neofetch.
```shell
pyhw
```
Please note that the command line entry for __pyhw__ 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__.
### Important note about debian 12:
If you use system pip to install pyhw, you will encounter this problem on debian12 and some related distributions:
```text
error: externally-managed-environment
× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
python3-xyz, where xyz is the package you are trying to
install.
If you wish to install a non-Debian-packaged Python package,
create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
sure you have python3-full installed.
For more information visit http://rptl.io/venv
note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.
```
This is due to the fact that system python is not supposed to be managed by pip. You can use a virtual environment (venv) or force remove this restriction (not recommended).
## Supported (Tested) OS
* macOS arm64, x86_64
* debian-based distro x86_64
* RaspberryPi OS arm64
## 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
```
or you can use the old setup.py style command:
```shell
python setup.py sdist bdist_wheel
```
After the build process, the source package and the binary whl package can be found in the dist folder.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyhw",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "neofetch, system information, command line tool, python, hardware information, fastfetch, fetching",
"author": null,
"author_email": "Xiao Ran <xiaoran.007@icloud.com>",
"download_url": "https://files.pythonhosted.org/packages/58/a6/d4083889e4429b9711b0570c291ed5c71f36a31b50f58e9e44e20fd92123/pyhw-0.4.0.tar.gz",
"platform": null,
"description": "# PyHw\n[![Downloads](https://static.pepy.tech/badge/pyhw)](https://pepy.tech/project/pyhw)\n![PyPI - Version](https://img.shields.io/pypi/v/pyhw?label=version)\n\n![Static Badge](https://img.shields.io/badge/macOS-brightgreen)\n![Static Badge](https://img.shields.io/badge/Linux-blue)\n\n\nPyHw, a neofetch-like command line tool for fetching system information but written mostly in Python. **Currently, this project is still in the initial stage, only part of the linux systems and macOS are supported.**\n\nThis project is a Python reimplementation of [neofetch](https://github.com/dylanaraps/neofetch) and references the [fastfetch](https://github.com/fastfetch-cli/fastfetch) project for logo style settings. Since this project is implemented in Python, it will be easier to maintain and extend than bash and c implementation. Also, this project only relies on the Python standard library, so you can run it on any device that has a Python environment (I hope so \ud83e\udd14).\n\n\n[//]: # (![demo](https://i2.imgs.ovh/d/BQACAgUAAx0EUvSR8wACMvpmyFVohzKxLcUdLiJaEa3wlo_OrQACuw4AAoX-QVaSpG0-rTAeRTUE))\n![demo](https://files.catbox.moe/xx58xy.jpg)\n\n\n\n\n\n## Install\nThere are already a lot of similar tools so you can choose any of them; they're all essentially no different. If you want to try this tool, just install it directly by pip.\n```shell\npip install pyhw\n```\nTo upgrade pyhw:\n```shell\npip install pyhw --upgrade\n```\nYou can then use this tool directly from the command line with the following command, just like neofetch.\n```shell\npyhw\n```\nPlease note that the command line entry for __pyhw__ 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\n### Important note about debian 12:\nIf you use system pip to install pyhw, you will encounter this problem on debian12 and some related distributions:\n```text\nerror: externally-managed-environment\n\n\u00d7 This environment is externally managed\n\u2570\u2500> To install Python packages system-wide, try apt install\n python3-xyz, where xyz is the package you are trying to\n install.\n \n If you wish to install a non-Debian-packaged Python package,\n create a virtual environment using python3 -m venv path/to/venv.\n Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make\n sure you have python3-full installed.\n \n For more information visit http://rptl.io/venv\n\nnote: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.\nhint: See PEP 668 for the detailed specification.\n```\nThis is due to the fact that system python is not supposed to be managed by pip. You can use a virtual environment (venv) or force remove this restriction (not recommended).\n\n## Supported (Tested) OS\n* macOS arm64, x86_64\n* debian-based distro x86_64\n* RaspberryPi OS arm64\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```\nor you can use the old setup.py style command:\n```shell\npython setup.py sdist bdist_wheel\n```\nAfter the build process, the source package and the binary whl package can be found in the dist folder.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "PyHw, a neofetch-like command line tool for fetching system information but written mostly in python.",
"version": "0.4.0",
"project_urls": {
"homepage": "https://github.com/xiaoran007/pyhw"
},
"split_keywords": [
"neofetch",
" system information",
" command line tool",
" python",
" hardware information",
" fastfetch",
" fetching"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "494cf8977e434fb761dd69e5fd3a2ca4ef7043b97f6d08b8bc152f4633eb90fb",
"md5": "f8a44acdeebb9f0190c8c27d50139caf",
"sha256": "51d6e9a87efe831f85e074c366160fe9de95de6bf5f43298fe2a52a0af4be62e"
},
"downloads": -1,
"filename": "pyhw-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8a44acdeebb9f0190c8c27d50139caf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 39185,
"upload_time": "2024-09-23T15:49:44",
"upload_time_iso_8601": "2024-09-23T15:49:44.071111Z",
"url": "https://files.pythonhosted.org/packages/49/4c/f8977e434fb761dd69e5fd3a2ca4ef7043b97f6d08b8bc152f4633eb90fb/pyhw-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58a6d4083889e4429b9711b0570c291ed5c71f36a31b50f58e9e44e20fd92123",
"md5": "ca6119ee8802515d370a3c5e5963ee40",
"sha256": "a11086a9b67d75c8dc96ed0e2ab93e6de6117b488b629718ac402c0997a0b7c2"
},
"downloads": -1,
"filename": "pyhw-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "ca6119ee8802515d370a3c5e5963ee40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 25661,
"upload_time": "2024-09-23T15:49:45",
"upload_time_iso_8601": "2024-09-23T15:49:45.549643Z",
"url": "https://files.pythonhosted.org/packages/58/a6/d4083889e4429b9711b0570c291ed5c71f36a31b50f58e9e44e20fd92123/pyhw-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-23 15:49:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xiaoran007",
"github_project": "pyhw",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyhw"
}