HackaProfile 0.1.0__tar.gz → 1.2.0__tar.gz

{hackaprofile-0.1.0 → hackaprofile-1.2.0}/HackaProfile.egg-info/PKG-INFO

@@ -1,7 +1,10 @@
 Metadata-Version: 2.4
 Name: HackaProfile
-Version: 0.1.0
+Version: 1.2.0
 Summary: A simple tool to automatically update Slack user profile based on their Hackatime/Wakatime heartbeat!
+Project-URL: Repository, https://github.com/zibuyin/HackaProfile
+Project-URL: Issues, https://github.com/zibuyin/HackaProfile/issues
+Project-URL: Homepage, https://github.com/zibuyin/HackaProfile
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: annotated-doc==0.0.4
@@ -36,6 +39,7 @@ Requires-Dist: urllib3==2.7.0
 Requires-Dist: wcwidth==0.8.1
 Requires-Dist: Werkzeug==3.1.8
 Requires-Dist: platformdirs==4.10.0
+Requires-Dist: Jinja2==3.1.6
 
 # HackaProfile
 <img src="./assets/icon.png" width=30% alt="HackaProfile logo"></img>
@@ -48,13 +52,16 @@ Requires-Dist: platformdirs==4.10.0
 - More features #TODO ~~(I don't wanna write README.md >:3)~~
 
 ## installation
