merge branch 'develop'

Author: adambonneruk

awake.pyw

@@ -1,35 +1,52 @@
-# "Stay Awake, Don't Sleep!" utility (in Python) ![](icon/22.png)
+# awake
+prevent the system from entering sleep or turning off the display
 
-## Background
-"Stay Awake, Don't Sleep!" is a small Python utility designed to keep a machine/workstation from going idle. Leveraging the awesome PyAutoGUI library to impersonate a human being and programmatically control the keyboard, this utility presses the scroll lock key ~2 times a second.
+- [Background and Information](#background-and-information)
+- [Usage](#usage)
+- [Development](#development)
+  - [Python venv and pip](#python-venv-and-pip)
+  - [Compile](#compile)
+- [Further Reading](#further-reading)
+  - [Useful Links](#useful-links)
 
-I built this tool to solve a problem, learn about ```tkinter```, ```pyautogui``` and python ```threading```. Displaying a basic GUI while a second thread takes care of the automation. Interestingly I always press the scroll lock key twice, this means if you started the utility, came back to your machine 30 minutes later and closes it, the "even" number of presses means your scroll lock "state" would be the same as before you left!
+## Background and Information
+This simple windows app keeps a machine/workstation from going idle. Oriignally this application pressed the Scroll Lock button twice every second to keep windows "awake". The recent version now uses a native windows call "```ES_DISPLAY_REQUIRED```" to keep the display on instead.
+
+I built this tool to solve a problem, learn about ```tkinter```, ```pyautogui``` and python ```threading```. Displaying a basic GUI while a second thread takes care of the automation. You can still see that code in as recent as the [v0.4.0](https://github.com/adambonneruk/awake/tree/v0.4.0) tag.
 
 ## Usage
-The App starts in the system tray (with the ![Z](icon/22.png) icon).
+The App starts in the system tray (with the [Z] icon).
 
 ![Running in the Windows 10 System Tray](.screenshot/in-the-tray.png)
 
 A right-click context menu allowing you to "```Show```" the main GUI  (below) or "```Quit```" and close the application. The GUI close cross again minimises to the system tray.
 
 ![Running awake.pyw on Windows 10](.screenshot/stay-awake-dont-sleep.png)
 
-What you would want to use this application for? I have no idea!
-
-## Install Guide (using _chololatey_ and _pip_)
-Python, PIP, PyAutoGUI, and PyStray
-```powershell
-# install python using chocolatey
-choco install python -y
-# install pip using python
-python -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --upgrade pip
-# install pyautogui using pip
-python -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --upgrade pyautogui
-# install pylance using pip
-python -m pip install --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org --upgrade pystray
-# run awake.pyw
-py ./awake.pyw
+## Development
+
+### Python venv and pip
+```ps
+# create a venv named venv
+py -m venv venv
+
+# run venv
+venv/Scripts/Activate.ps1
+
+# install pip prereqs
+py -m pip install -r .\requirements.txt --trusted-host pypi.python.org --trusted-host files.pythonhosted.org --trusted-host pypi.org
+```
+
+### Compile
+```ps
+# run manually
+pyinstaller "src/awake.spec" --noconfirm
+
+# run automatically
+py "tools/make.py"
 ```
 
-## Known Issues
-- Automatically pressing the scroll lock whilst trying to drag (& drop) in Windows causes the action to stop fail, resulting in unwanted behaviour when selecting or moving objects
+## Further Reading
+### Useful Links
+- https://stackoverflow.com/questions/58273482/can-pyautogui-be-used-to-prevent-windows-screen-lock
+- https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setthreadexecutionstate

icon/22.png

@@ -0,0 +1,10 @@
+altgraph == 0.17.3
+pefile == 2023.2.7
+Pillow == 10.0.0
+pip == 23.2.1
+pyinstaller == 5.13.0
+pyinstaller-hooks-contrib == 2023.6
+pystray == 0.19.4
+pywin32-ctypes == 0.2.2
+setuptools == 65.5.0
+six == 1.16.0