ccrutchf / wakepy

Cross-platform keep-awake with python

   

⏰😴 wakepy

Cross-platform wakelock written in Python.

• It has zero required python dependencies.
• Python API for application and library developers, and a wakepy executable (CLI) for everyone.

Supports

• Python: 3.7 to 3.12
• OS: Windows, Linux and macOS

What it can do?

Wakepy has two main modes:

1. keep.running: keep your tasks & CPU running even if you lock your session and turn screenlock on; This mode prevents your system from going to sleep (e.g. for training machine learning models, video encoding, web scraping, ...)
2. keep.presenting: same as keep.running but keep also the screen awake and prevent automatic screen lock & screensaver (e.g. for showing a video, updating dashboard, monitoring apps, ...)

Used by

• viskillz-blender — Generating assets of Mental Cutting Test exercises
• mpc-autofill — Automating MakePlayingCards' online ordering system
• lakeshorecryotronics/python-driver — Lake Shore instruments python Driver
• UCSD-E4E/baboon-tracking — In pipelines of a Computer Vision project tracking baboons
• davlee1972/upscale_video — Upscaling video using AI
• minarca — Cross-platform data backup software

Documentation

👉 wakepy.readthedocs.io

⚖️👑 Key selling points

• Wakepy supports multiple operating systems and desktop environments
• Wakepy has permissive MIT licence
• It has a simple command line interface and a python API
• Wakepy has zero required python dependencies
  • For using the D-Bus methods on Linux, one may use jeepney (optional)

Deprecation timeline (wakepy 0.7.0+)

Since deprecations may affect many users, they are communicated well before and time is given for project maintainers for migration. Timeline:

• June 11th 2023: Release wakepy 0.7.0 with DeprecationWarnings for keepawake, set_keepawake and unset_keepawake, and the CLI option -s. Migration Guide published.
• September 1st 2023 (or few days later): Release wakepy without the deprecated keepawake, set_keepawake and unset_keepawake; Only new API supported.