| Name | sleepguard JSON |
| Version |
0.1.7
JSON |
| download |
| home_page | None |
| Summary | Monitor system stats and prevent system sleep when significant activity is detected. |
| upload_time | 2024-07-05 18:26:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2024 Reid Swanson 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 |
sleep
suspend
power-management
keep-awake
prevent-sleep
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Sleep Guard
===========
Other tools such as `Caffeine <https://launchpad.net/caffeine>`__ for Linux and `Caffeinate <https://ss64.com/mac/caffeinate.html>`__ for the Mac will keep your system awake, but require explicit action by the user.
If you are like me, I often start a long running process, but forget to actually take the explicit action and come back to a sleeping system with no work done.
``sleepguard`` is a program that monitors several system resources and prevents the computer from sleeping automatically if it detects significant activity (as defined by the user).
Installation
============
.. code-block::
pip install sleepguard
To enable GPU monitoring you must install one (or both) of the optional variants: ``amd`` for AMD or ``nvidia`` for NVIDIA cards.
.. code-block::
pip install sleepguard[amd,nvidia]
Basic Usage
===========
The main application is implemented in the ``sleepguard.guard`` module and can be run like any other python application.
This will start an infinite loop that periodically polls the desired system resources and will prevent the system from sleeping [1]_ if any of the values are above their configured thresholds.
.. code-block::
python -m sleepguard.gaurd
Full Documentation
==================
See `read the docs <https://sleepguard.readthedocs.io/en/latest/>`__ for the full documentation and configuration options.
.. [1] For at least KDE and Gnome, the idle timer is reset when activity is detected.
If not other activity is detected, this will cause sleep to be disabled for the number of minutes configured in DE's power management settings.
It is also the likely behavior for other desktop environments, but is untested.
Raw data
{
"_id": null,
"home_page": null,
"name": "sleepguard",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "sleep, suspend, power-management, keep-awake, prevent-sleep",
"author": null,
"author_email": "Reid Swanson <reid@reidswanson.com>",
"download_url": "https://files.pythonhosted.org/packages/b0/1e/e0416bfff743a25569c0e80b4e4a637c37b2377ed51132014507e4555a38/sleepguard-0.1.7.tar.gz",
"platform": null,
"description": "Sleep Guard\n===========\n\nOther tools such as `Caffeine <https://launchpad.net/caffeine>`__ for Linux and `Caffeinate <https://ss64.com/mac/caffeinate.html>`__ for the Mac will keep your system awake, but require explicit action by the user.\nIf you are like me, I often start a long running process, but forget to actually take the explicit action and come back to a sleeping system with no work done.\n\n``sleepguard`` is a program that monitors several system resources and prevents the computer from sleeping automatically if it detects significant activity (as defined by the user).\n\n\nInstallation\n============\n\n.. code-block::\n\n pip install sleepguard\n\nTo enable GPU monitoring you must install one (or both) of the optional variants: ``amd`` for AMD or ``nvidia`` for NVIDIA cards.\n\n.. code-block::\n\n pip install sleepguard[amd,nvidia]\n\nBasic Usage\n===========\n\nThe main application is implemented in the ``sleepguard.guard`` module and can be run like any other python application.\nThis will start an infinite loop that periodically polls the desired system resources and will prevent the system from sleeping [1]_ if any of the values are above their configured thresholds.\n\n.. code-block::\n\n python -m sleepguard.gaurd\n\nFull Documentation\n==================\n\nSee `read the docs <https://sleepguard.readthedocs.io/en/latest/>`__ for the full documentation and configuration options.\n\n\n.. [1] For at least KDE and Gnome, the idle timer is reset when activity is detected.\n If not other activity is detected, this will cause sleep to be disabled for the number of minutes configured in DE's power management settings.\n It is also the likely behavior for other desktop environments, but is untested.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Reid Swanson 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": "Monitor system stats and prevent system sleep when significant activity is detected.",
"version": "0.1.7",
"project_urls": {
"Homepage": "https://bitbucket.org/reidswanson/sleepguard"
},
"split_keywords": [
"sleep",
" suspend",
" power-management",
" keep-awake",
" prevent-sleep"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d987d79f237796138bd3a853766d327444098b0afa8d5a582cca84ddc575214",
"md5": "c897a60cb806b3155824ccf003205c01",
"sha256": "b842c2b4e92fb63f87e061d4114f0f75d96715c754efcc912e4bcd25a91293a2"
},
"downloads": -1,
"filename": "sleepguard-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c897a60cb806b3155824ccf003205c01",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 16524,
"upload_time": "2024-07-05T18:26:52",
"upload_time_iso_8601": "2024-07-05T18:26:52.522634Z",
"url": "https://files.pythonhosted.org/packages/0d/98/7d79f237796138bd3a853766d327444098b0afa8d5a582cca84ddc575214/sleepguard-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b01ee0416bfff743a25569c0e80b4e4a637c37b2377ed51132014507e4555a38",
"md5": "0a615f4ef942b9de0ce3d57fb0f08b6d",
"sha256": "0d3e390ed54b5f5f51c1b65b4d4abeb4d8cc2acf8764269dbf5021d996e74422"
},
"downloads": -1,
"filename": "sleepguard-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "0a615f4ef942b9de0ce3d57fb0f08b6d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 24754,
"upload_time": "2024-07-05T18:26:53",
"upload_time_iso_8601": "2024-07-05T18:26:53.634413Z",
"url": "https://files.pythonhosted.org/packages/b0/1e/e0416bfff743a25569c0e80b4e4a637c37b2377ed51132014507e4555a38/sleepguard-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-05 18:26:53",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "reidswanson",
"bitbucket_project": "sleepguard",
"lcname": "sleepguard"
}
