Merge pull request #3 from KingWaffleIII/dev

v1.2.0

Author: KingWaffleIII

.gitignore

@@ -6,4 +6,5 @@ config.json
 *.zip
 dist/
 .idea
-*.bak
+*.bak
+.vscode/

AntiProcrastinator.spec

@@ -1,10 +1,10 @@
 # -*- mode: python ; coding: utf-8 -*-
 
 main = Analysis(
-    ['main.py'],
+    ["main.py"],
     pathex=[],
     binaries=[],
-    datas=[('annoying.mp3', '.')],
+    datas=[("annoying.mp3", "."), ("icon.png", "."), ("icon2.png", ".")],
     hiddenimports=[],
     hookspath=[],
     hooksconfig={},
@@ -19,14 +19,14 @@ main_exe = EXE(
     main.binaries,
     main.datas,
     [],
-    name='AntiProcrastinator',
+    name="AntiProcrastinator",
     debug=False,
     bootloader_ignore_signals=False,
     strip=False,
     upx=True,
     upx_exclude=[],
     runtime_tmpdir=None,
-    console=True,
+    console=False,
     disable_windowed_traceback=False,
     argv_emulation=False,
     target_arch=None,
@@ -35,9 +35,9 @@ main_exe = EXE(
 )
 
 configurator = Analysis(
-    ['configurator.py'],
+    ["configurator.py"],
     pathex=[],
-    binaries=[],
+    binaries=[("icon.png", "."), ("icon2.png", ".")],
     datas=[],
     hiddenimports=[],
     hookspath=[],
@@ -53,7 +53,7 @@ configurator_exe = EXE(
     configurator.binaries,
     configurator.datas,
     [],
-    name='Configurator',
+    name="Configurator",
     debug=False,
     bootloader_ignore_signals=False,
     strip=False,

README.md

@@ -1,41 +1,45 @@
 # AntiProcrastinator
 
+## Windows only, cross-platform support WIP
+
 A Python script that yells at you for doing things you shouldn't be. Yes, I was procrastinating when I made this.
 
 Features:
 
-- Immediately yells at you on launch
-- Monitors the focused window and yells at you if you're procrastinating
-    - Matches blacklisted strings in the window name
-- Pauses any media you're playing to yell at you
-- Regularly reminds you how close your deadline is
-- Customisable insults
-- Realtime config changes (no need to restart the program)
-- Completely customisable actions (e.g. play a sound, print to console, etc.)
-  - Extending the project and adding your own actions is very simple by simply extending `action.Action`.
-  - You can make actions from emailing someone to shutting down your computer.
+-   Immediately yells at you on launch
+-   Monitors the focused window and yells at you if you're procrastinating
+    -   Matches blacklisted strings in the window name
+-   Pauses any media you're playing to yell at you
+-   Regularly reminds you how close your deadline is
+-   Customisable insults
+-   Realtime config changes (no need to restart the program)
+-   Completely customisable actions (e.g. play a sound, print to console, etc.)
+    -   Extending the project and adding your own actions is very simple by simply extending `action.Action`.
+    -   You can make actions from emailing someone to shutting down your computer.
+-   Break feature with customisable duration
 
 ## Usage:
 
-- [Download the latest release](https://github.com/KingWaffleIII/AntiProcrastinator/releases) and run once.
-- Run `configurator.exe` to edit the config.
-- Run `AntiProcrastinator.exe`!
-
-  - **Available actions:**
-    - `Sleep`
-    - `Say`
-    - `Exit`
-    - `Playsound`
-    - `Closewindow`
-    - `Print`
-
-  - **Wildcards:**
-    - `{deadline}` -> `get_deadline()`
-    - `{insult}` -> `get_insult()`
-    - `{timer_diff}` -> `get_timer_diff_in_text()`
-    - `{window}` -> `window`
-  
-- (recommended but optional) Add to Task Scheduler or equivalent (put the executable in `shell:common startup` in Windows Explorer) to run on startup
+-   [Download the latest release](https://github.com/KingWaffleIII/AntiProcrastinator/releases) and run once.
+-   Run `configurator.exe` to edit the config.
+-   Run `AntiProcrastinator.exe`!
+
+    -   **Available actions:**
+
+        -   `Sleep`
+        -   `Say`
+        -   `Exit`
+        -   `Playsound`
+        -   `Closewindow`
+        -   `Notify`
+
+    -   **Wildcards:**
+        -   `{deadline}` -> `get_deadline()`
+        -   `{insult}` -> `get_insult()`
+        -   `{timer_diff}` -> `get_timer_diff_in_text()`
+        -   `{window}` -> `window`
+
+-   (recommended but optional) Add to Task Scheduler or equivalent (put the executable in `shell:common startup` in Windows Explorer) to run on startup
 
 This runs the script on startup and in the background.
 Enable this if you use Task Scheduler else TTS will not work:
@@ -44,4 +48,4 @@ Enable this if you use Task Scheduler else TTS will not work:
 
 You can run the Python script from cloning or the executable from releases, **but make sure to have `config.json` in the same directory**.
 
-Note: when using `actions.PlaySound`, remember to add the sound files to `AntiProcrastinator.spec` if using Pyinstaller.
+Note: when using `actions.PlaySound`, remember to add the sound files to `AntiProcrastinator.spec` if using Pyinstaller.

actions/__init__.py

@@ -6,4 +6,4 @@
 from .playsound import Playsound as Playsound
 from .say import Say as Say
 from .sleep import Sleep as Sleep
-from .print import Print as Print
+from .notify import Notify as Notify

actions/defaults.py

@@ -9,7 +9,7 @@
 # actions.Exit
 # actions.Playsound
 # actions.Closewindow
-# actions.Print
+# actions.Notify
 
 # Wildcards:
 # {deadline} -> get_deadline()
@@ -21,45 +21,72 @@
 # Avoid using Python, rather use the available functions in util.functions.
 # If you want to use something not implemented, you can add it to util/functions.py.
 
-OnStartupActionSet = actions.Actionset([
-    actions.Say(
-        text="Good luck bro, the deadline has passed.",
-        pause_media=True,
-        condition_func="lambda: util.functions.has_deadline_passed()",
-    ),
-    actions.Exit(
-        condition_func="lambda: util.functions.has_deadline_passed()",
-    ),
-    actions.Say(
-        text="{deadline}Time to lock in!",
-        pause_media=True,
-        condition_func=None,
-    ),
-])
+OnStartupActionSet = actions.Actionset(
+    [
+        actions.Say(
+            text="Good luck bro, the deadline has passed.",
+            pause_media=True,
+            condition_func="lambda: util.functions.has_deadline_passed()",
+        ),
+        actions.Exit(
+            condition_func="lambda: util.functions.has_deadline_passed()",
+        ),
+        actions.Say(
+            text="{deadline}Time to lock in!",
+            pause_media=True,
+            condition_func=None,
+        ),
+    ]
+)
 
-OnProcrastinationActionSet = actions.Actionset([
-    actions.Say(
-        text="{deadline}{insult}", pause_media=True, condition_func="lambda: not util.functions.check_timer_elapsed_time(60)"
-    ),
-    actions.Sleep(
-        sleep_time=60,
-        condition_func="lambda: not util.functions.check_timer_elapsed_time(60)",
-    ),
-    actions.Say(
-        text="Nah you're finished, you've been procrastinating for {timer_diff}! {insult}",
-        pause_media=True,
-        condition_func=None,
-    ),
-    actions.Playsound(
-        file_path=r"{runtime_dir}\annoying.mp3",
-    ),
-])
+OnProcrastinationActionSet = actions.Actionset(
+    [
+        actions.Say(
+            text="{deadline}{insult}",
+            pause_media=True,
+            condition_func="lambda: not util.functions.check_timer_elapsed_time(60)",
+        ),
+        actions.Sleep(
+            sleep_time=60,
+            condition_func="lambda: not util.functions.check_timer_elapsed_time(60)",
+        ),
+        actions.Say(
+            text="Nah you're finished, you've been procrastinating for {timer_diff}! {insult}",
+            pause_media=True,
+            condition_func=None,
+        ),
+        actions.Playsound(
+            file_path=r"{runtime_dir}\annoying.mp3",
+        ),
+    ]
+)
 
-AfterProcrastinationActionSet = actions.Actionset([
-    actions.Print(text="[{timestamp}] You were procrastinating for {timer_diff} on {window}!"),
-    actions.Say(
-        text="You retard, you were procrastinating for {timer_diff}! {insult}",
-        pause_media=True,
-        condition_func=None,
-    ),
-])
+AfterProcrastinationActionSet = actions.Actionset(
+    [
+        actions.Notify(
+            # text="[{timestamp}] You were procrastinating for {timer_diff} on {window}!"
+            text="You were procrastinating for {timer_diff} on {window}!"
+        ),
+        actions.Say(
+            text="You retard, you were procrastinating for {timer_diff}! {insult}",
+            pause_media=True,
+            condition_func=None,
+        ),
+    ]
+)
+
+BreakActionSet = actions.Actionset(
+    [
+        actions.Say(
+            text="Well done, you can relax for a bit.",
+            pause_media=True,
+            condition_func=None,
+        ),
+        actions.Sleep(600),
+        actions.Say(
+            text="Break's over! Get back to work, those As aren't gonna earn themselves.",
+            pause_media=True,
+            condition_func=None,
+        ),
+    ]
+)

actions/print.py actions/notify.pyactions/print.py renamed to actions/notify.py

@@ -1,11 +1,13 @@
+from util.functions import icon
+
 from .action import Action
 
 
-class Print(Action):
+class Notify(Action):
     def __init__(self, text: str, condition_func: str = None):
         """
-        Creates an action that prints to the console.
-        :param text: the text to print.
+        Creates an action that sends a desktop notification.
+        :param text: the text to send.
         :param condition_func: the condition to check before executing the action, as a string cast lambda function.
         """
         super().__init__(condition_func)
@@ -20,20 +22,23 @@ def to_json(self):
         import util
 
         if self.condition_func is not None:
-            condition_func_str = util.functions.deconstruct_condition_function(self.raw_condition_func)
+            condition_func_str = util.functions.deconstruct_condition_function(
+                self.raw_condition_func
+            )
             condition_func = {
                 "function": condition_func_str[0],
                 "inverse": condition_func_str[1],
-                "args": condition_func_str[2]
+                "args": condition_func_str[2],
             }
         else:
             condition_func = None
-        return {"action": "Print", "condition_func": condition_func, "text": self.text}
+        return {"action": "Notify", "condition_func": condition_func, "text": self.text}
 
     async def execute(self):
         if not await super().execute():
             return False
 
         import util
+
         text = util.functions.replace_wildcards(self.text)
-        print(text)
+        icon.notify(text)

configurator.py

@@ -19,6 +19,7 @@ def action_set_menu():
             "On Startup": util.config.config["on_startup"],
             "On Procrastination": util.config.config["on_procrastination"],
             "After Procrastination": util.config.config["after_procrastination"],
+            "Break": util.config.config["break"],
         }
 
         choice = inquirer.select(
@@ -27,6 +28,7 @@ def action_set_menu():
                 "On Startup",
                 "On Procrastination",
                 "After Procrastination",
+                "Break",
                 "Deadlines",
                 "Blacklist",
                 "Whitelist",

icon.png

@@ -3,16 +3,20 @@
 import multiprocessing
 import multiprocessing.popen_spawn_win32 as forking
 import os
-import time
 import sys
+import threading
+import time
+
 import win32gui
 
 import actions
 import util
 
 if not util.config.config_exists("config.json"):
-    print("Config file not found. Please run the configurator first.")
-    sys.exit(-1)
+    # print("Config file not found. Please run the configurator first.")
+    # sys.exit(-1)
+    util.config.create_config("config.json")
+    print("Config file created!")
 
 try:
     util.config.load_config("config.json")
@@ -68,8 +72,10 @@ async def watch():
     proc = None
     while True:
         window = win32gui.GetWindowText(win32gui.GetForegroundWindow())
-        if window != "" and any(
-            x in window.lower() and x not in util.config.config["whitelist"] for x in util.config.config["blacklist"]
+        if (
+            window
+            and any(x in window.lower() for x in util.config.config["blacklist"])
+            and not any(x in window.lower() for x in util.config.config["whitelist"])
         ):
             if proc is None or not proc.is_alive():
                 util.functions.start_timer()
@@ -88,7 +94,12 @@ async def watch():
         time.sleep(1)
 
 
-if __name__ == "__main__":
-    multiprocessing.freeze_support()
+def run():
     asyncio.run(startup())
     asyncio.run(watch())
+
+
+if __name__ == "__main__":
+    multiprocessing.freeze_support()
+    threading.Thread(target=run).start()
+    util.functions.icon.run()