| Name | battery-notifier JSON |
| Version |
0.3
JSON |
| download |
| home_page | None |
| Summary | Sends desktop notifications for low and critical battery warnings, and optionally when charging/discharging state changes |
| upload_time | 2024-12-23 23:22:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Brenton Leighton 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. |
| keywords |
linux
battery
dbus
upower
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# battery_notifier
Sends desktop notifications for low and critical battery warnings, and optionally when charging/discharging state
changes
## Installation
battery_notifier has the following dependencies available on PyPI:
- `pydbus`
- `PyGObject`
The package can be installed using [pipx](https://pipx.pypa.io/stable/installation/), e.g.:
```bash
pipx install battery_notifier
```
## Configuration
battery_notifier can be configured with a file located at `~/.config/battery_notifier/config.ini`, e.g.
```ini
[low]
expire_timeout = 0
[critical]
expire_timeout = 0
[discharging]
enable = true
expire_timeout = 0
[charging]
enable = true
expire_timeout = 5000
```
## Starting with systemd
A systemd service file is included in this repository which can be enabled and started like so:
```bash
# Copy the service file
cp battery_notifier.service ~/.local/share/systemd/user/
# Enable the service
systemctl --user enable battery_notifier
# Start the service
systemctl --user start battery_notifier
```
Raw data
{
"_id": null,
"home_page": null,
"name": "battery-notifier",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Brenton Leighton <12228142+brenton-leighton@users.noreply.github.com>",
"keywords": "linux, battery, dbus, upower",
"author": null,
"author_email": "Brenton Leighton <12228142+brenton-leighton@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/57/85/e3b08af543dde82c51e40cb8b9b934a8a67f9eb4a622d82b4a8f3471ebbb/battery_notifier-0.3.tar.gz",
"platform": null,
"description": "# battery_notifier\n\nSends desktop notifications for low and critical battery warnings, and optionally when charging/discharging state\nchanges\n\n## Installation\n\nbattery_notifier has the following dependencies available on PyPI:\n\n- `pydbus`\n- `PyGObject`\n\nThe package can be installed using [pipx](https://pipx.pypa.io/stable/installation/), e.g.:\n\n```bash\npipx install battery_notifier\n```\n\n## Configuration\n\nbattery_notifier can be configured with a file located at `~/.config/battery_notifier/config.ini`, e.g.\n\n```ini\n[low]\nexpire_timeout = 0\n\n[critical]\nexpire_timeout = 0\n\n[discharging]\nenable = true\nexpire_timeout = 0\n\n[charging]\nenable = true\nexpire_timeout = 5000\n```\n\n## Starting with systemd\n\nA systemd service file is included in this repository which can be enabled and started like so:\n\n```bash\n# Copy the service file\ncp battery_notifier.service ~/.local/share/systemd/user/\n\n# Enable the service\nsystemctl --user enable battery_notifier\n\n# Start the service\nsystemctl --user start battery_notifier\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Brenton Leighton 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. ",
"summary": "Sends desktop notifications for low and critical battery warnings, and optionally when charging/discharging state changes",
"version": "0.3",
"project_urls": {
"Homepage": "https://github.com/brenton-leighton/battery_notifier"
},
"split_keywords": [
"linux",
" battery",
" dbus",
" upower"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35767921ab156bbb7adb80a9d8973bb8d9260d862c46fc74f976fb9b6daa7a89",
"md5": "17ec97777331973aebfc84eab220fbc0",
"sha256": "5823bcb469e125bf8a3043d1af370ffe4d55eb7b231179eec2682459462a116d"
},
"downloads": -1,
"filename": "battery_notifier-0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "17ec97777331973aebfc84eab220fbc0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5306,
"upload_time": "2024-12-23T23:22:44",
"upload_time_iso_8601": "2024-12-23T23:22:44.877365Z",
"url": "https://files.pythonhosted.org/packages/35/76/7921ab156bbb7adb80a9d8973bb8d9260d862c46fc74f976fb9b6daa7a89/battery_notifier-0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5785e3b08af543dde82c51e40cb8b9b934a8a67f9eb4a622d82b4a8f3471ebbb",
"md5": "8cc6b987f3b57fbdaf805528258f21b0",
"sha256": "fd9db681e768e9639b9fb182050ea0d44a3480d569f23a9fd42043935adf26db"
},
"downloads": -1,
"filename": "battery_notifier-0.3.tar.gz",
"has_sig": false,
"md5_digest": "8cc6b987f3b57fbdaf805528258f21b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3938,
"upload_time": "2024-12-23T23:22:47",
"upload_time_iso_8601": "2024-12-23T23:22:47.245218Z",
"url": "https://files.pythonhosted.org/packages/57/85/e3b08af543dde82c51e40cb8b9b934a8a67f9eb4a622d82b4a8f3471ebbb/battery_notifier-0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-23 23:22:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brenton-leighton",
"github_project": "battery_notifier",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "battery-notifier"
}
