This commit Adds new time_tracker in Python

Author: abdallah1097

Python/Desktop Time Tracker/Readme.md

@@ -0,0 +1,34 @@
+# Time Tracker
+## Description
+This script is written in python and can be used to track user time used on Desktop Applications in a pie chart format
+* The script is mainly built using [xdotool](https://www.freebsd.org/cgi/man.cgi?query=xdotool&apropos=0&sektion=1&manpath=FreeBSD+8.1-RELEASE+and+Ports&format=html)
+
+### Language
+- [X] Python
+
+### Installation
+```bash
+$ sudo apt-get install xdotool
+$ pip install subprocess
+$ pip install time
+$ pip install matplotlib
+$ pip install yaml
+``` 
+
+### Usage
+Run
+```bash
+python time_tracker.py
+```
+The outpus should be in script directory:
+
+![pie_chart_example](time_tracking_pie_chart.png)
+#### Steps to create the virtual environment (for windows)
+1. pip install virtualenv
+2. pip install pipenv
+3. pipenv --help (for help)
+4. pipenv install
+5. pipenv shell
+6. pip install the packages
+7. execute the program
+

Python/Desktop Time Tracker/config.yaml

@@ -0,0 +1,2 @@
+update_frequency: 1
+pie_chart_update_frequency: 1

Python/Desktop Time Tracker/time_tracker.py

@@ -0,0 +1,83 @@
+#!/usr/bin/env python3
+import os
+import subprocess
+import time
+from argparse import ArgumentParser
+
+import matplotlib.pyplot as plt
+import yaml
+
+
+def execute_terminal_command(command):
+    """
+    THIS FUNCTION EXECUTES A TERMINAL COMMAND USING SUBPROCESS MODULE
+    """
+    try:
+        return subprocess.check_output(command).decode("utf-8").strip()
+    except subprocess.CalledProcessError:
+        pass
+
+
+def update_pie_chart(labels, sizes, log_dir):
+    """
+    THIS FUNCTION SAVES/UPDATES PIE CHART USING: labels, sizes
+    AND SAVES IT INTO log_dir
+    """
+    # Plotting pie chart
+    fig = plt.figure()
+    plt.pie(sizes, labels=labels, autopct="%1.1f%%", shadow=True, startangle=140)
+    plt.axis("equal")
+    plt.savefig(logdir + "/time_tracking_pie_chart.png")
+    plt.close(fig)
+
+
+if __name__ == "__main__":
+    parser = ArgumentParser()
+    parser.add_argument(
+        "--config",
+        type=str,
+        required=False,
+        default="config.yaml",
+        help="path to config",
+    )
+    args = parser.parse_args()
+
+    with open(args.config, mode="r") as fp:
+        config = yaml.safe_load(fp)
+
+    update_frequency = config["update_frequency"]  # Uodate time in seconds
+    pie_chart_update_frequency = config[
+        "pie_chart_update_frequency"
+    ]  # Uodate time in seconds
+    applist = []  # List that stores all apps names
+    winlist = []  # List that stores corresponding information to those apps in applist
+
+    logdir = os.getcwd()  # Logs folder within the same working directory
+
+    while True:
+        time.sleep(update_frequency)  # Wait for the update frequency
+        frpid = execute_terminal_command(
+            ["xdotool", "getactivewindow", "getwindowpid"]
+        )  # Get the current opened window process id
+        frname = execute_terminal_command(
+            ["xdotool", "getactivewindow", "getwindowname"]
+        )  # Get the current opened window name
+
+        app = execute_terminal_command(
+            ["ps", "-p", frpid, "-o", "comm="]
+        )  # Obtain the app name using ps terminal command
+
+        # adding the app to the app list
+        if not app in applist:
+            applist.append(app)
+        checklist = [item[1] for item in winlist]
+        if not frname in checklist:
+            winlist.append([app, frname, 1 * update_frequency])
+        else:
+            winlist[checklist.index(frname)][2] = (
+                winlist[checklist.index(frname)][2] + 1 * update_frequency
+            )
+
+        # TODO: Make pie-chart update is based on pie_chart_update_frequency variable
+        # TODO: Organize pie charts and maybe don't delete previous pie charts and appreviate from them instead
+        update_pie_chart(applist, [x[-1] for x in winlist], logdir)