https://github.com/fohrloop/wakepy
Cross-platform keep-awake with python
https://github.com/fohrloop/wakepy
caffeine keepawake nosleep prevent-screen-lock preventing-sleep python
Last synced: 17 days ago
JSON representation
Cross-platform keep-awake with python
- Host: GitHub
- URL: https://github.com/fohrloop/wakepy
- Owner: fohrloop
- License: mit
- Created: 2021-01-12T05:57:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-21T12:28:58.000Z (about 1 month ago)
- Last Synced: 2025-04-21T12:30:18.538Z (about 1 month ago)
- Topics: caffeine, keepawake, nosleep, prevent-screen-lock, preventing-sleep, python
- Language: Python
- Homepage:
- Size: 914 KB
- Stars: 219
- Watchers: 2
- Forks: 14
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
   [](https://github.com/astral-sh/ruff)   
[](https://pypi.python.org/pypi/wakepy) 
Cross-platform wakelock / keep-awake / stay-awake written in Python.
## What is wakepy?
Wakepy is a package with an Python API and a CLI tool for *keeping a system awake*. It has two main modes:
⌛ **Keeping CPU awake**: For long running tasks. Inhibit the automatic, timer based sleep or suspend action, but allow screenlock and screensaver turning on and monitor turning off. *E.g.* for training machine learning models, video encoding and web scraping. (See: keep.running)
🖥️ **Keeping screen awake**: For long running tasks which require also the screen on and screenlock and screensaver inhibited. *E.g.* for showing a video and dashboard / monitoring apps. (See: keep.presenting)
## Supported runtime environments
Wakepy may keep the following systems awake. ⌛: keep.running mode, 🖥️:keep.presenting mode.
Runtime environment
Methods
Modes
Windows[1]
SetThreadExecutionState
⌛ 🖥️
macOS[2]
caffeinate
⌛ 🖥️
Unix + GNOME[3]
org.gnome.SessionManager
org.freedesktop.ScreenSaver
⌛ 🖥️
Unix + KDE Plasma[4]
org.freedesktop.PowerManagement
org.freedesktop.ScreenSaver
⌛ 🖥️
Unix + Freedesktop.org DE[5]
org.freedesktop.PowerManagement
org.freedesktop.ScreenSaver
⌛ 🖥️
Unix above refers to any Unix-like systems which might use such DEs, e.g. Linux or FreeBSD. See also: [Wakepy roadmap](#wakepy-roadmap).
## Installing
Wakepy supports CPython 3.7 to 3.13 and PyPy 3.8 to 3.10, and may be installed from [PyPI](https://pypi.org/project/wakepy/) with
```
pip install wakepy
```
Wakepy can also be installed from conda-forge with
```
conda install wakepy
```
For more details and install options, see: [Installing documentation](https://wakepy.readthedocs.io/stable/installing.html).
> [!NOTE]
> To get the `wakepy` CLI command working, you might need to restart the shell / terminal application.
## Why wakepy?
Here's some reasons why you might want to consider using wakepy:
- 🙅🏼♂️ Non-disruptive methods ✅
- No mouse wiggling or pressing random keys like F15. Wakepy is completely non-disruptive. It uses the APIs and programs the system provides for keeping a system awake.
- 🛡️ Safe to crash 💥
- No changing of any system settings; killing the process abruptly will not leave the keepawake on, and will not require any manual clean-up.
- 🚨 For security reasons 🔒
- With
keep.runningmode you can disable just the automatic suspend and keep the automatic screen lock untouched. - 🌐 You need a cross-platform solution 🦸
- Same code works on Windows, macOS and Linux on multiple different Desktop Environments.
- 💪 You want to have more control ⚙️
- It is possible to whitelist or blacklist the used wakepy Methods. It is also possible to prioritize them and define a on-fail action in case activating a wakepy mode fails.
- ✂️ You want to keep the amount of dependencies low 📦
- If you're running wakepy on Linux, jeepney (a dependecy free package) is required for D-Bus based methods. On Python 3.7, typing-extensions is needed for typing. Otherwise: wakepy has no python dependencies.
- ⚖️ Package needs to have a permissive licence ✔️
- Wakepy is licenced under permissive MIT License.
## Command line interface (CLI)
To keep system from sleeping, run
```
wakepy
```
For presentation mode, add `-p` flag. See also: CLI API.
## Basic usage within Python
In the simplest case, keeping a system running long running task with wakepy would be in python (See: keep.running):
```python
from wakepy import keep
with keep.running():
# Do something that takes a long time. The system may start screensaver
# / screenlock or blank the screen, but CPU will keep running.
```
If you want to *also* prevent screen lock and screen blank, use the keep.presenting mode:
```python
from wakepy import keep
with keep.presenting():
# Do something that takes a long time and requires the screen to be awake
```
> [!TIP]
> See the [User Guide](https://wakepy.readthedocs.io/stable/user-guide.html) and the available wakepy [Modes](https://wakepy.readthedocs.io/stable/modes.html) and [Methods](https://wakepy.readthedocs.io/stable/methods-reference.html)
> [!NOTE]
> Wakepy API is still experimental 🚧
>
> Since wakepy is still 0.x.x, the API might change without further notice from
> one release to another. After that, breaking changes should occur only part of
> a major release (e.g. 1.x.x -> 2.0.0).
## Where wakepy is used?
- [aTrain](https://github.com/JuergenFleiss/aTrain) — transcription of speech recordings utilizing machine learning models.
- [mpc-autofill](https://github.com/chilli-axe/mpc-autofill) — Automating MakePlayingCards' online ordering system
- [LiveboxMonitor](https://github.com/p-dor/LiveboxMonitor) — Graphical user interface for routers (French project)
- [FOLON-FO4Downgrader](https://github.com/Fallout-London/FOLON-FO4Downgrader) — Tool for reverting to a previous version of a game (Fallout 4)
- [BD_to_AVP](https://github.com/cbusillo/BD_to_AVP) — 3D Blu-ray to Apple Vision Pro converter
- [davlee1972/upscale_video](https://github.com/davlee1972/upscale_video) — Upscaling video using AI
- [AYAB - All Yarns Are Beautiful](https://github.com/AllYarnsAreBeautiful/ayab-desktop/) — Automated knitting software
- [minarca](https://github.com/ikus060/minarca) — Cross-platform data backup software
- [OceanOptics/Inlinino](https://github.com/OceanOptics/Inlinino) — Data logger for oceanography
- [cogent3/ensembl_tui](https://github.com/cogent3/ensembl_tui) — Obtaining dumps of Ensembl MySQL databases
- [lakeshore](https://github.com/lakeshorecryotronics/python-driver) — Lake Shore instruments python Driver
- [UCSD-E4E/baboon-tracking](https://github.com/UCSD-E4E/baboon-tracking) — In pipelines of a Computer Vision project tracking baboons
- [pysimai](https://github.com/ansys/pysimai) — A Python wrapper for Ansys SimAI
- [viskillz-blender](https://www.sciencedirect.com/science/article/pii/S2352711023000249) — Generating assets of Mental Cutting Test exercises
## Links
- 🖤 GitHub: [github.com/fohrloop/wakepy](https://github.com/fohrloop/wakepy)
- 🐍 PyPI: [pypi.org/project/wakepy](https://pypi.org/project/wakepy/)
- 📖 Documentation: [wakepy.readthedocs.io/stable](https://wakepy.readthedocs.io/stable)
- 📝 Changelog: [wakepy.readthedocs.io/stable/changelog.html](https://wakepy.readthedocs.io/stable/changelog.html)
## Wakepy roadmap
Wakepy vision is to support *any*† environment which runs Python. The following runtime environments will get support in the future†. Please vote or comment on the issue to raise them towards top of priorities. I'm also happy to receive PRs or comments explaining how it could be implemented.
†: if technically possible.
Runtime environment
Issue
WSL
wakepy/#36
cygwin
wakepy/#363
Unix + Cinnamon
wakepy/#312
Unix + Xfce
wakepy/#311
Unix + Mate
wakepy/#314
Unix + LXQt
wakepy/#313
Unix + systemd
wakepy/#335
ChromeOS
wakepy/#364
Android
wakepy/#358
Jupyter Notebook (hosted on eg. Google Colab)
wakepy/#195
Browser (Pyodide, PyPy.js, Brython, Transcrypt, Skulpt)
wakepy/#362
If you have ideas or comments, please post yours on [wakepy/#317](https://github.com/fohrloop/wakepy/discussions/317).
## Licenses
The contents of this repository are licensed with [MIT License](https://github.com/fohrloop/wakepy/blob/main/LICENSE.txt), which is permissive and allows you to use the code as part of any application or library, commercial or not, with the following exception: The GitHub Invertocat logo used in the social share image is property of GitHub, downloaded from [github.com/logos](https://github.com/logos) and is used under the terms specified by GitHub.
---------------
## Footnotes
| |
| ------------------------------------------------------------------------------------------------------------------------------------------- |
| [1] Windows XP or higher. Windows Server 2003 or higher. |
| [2] Mac OS X 10.8 Mountain Lion (July 2012) or newer. |
| [3] GNOME 2.24 (Sept 2008) onwards. |
| [4] KDE Plasma 5.12.90 (May 2018) onwards. |
| [5] Freedesktop.org compliant Desktop Environments on Unix-like (Linux/BSD) system which implements the listed D-Bus interfaces. |