# py3status-amdfan
Python module for monitoring fan RPMs and temperature for `amdgpu` cards in **i3wm** using py3status.
[](https://pepy.tech/project/py3status-amdfan)
## Screenshot
## Prerequisites
* i3
* py3status
* [amdfan](https://github.com/mcgillij/amdfan)
* poetry (if installing from git)
## Installation
### From Git
``` bash
git clone https://github.com/mcgillij/py3status-amdfan.git
cd py3status-amdfan && poetry install
mkdir -p ~/.i3/py3status && cd ~/.i3/py3status
ln -s <PATH_TO_CLONED_REPO>/src/py3status_amdfan/fan_monitor.py ./
```
### With Pip, Pipenv or Poetry
``` bash
pip install py3status-amdfan amdfan
pipenv install py3status-amdfan amdfan
poetry add py3status-amdfan amdfan && poetry install
```
### With `yay`
``` bash
yay -S py3status-amdfan amdfan
```
### Building Arch package w/PKGBUILD
``` bash
git clone https://aur.archlinux.org/py3status-amdfan.git
cd py3status-amdfan.git
makechrootpkg -c -r $HOME/$CHROOT
```
### Installing built Arch package
``` bash
sudo pacman -U --asdeps py3status-amdfan-*-any.pkg.tar.zst
```
## Configuration
Next you will need to add the services you want to monitor, and optionally choose some appropriate emoji's.
You can also configure actions to open up your browser when you click on the icon, which I find pretty handy.
**~/.config/i3/i3status.conf**
```bash
...
order += "fan_monitor"
order += "clock"
order += "mail"
...
```
## Configuration Options
You can pass in the following configuration options:
* cache_timeout
* format
## Restart i3
Once the package is installed and configured you just need to restart i3.
Raw data
{
"_id": null,
"home_page": "https://github.com/mcgillij/py3status-amdfan",
"name": "py3status-amdfan",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "amdgpu,monitor,fan,i3,py3status",
"author": "mcgillij",
"author_email": "mcgillivray.jason@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/9e/cb/9f1361cec81e437f08d11552387420a4f188114f0a338f19877c2a18027e/py3status_amdfan-0.1.10.tar.gz",
"platform": null,
"description": "# py3status-amdfan\nPython module for monitoring fan RPMs and temperature for `amdgpu` cards in **i3wm** using py3status.\n\n[](https://pepy.tech/project/py3status-amdfan)\n\n## Screenshot\n\n\n## Prerequisites\n\n* i3\n* py3status\n* [amdfan](https://github.com/mcgillij/amdfan)\n* poetry (if installing from git)\n\n## Installation\n\n### From Git\n\n``` bash\ngit clone https://github.com/mcgillij/py3status-amdfan.git\ncd py3status-amdfan && poetry install\nmkdir -p ~/.i3/py3status && cd ~/.i3/py3status\nln -s <PATH_TO_CLONED_REPO>/src/py3status_amdfan/fan_monitor.py ./\n```\n\n### With Pip, Pipenv or Poetry\n\n``` bash\npip install py3status-amdfan amdfan\npipenv install py3status-amdfan amdfan\npoetry add py3status-amdfan amdfan && poetry install\n```\n\n### With `yay`\n\n``` bash\nyay -S py3status-amdfan amdfan\n```\n\n### Building Arch package w/PKGBUILD\n\n``` bash\ngit clone https://aur.archlinux.org/py3status-amdfan.git\ncd py3status-amdfan.git\nmakechrootpkg -c -r $HOME/$CHROOT\n```\n\n### Installing built Arch package\n\n``` bash\nsudo pacman -U --asdeps py3status-amdfan-*-any.pkg.tar.zst\n```\n\n## Configuration\n\nNext you will need to add the services you want to monitor, and optionally choose some appropriate emoji's.\nYou can also configure actions to open up your browser when you click on the icon, which I find pretty handy.\n\n**~/.config/i3/i3status.conf**\n\n```bash\n...\norder += \"fan_monitor\"\norder += \"clock\"\norder += \"mail\"\n...\n```\n\n## Configuration Options\n\nYou can pass in the following configuration options:\n\n* cache_timeout\n* format\n\n## Restart i3\n\nOnce the package is installed and configured you just need to restart i3.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "py3status monitor to show amdgpu fan speeds and temp",
"version": "0.1.10",
"project_urls": {
"Documentation": "https://github.com/mcgillij/py3status-amdfan",
"Homepage": "https://github.com/mcgillij/py3status-amdfan",
"Repository": "https://github.com/mcgillij/py3status-amdfan"
},
"split_keywords": [
"amdgpu",
"monitor",
"fan",
"i3",
"py3status"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "650f61ce01876618c567796ee0290d5d03f676dabdf207e665f4ecb494131ff2",
"md5": "29e757b6e94fa0246f3945b5d4526367",
"sha256": "54cc2e63db3773e2c077c2f2aed5a99700d5cc7be94911ec63f456f0279ac340"
},
"downloads": -1,
"filename": "py3status_amdfan-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29e757b6e94fa0246f3945b5d4526367",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 4017,
"upload_time": "2023-08-05T16:17:20",
"upload_time_iso_8601": "2023-08-05T16:17:20.374566Z",
"url": "https://files.pythonhosted.org/packages/65/0f/61ce01876618c567796ee0290d5d03f676dabdf207e665f4ecb494131ff2/py3status_amdfan-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9ecb9f1361cec81e437f08d11552387420a4f188114f0a338f19877c2a18027e",
"md5": "ab2719d22b4855ebf2e05652be0fe364",
"sha256": "bebfc7357066fcfe6b13e3c9ad4354c279b088b494193d987ab09cda06d28215"
},
"downloads": -1,
"filename": "py3status_amdfan-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "ab2719d22b4855ebf2e05652be0fe364",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 3207,
"upload_time": "2023-08-05T16:17:21",
"upload_time_iso_8601": "2023-08-05T16:17:21.894568Z",
"url": "https://files.pythonhosted.org/packages/9e/cb/9f1361cec81e437f08d11552387420a4f188114f0a338f19877c2a18027e/py3status_amdfan-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-05 16:17:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mcgillij",
"github_project": "py3status-amdfan",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "py3status-amdfan"
}
JSON