-> [!TIP]
-> One line install does not work yet!
-### MacOS
-`brew install hackaprofile`
-### Linux
-Debian/Ubuntu:
-`apt install hackaprofile`
+### Install pipx
+Check [pipx docs](https://pipx.pypa.io/stable/how-to/install-pipx/)
+
+### Install Hackaprofile
+```bash
+pipx install hackaprofile
+hackaprofile setup
+```
+
+Then follow the guided setup
 
 ## Placeholder Variables
 A key feature of HackaProfile is that it allows you to customise your profile however you like (just like how you would change it on Slack/other platforms) BUT it **also allows you to use dynamic values** (i.e. Placeholder variables).
@@ -77,3 +84,35 @@ Example
 - `{{entity}}` Path to the file workng on
 - `{{machine}}` Current machine's hostname
 
+## Logic Operators
+You could not only dynamically set variables, but you could also **choose how they are represented dynamically*
+
+### If Statements:
+`{% if [condition] %} ... {% elif [condition] %} ... {% else %} ... {% endif %}
+### Filters:
+
+Transforms the string to lowercase
+```
+{{string|lower}}
+```
+
+Transforms the STRING to UPPERCASE
+```
+{{string|upper}}
+```
+
+Transforms the String into a Title format
+```
+{{string|title}}
+```
+
+### Escaping:
+```
+{{ "string to be escaped" }}
+```
+or
+```
+{% raw %}
+string to be escaped
+{% endraw %}
+```

{hackaprofile-0.1.0 → hackaprofile-1.2.0}/HackaProfile.egg-info/requires.txt

@@ -30,3 +30,4 @@ urllib3==2.7.0
 wcwidth==0.8.1
 Werkzeug==3.1.8
 platformdirs==4.10.0
+Jinja2==3.1.6

{hackaprofile-0.1.0 → hackaprofile-1.2.0}/PKG-INFO

@@ -1,7 +1,10 @@
 Metadata-Version: 2.4
 Name: HackaProfile
-Version: 0.1.0
+Version: 1.2.0
 Summary: A simple tool to automatically update Slack user profile based on their Hackatime/Wakatime heartbeat!
+Project-URL: Repository, https://github.com/zibuyin/HackaProfile
+Project-URL: Issues, https://github.com/zibuyin/HackaProfile/issues
+Project-URL: Homepage, https://github.com/zibuyin/HackaProfile
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: annotated-doc==0.0.4
@@ -36,6 +39,7 @@ Requires-Dist: urllib3==2.7.0
 Requires-Dist: wcwidth==0.8.1
 Requires-Dist: Werkzeug==3.1.8
 Requires-Dist: platformdirs==4.10.0
+Requires-Dist: Jinja2==3.1.6
 
 # HackaProfile
 <img src="./assets/icon.png" width=30% alt="HackaProfile logo"></img>
@@ -48,13 +52,16 @@ Requires-Dist: platformdirs==4.10.0
 - More features #TODO ~~(I don't wanna write README.md >:3)~~
 
 ## installation
-> [!TIP]
-> One line install does not work yet!
-### MacOS
-`brew install hackaprofile`
-### Linux
-Debian/Ubuntu:
-`apt install hackaprofile`
+### Install pipx
+Check [pipx docs](https://pipx.pypa.io/stable/how-to/install-pipx/)
+
+### Install Hackaprofile
+```bash
+pipx install hackaprofile
+hackaprofile setup
+```
+
+Then follow the guided setup
 
 ## Placeholder Variables
 A key feature of HackaProfile is that it allows you to customise your profile however you like (just like how you would change it on Slack/other platforms) BUT it **also allows you to use dynamic values** (i.e. Placeholder variables).
@@ -77,3 +84,35 @@ Example
 - `{{entity}}` Path to the file workng on
 - `{{machine}}` Current machine's hostname
 
+## Logic Operators
+You could not only dynamically set variables, but you could also **choose how they are represented dynamically*
+
+### If Statements:
+`{% if [condition] %} ... {% elif [condition] %} ... {% else %} ... {% endif %}
+### Filters:
+
+Transforms the string to lowercase
+```
+{{string|lower}}
+```
+
+Transforms the STRING to UPPERCASE
+```
+{{string|upper}}
+```
+
+Transforms the String into a Title format
+```
+{{string|title}}
+```
+
+### Escaping:
+```
+{{ "string to be escaped" }}
+```
+or
+```
+{% raw %}
+string to be escaped
+{% endraw %}
+```

{hackaprofile-0.1.0 → hackaprofile-1.2.0}/README.md

@@ -9,13 +9,16 @@
 - More features #TODO ~~(I don't wanna write README.md >:3)~~
 
 ## installation
-> [!TIP]
-> One line install does not work yet!
-### MacOS
-`brew install hackaprofile`
-### Linux
-Debian/Ubuntu:
-`apt install hackaprofile`
+### Install pipx
+Check [pipx docs](https://pipx.pypa.io/stable/how-to/install-pipx/)
+
+### Install Hackaprofile
+```bash
+pipx install hackaprofile
+hackaprofile setup
+```
+
+Then follow the guided setup
 
 ## Placeholder Variables
 A key feature of HackaProfile is that it allows you to customise your profile however you like (just like how you would change it on Slack/other platforms) BUT it **also allows you to use dynamic values** (i.e. Placeholder variables).
@@ -38,3 +41,35 @@ Example
 - `{{entity}}` Path to the file workng on
 - `{{machine}}` Current machine's hostname
 
+## Logic Operators
+You could not only dynamically set variables, but you could also **choose how they are represented dynamically*
+
+### If Statements:
+`{% if [condition] %} ... {% elif [condition] %} ... {% else %} ... {% endif %}
+### Filters:
+
+Transforms the string to lowercase
+```
+{{string|lower}}
+```
+
+Transforms the STRING to UPPERCASE
+```
+{{string|upper}}
+```
+
+Transforms the String into a Title format
+```
+{{string|title}}
+```
+
+### Escaping:
+```
+{{ "string to be escaped" }}
+```
+or
+```
+{% raw %}
+string to be escaped
+{% endraw %}
+```

{hackaprofile-0.1.0 → hackaprofile-1.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "HackaProfile"
-version = "0.1.0"
+version = "1.2.0"
 description = "A simple tool to automatically update Slack user profile based on their Hackatime/Wakatime heartbeat!"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -41,8 +41,13 @@ dependencies = [
     "wcwidth==0.8.1",
     "Werkzeug==3.1.8",
     "platformdirs==4.10.0",
-]
+    "Jinja2==3.1.6",
 
+]
+[project.urls]
+Repository = "https://github.com/zibuyin/HackaProfile"
+Issues = "https://github.com/zibuyin/HackaProfile/issues"
+Homepage = "https://github.com/zibuyin/HackaProfile"
 [project.scripts]
 hackaprofile = "src.frontend:app"
 

hackaprofile-1.2.0/src/agent.py

@@ -0,0 +1,100 @@
+import time
+try:
+    from . import backend
+except ImportError:
+    import backend
+import dotenv
+import os
+from pathlib import Path
+import platformdirs
+from jinja2 import Template
+import logging
+
+logging.basicConfig(
+    format='[%(asctime)s] (Line: %(lineno)d) %(message)s',
+    level=logging.INFO
+)
+
+print("***** WORKER AGENT STARTED *****")
+hackatime = backend.hackatime()
+slack = backend.slack()
+
+
+active_services = ["slack"]
+interval = 10
+HOME = Path.home()
+CONFIG_DIR = Path(platformdirs.user_config_dir("hackaprofile"))
+LOG_DIR = Path(platformdirs.user_log_dir("hackaprofile"))
+
+
+# langauge = ""
+
+pid = os.getpid()
+with open(CONFIG_DIR / "agent.pid", "w") as f:
+    f.write(str(pid))
+    f.close()
+
+def clean_value(value: str) -> str:
+    """
+    Makes the values clean for slack (Value passed for `name` contained unallowed special characters)
+    """
+    return value.replace("<", "").replace(">", "")
+
+def parse_config(config: dict, map):
+    parsed_config = {}
+    for key, template_str in config.items():
+        template = Template(template_str)
+        result = template.render(**map)
+            
+            # # if the config field is empty, don't append it
+            # if key == "status_expiration":
+            #     parsed_value = int(parsed_value)
+            
+
+        parsed_config[key] = result
+
+        # print(parsed)
+    print("---Parsed Config---")
+    logging.info(parsed_config)
+    print("---EO Parsed Config---\n")      
+    return parsed_config
+
+
+while True:
+    json = hackatime.fetch_hb()
+    
+    # for _, field in enumerate(json):
+    #     key = field
+    #     value = json.get(field, "")
+
+    # project = 
+    
+    
+    map = {
+        "id": json.get("id", ""),
+        "created_at": json.get("created_at", ""),
+        "time": json.get("time", ""),
+        "category": json.get("category", ""),
+        "project": json.get("project", ""),
+        "language": json.get("language", ""),
+        "editor": json.get("editor", ""),
+        "operating_system": json.get("operating_system", ""),
+        "machine": json.get("machine", ""),
+        "entity": json.get("entity", "")
+    }
+    
+    
+    
+    print(f'Language: {map["language"]}')
+    print("---HT HB---")
+    logging.info(json)
+    print("---EO HT HB---\n")
+    if "slack" in active_services:
+        print(slack.fetch_config())
+        config = parse_config(slack.fetch_config(), map)
+        print(config)
+        
+        res = slack.set_profile(config)
+        logging.info(res)
+    print("==============================================================")
+    time.sleep(interval)

hackaprofile-1.2.0/src/configTemplate/slack.hackaprofile.conf

@@ -0,0 +1,61 @@
+#--------------------------------------#
+# Don't change this plz (it will break...)
+client_id = "2210535565.11339190985360"
+#--------------------------------------#
+
+# Fill values by uncommenting the field ID line under each label.
+# WARNING: An empty string WILL literally set that field to empty (i.e. clear it), comment out field you don't want to be automatically updated
+
+
+# Docs: https://docs.slack.dev/reference/methods/users.profile.set#profile-fields
+
+# title = 
+# phone = 
+# real_name =
+# display_name = 
+
+# Docs: https://docs.slack.dev/reference/methods/users.profile.set#status
+
+# status_text = 
+# status_emoji =
+
+# ONLY SET TO INT (See docs)
+# status_expiration =
+
+# status_clear_on_focus_end =
+
+
+
+# Hackclub Slack specific
+
+# Github URL
+# Xf09V176UVK5 =
+
+# Birthday (YYYY-MM-DD)
+# Xf0A06G5MKJM =
+
+# Dog or Cat or Infrastructure?
+# Xf09VB64B1PE =
+
+# PFP Credit
+# Xf09V5HE0MU6 =
+
+# Website
+# Xf09V45UG8AZ =
+
+# Fav Languages/Tools
+# Xf09V1775W91 =
+
+# Start Date (YYYY-MM-DD)
+# Xf09UWTTJF6Z =
+
+# Fandoms
+# Xf0AC8RUMQCT =
+
+# Favorite Emoji
+# Xf0APVLWEUC8 =
+
+# HAM Callsign
+# Xf0A06G5TTKK =
+
+# Check README.md

{hackaprofile-0.1.0 → hackaprofile-1.2.0}/src/frontend.py

@@ -33,6 +33,7 @@ import sys
 import psutil
 import signal
 import platformdirs
+import shlex
 
 console = Console()
 
@@ -136,82 +137,86 @@ def setup(force: Annotated[bool, typer.Option("--force")] = False):
     """
     Guided setup of HackaProfile
     """
-    console.clear()
-    # console.rule("HackaProfile")
-    rprint(Panel(Text("Welcome to HackaProfile\nyou will be guided on an easy setup of the tool!", justify="center")))
-    console.rule()
-    # rprint(force)
-    
-    # Copy log files
-    try:
-        # Allow overwrite if set to force
-        shutil.copytree(Path(__file__).resolve().parent / "logTemplate", LOG_DIR, dirs_exist_ok=force)
-        rprint("[bold green]✓[/bold green] Log file setup done!")
-    except FileExistsError:
-        rprint("[bold green]✓[/bold green] Log file already exists!")
-    except Exception as e:
-        rprint(f"❌ Failed to setup log files: {e}")
-        
-    # Copy config files
-    try:
-        # Allow overwrite if set to force
-        shutil.copytree(Path(__file__).resolve().parent / "configTemplate", CONFIG_DIR, dirs_exist_ok=force)
-        rprint("[bold green]✓[/bold green] Config file setup done!")
-    except FileExistsError:
-        rprint("[bold green]✓[/bold green] Config file already exists!")
-    except Exception as e:
-        rprint(f"❌ Failed to setup config files: {e}")
-        
-    
-    # If no token stored
-    if force or not hackatime.status()["ok"]:
-        # hackatimeConfirm = Confirm.ask("[bold cyan]Do you want to authorize Hackatime (This will redirect you to OAuth page)", default=True)
-        hackatimeConfirm  = questionary.confirm("Do you want to authorize Hackatime (This will redirect you to OAuth page)").ask()
-        if hackatimeConfirm:
-            with console.status("Authorizing Hackatime", spinner="dots"):
-                ok, hackatime_token = hackatime.authorize()
+    if force:
+        conf = Confirm.ask("[bold red]Setting --force will CLEAR ALL EXISTING CONFIG AND LOGS. Do you wish to continue?", default=False)
+        if conf:
+            console.clear()
+            # console.rule("HackaProfile")
+            rprint(Panel(Text("Welcome to HackaProfile\nyou will be guided on an easy setup of the tool!", justify="center")))
+            console.rule()
+            # rprint(force)
+            
+            # Copy log files
+            try:
+                # Allow overwrite if set to force
+                shutil.copytree(Path(__file__).resolve().parent / "logTemplate", LOG_DIR, dirs_exist_ok=force)
+                rprint("[bold green]✓[/bold green] Log file setup done!")
+            except FileExistsError:
+                rprint("[bold green]✓[/bold green] Log file already exists!")
+            except Exception as e:
+                rprint(f"❌ Failed to setup log files: {e}")
                 
-            if ok:
-                rprint("[bold green]✓[/bold green] Hackatime authorized!")
-                
-            else :
-                rprint(f"[bold red]err: {str(hackatime_token)}")    
-        else:
-            rprint("[bold red]err: HackaProfile could not function without Hackatime.")
-            typer.Abort()
-    # If already stored
-    else:
-        rprint("[bold green]✓[/bold green] Hackatime already authorized!\n")
-        
-    platforms = questionary.checkbox(
-        message="Please choose the platforms you want to link to",
-        choices=[
-            "Slack",
-            "Github"
-        ]
-    ).ask()
-    
-    # Authorize the platforms
-    
-    for platform in platforms:
-        # print("test")
-        cls = backend.platfroms.get(platform.lower())
-        if cls:
-            instance = cls()
-            with console.status(f"Authorizing {platform}", spinner="dots"):
-                ok, platform_token = instance.authorize()
-            if ok:
-                rprint(f"[bold green]✓[/bold green] {platform} authorized!")
+            # Copy config files
+            try:
+                # Allow overwrite if set to force
+                shutil.copytree(Path(__file__).resolve().parent / "configTemplate", CONFIG_DIR, dirs_exist_ok=force)
+                rprint("[bold green]✓[/bold green] Config file setup done!")
+            except FileExistsError:
+                rprint("[bold green]✓[/bold green] Config file already exists!")
+            except Exception as e:
+                rprint(f"❌ Failed to setup config files: {e}")
                 
+            
+            # If no token stored
+            if force or not hackatime.status()["ok"]:
+                # hackatimeConfirm = Confirm.ask("[bold cyan]Do you want to authorize Hackatime (This will redirect you to OAuth page)", default=True)
+                hackatimeConfirm  = questionary.confirm("Do you want to authorize Hackatime (This will redirect you to OAuth page)").ask()
+                if hackatimeConfirm:
+                    with console.status("Authorizing Hackatime", spinner="dots"):
+                        ok, hackatime_token = hackatime.authorize()
+                        
+                    if ok:
+                        rprint("[bold green]✓[/bold green] Hackatime authorized!")
+                        
+                    else :
+                        rprint(f"[bold red]err: {str(hackatime_token)}")    
+                else:
+                    rprint("[bold red]err: HackaProfile could not function without Hackatime.")
+                    typer.Abort()
+            # If already stored
             else:
-                rprint(f"[bold red]err: {str(platform_token)}")
+                rprint("[bold green]✓[/bold green] Hackatime already authorized!\n")
+                
+            platforms = questionary.checkbox(
+                message="Please choose the platforms you want to link to",
+                choices=[
+                    "Slack"
+                ]
+            ).ask()
+            
+            # Authorize the platforms
             
+            for platform in platforms:
+                # print("test")
+                cls = backend.platfroms.get(platform.lower())
+                if cls:
+                    instance = cls()
+                    with console.status(f"Authorizing {platform}", spinner="dots"):
+                        ok, platform_token = instance.authorize()
+                    if ok:
+                        rprint(f"[bold green]✓[/bold green] {platform} authorized!")
+                        
+                    else:
+                        rprint(f"[bold red]err: {str(platform_token)}")
+                    
+                else:
+                    rprint("[bold red]err: Platform unsupported")
+                
+                
+            rprint("[bold green]✓[/bold green] Setup complete!\n\n1.Run [bold green]hackaprofile config \\[platform name(e.g. slack)][/bold green] to configure\n2.Run [bold green]hackaprofile start[/bold green] to start updating your profile automatically!")
         else:
-            rprint("[bold red]err: Platform unsupported")
-        
-        
-    rprint("[bold green]✓[/bold green] Setup complete!\n\n1.Run [bold green]hackaprofile config \\[platform name][/bold green] to configure\n2.Run [bold green]hackaprofile start[/bold green] to start updating your profile automatically!")
-        
+            rprint("[bold red]Aborted.")
+
 class placeholderHighlighter(Highlighter):
     def highlight(self, text) -> None:
         text.highlight_regex(r"\{\{.*?\}\}", "bold yellow")
@@ -221,7 +226,7 @@ def config(platform: Annotated[str, typer.Argument]):
     """
     Shows a structured preview of the config files for each of the platforms
     """
-    
+    rprint("[bold red]Check README.md on how to configure HackaProfile!\n")
     table = Table(
         "Field",
         "Value",
@@ -254,16 +259,16 @@ def config(platform: Annotated[str, typer.Argument]):
     if option == "Exit":
         typer.Exit()
     elif option == "Edit":
-        path = str(CONFIG_DIR/ f"{platform}.hackaprofile.conf")
-        rprint(f"\n[bold green]Open[/bold green] {path} [bold green]in your preferred editor!")
+        path = shlex.quote(str(CONFIG_DIR/ f"{platform}.hackaprofile.conf"))
+        rprint(f"\n[bold cyan]Open[/bold cyan] {path} [bold cyan]in your preferred editor!")
     
-        cbConfirm = questionary.confirm(
-            "Do you want to copy path to clipboard?",
-            default=False
-        ).ask()
-        if cbConfirm:
-            pyperclip.copy(path)
-            rprint("[bold green]✓[/bold green] Copied!")
+            # cbConfirm = questionary.confirm(
+            #     "Do you want to copy path to clipboard?",
+            #     default=False
+            # ).ask()
+            # if cbConfirm:
+            #     pyperclip.copy(path)
+            #     rprint("[bold green]✓[/bold green] Copied!")
     
     # with Live(table, refresh_per_second=4):
     #     console.clear()Path(__file__).resolve().parent.parent / "config" / f"{platform}.hackaprofile.conf"
@@ -354,6 +359,7 @@ def debug():
     """
     print(CONFIG_DIR)
     print(LOG_DIR)
+    rprint(slack.get_profile())
 
     
 if __name__ == "__main__":

hackaprofile-0.1.0/src/agent.py

@@ -1,106 +0,0 @@
-import time
-try:
-    from . import backend
-except ImportError:
-    import backend
-import dotenv
-import os
-from pathlib import Path
-import platformdirs
-
-hackatime = backend.hackatime()
-slack = backend.slack()
-
-
-active_services = ["slack"]
-interval = 20
-HOME = Path.home()
-CONFIG_DIR = Path(platformdirs.user_config_dir("hackaprofile"))
-LOG_DIR = Path(platformdirs.user_log_dir("hackaprofile"))
-
-
-# langauge = ""
-
-pid = os.getpid()
-with open(CONFIG_DIR / "agent.pid", "w") as f:
-    f.write(str(pid))
-    f.close()
-
-def clean_value(value: str) -> str:
-    """
-    Makes the values clean for slack (Value passed for `name` contained unallowed special characters)
-    """
-    return value.replace("<", "").replace(">", "")
-
-def parse_config(config: dict, map):
-    parsed_config = {}
-    for _, field in enumerate(config):
-        key = field
-        template: str = config[field]
-        # Replace {{key}} placeholders directly from the map.
-        for map_key, map_value in map.items():
-            template = template.replace(map_key, str(map_value))
-        try:
-            parsed_value = clean_value(template.format_map(map))
-            
-            # if the config field is empty, don't append it
-            if parsed_value != "":
-                parsed_config[key] = parsed_value
-        except KeyError:
-            pass
-            
-        # print(parsed)
-        
-    return parsed_config
-
-while True:
-    json = hackatime.fetch_hb()
-    
-    # for _, field in enumerate(json):
-    #     key = field
-    #     value = json.get(field, "")
-
-    # project = 
-    
-    
-    map = {
-        "{{id}}": json.get("id", ""),
-        "{{created_at}}": json.get("created_at", ""),
-        "{{time}}": json.get("time", ""),
-        "{{category}}": json.get("category", ""),
-        "{{project}}": json.get("project", ""),
-        "{{language}}": json.get("language", ""),
-        "{{editor}}": json.get("editor", ""),
-        "{{operating_system}}": json.get("operating_system", ""),
-        "{{machine}}": json.get("machine", ""),
-        "{{entity}}": json.get("entity", "")
-    }
-    
-    
-    
-    print(f'Language: {map["{{language}}"]}')
-    print(json)
-    
-    if "slack" in active_services:
-        print(slack.fetch_config())
-        config = parse_config(slack.fetch_config(), map)
-        print(config)
-        
-        res = slack.set_profile(config)
-        print(res)
-        # for _, field in enumerate(slack_config):
-        #     print((field, slack_config[field]))
-            
-            
-        # slack.set_profile(
-        #     profile={
-        #         "status_text": "test status text",
-        #         "status_emoji": ":67:",
-        #         "status_expiration": 0
-        # })
-    print("---")
-    time.sleep(interval)
-    
-    
-    
-#  

hackaprofile-0.1.0/src/configTemplate/slack.hackaprofile.conf

@@ -1,11 +0,0 @@
-# Don't change this plz (it will break...)
-client_id = "2210535565.11339190985360"
-
-title = 
-phone = 
-real_name =
-display_name = 
-status_text = 
-status_emoji = 
-
-# Check README.md