clean-workspace 0.1.0__tar.gz

clean_workspace-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Michael Bianco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

clean_workspace-0.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: clean-workspace
+Version: 0.1.0
+Summary: Collect all browser URLs, output to terminal, and archive to todoist
+License: MIT
+Author: Michael Bianco
+Author-email: mike@mikebian.co
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: chrome-bookmarks (>=2020.10.25,<2021.0.0)
+Requires-Dist: pyobjc-framework-ScriptingBridge (>=9.0.1,<10.0.0)
+Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
+Requires-Dist: todoist-api-python (>=2.0.1,<3.0.0)
+Description-Content-Type: text/markdown
+
+# Clean Workspace: Archive Web Browser Tabs
+
+I've been experimenting with how to make my mornings more productive. One glitch I've found in my mind is I can easily
+get distracted by open tabs on my browser, especially if I'm trying to write or read something which I want to give
+my full attention to. I've found that if I close all my tabs, I can focus better on the task at hand. However, I don't
+want to lose any interesting tabs so I never actually do that.
+
+This is simple utility to automate this process. It will close all your tabs (in both Safari & Chrome), and send them to [todoist](https://mikebian.co/todoist) (and output) them to the terminal.
+
+We'll see if this actually helps!
+
+## Installation
+
+```shell
+poetry install
+poetry run clean-workspace
+```
+
+## Usage
+
+- Add your todoist token to `.envrc` and `direnv allow .`
+- Customize the url and domain blacklist
+
+### Collecting Tab Description Via AppleScript
+
+Here's a quick script you can use to collect a description of what you were working on via applescript:
+
+```shell
+dialogResult=$(
+osascript <<EOT
+set dialogResult to display dialog "What were you working on yesterday?" buttons {"OK"} default button "OK" giving up after 300 default answer ""
+return text returned of dialogResult
+EOT
+)
+```
+
+## Inspiration
+
+- https://gist.github.com/aleks-mariusz/cc27b21f2c5b91fbd285
+- https://github.com/tominsam/shelf-python/blob/f357d9b147fa651034b71501edabf65f59d5befa/extractors/ComAppleSafari.py#L11
+

clean_workspace-0.1.0/README.md

@@ -0,0 +1,40 @@
+# Clean Workspace: Archive Web Browser Tabs
+
+I've been experimenting with how to make my mornings more productive. One glitch I've found in my mind is I can easily
+get distracted by open tabs on my browser, especially if I'm trying to write or read something which I want to give
+my full attention to. I've found that if I close all my tabs, I can focus better on the task at hand. However, I don't
+want to lose any interesting tabs so I never actually do that.
+
+This is simple utility to automate this process. It will close all your tabs (in both Safari & Chrome), and send them to [todoist](https://mikebian.co/todoist) (and output) them to the terminal.
+
+We'll see if this actually helps!
+
+## Installation
+
+```shell
+poetry install
+poetry run clean-workspace
+```
+
+## Usage
+
+- Add your todoist token to `.envrc` and `direnv allow .`
+- Customize the url and domain blacklist
+
+### Collecting Tab Description Via AppleScript
+
+Here's a quick script you can use to collect a description of what you were working on via applescript:
+
+```shell
+dialogResult=$(
+osascript <<EOT
+set dialogResult to display dialog "What were you working on yesterday?" buttons {"OK"} default button "OK" giving up after 300 default answer ""
+return text returned of dialogResult
+EOT
+)
+```
+
+## Inspiration
+
+- https://gist.github.com/aleks-mariusz/cc27b21f2c5b91fbd285
+- https://github.com/tominsam/shelf-python/blob/f357d9b147fa651034b71501edabf65f59d5befa/extractors/ComAppleSafari.py#L11

clean_workspace-0.1.0/clean_workspace/__init__.py

@@ -0,0 +1,206 @@
+import os
+import plistlib
+import sys
+import typing as t
+
+from ScriptingBridge import SBApplication
+import chrome_bookmarks
+
+def todoist_client():
+    # extract todoist api key from environment without throwing an exception
+    todoist_api_key = os.environ.get("TODOIST_API_KEY", None)
+
+    if not todoist_api_key:
+        print("todoist api key not found in environment")
+        return
+
+    print("todoist api key found, adding to todoist")
+
+    from todoist_api_python.api import TodoistAPI
+
+    api = TodoistAPI(todoist_api_key)
+    return api
+
+def export_to_todoist(task_content, description):
+    # TODO should also support .env here as well
+    import dotenv
+    dotenv.load_dotenv(".envrc")
+
+    api = todoist_client()
+    if not api:
+        return
+
+    import datetime
+
+    project_name = os.environ.get("TODOIST_PROJECT", "Learning")
+    project = None
+    projects = api.get_projects()
+    project_matches = [project for project in projects if project.name == project_name]
+
+    if len(project_matches) == 1:
+        project = project_matches[0]
+
+
+    # find a label called "web-archive" or create it
+    label_name = os.environ.get("TODOIST_LABEL", "web-archive")
+    labels = api.get_labels()
+    label_matches = [label for label in labels if label.name == label_name]
+
+    # assigning label for debugging
+    if len(label_matches) == 0:
+        # https://developer.todoist.com/rest/v1/#create-a-new-label
+        print(f"could not find {label_name} label, creating it")
+        label = api.add_label(name=label_name)
+    else:
+        label = label_matches[0]
+
+    # https://developer.todoist.com/rest/v2#create-a-new-task
+    response = api.add_task(
+        # set content to "web archive CURRENT_DAY" using format YYYY-MM-DD
+        content="{}web archive {}".format(
+            description, datetime.datetime.now().strftime("%Y-%m-%d")
+        ),
+        description=task_content,
+        # date is serialized in the task description, no need for a due date
+        due_string="no date",
+        labels=[label_name],
+        project_id=project.id if project else None,
+    )
+
+def get_browser_urls() -> t.List[str]:
+    browser_urls = []
+    chrome = SBApplication.applicationWithBundleIdentifier_("com.google.Chrome")
+
+    for window in chrome.windows():
+        for tab in window.tabs():
+            browser_urls.append((tab.URL(), tab.name()))
+
+    safari = SBApplication.applicationWithBundleIdentifier_("com.apple.safari")
+
+    for window in safari.windows():
+        for tab in window.tabs():
+            browser_urls.append((tab.URL(), tab.name()))
+            # it doesn't look possible to close out the tabs with SBApplication :/
+            # instead we just close out the whole application below
+
+    return browser_urls
+
+def get_bookmarks_urls() -> t.List[str]:
+    raw_bookmark_urls = [bookmark.url for bookmark in chrome_bookmarks.urls]
+
+    # read all safari bookmarks, don't include these in the printout
+    with open(os.path.expanduser("~") + "/Library/Safari/Bookmarks.plist", "rb") as f:
+        bookmarks_plist = plistlib.load(f)
+
+        """
+        In [31]: [bookmark["Title"] for bookmark in bookmarks["Children"]]
+        Out[31]: ['History', 'BookmarksBar', 'BookmarksMenu', 'com.apple.ReadingList']
+        """
+
+        safari_bookmarks = [
+            child
+            for child in bookmarks_plist["Children"]
+            if child["Title"] == "BookmarksBar"
+        ][0]["Children"]
+
+        raw_safari_bookmark_urls = [bookmark["URLString"] for bookmark in safari_bookmarks]
+
+        raw_bookmark_urls.extend(raw_safari_bookmark_urls)
+
+    return [bookmark.split("#")[0] for bookmark in raw_bookmark_urls]
+
+def quit_browsers():
+    os.system("osascript -e 'quit app \"Safari\"'")
+    os.system("osascript -e 'quit app \"Chrome\"'")
+
+def main():
+    if not is_internet_connected():
+        print("internet is not connected")
+        return
+
+    # TODO maybe optionally collect via applescript input dialog? We'd need to develop a proper interface for the CLI at that point.
+    # get first CLI argument if it exists
+    if len(sys.argv) > 1 and sys.argv[1].strip():
+        tab_description = sys.argv[1].strip() + " "
+    else:
+        tab_description = ""
+
+    browser_urls = get_browser_urls()
+
+    # if page is blank, there is no url or string does not contain http
+    browser_urls = [x for x in browser_urls if x[0] is not None and "http" in x[0]]
+
+    # remove duplicates
+    browser_urls = list(set(browser_urls))
+
+    # sort (in place) list of urls by domain name of url
+    browser_urls.sort(key=lambda x: x[0].split("/")[2])
+
+    # strip all anchors from the urls
+    browser_urls = [(url.split("#")[0], name) for url, name in browser_urls]
+
+    # TODO load these files from a home config file
+
+    # user configurable blacklist for urls you don't want to archive
+    url_blacklist = []
+    with open("blacklist_urls.txt", "r") as f:
+        url_blacklist = f.read().splitlines()
+
+    domain_blacklist = []
+    with open("blacklist_domains.txt", "r") as f:
+        domain_blacklist = f.read().splitlines()
+        # add a `www.` prefix to each domain in the blacklist and merge it with the existing list
+        domain_blacklist = domain_blacklist + [
+            "www." + domain for domain in domain_blacklist
+        ]
+
+    bookmark_urls = get_bookmarks_urls()
+
+    # TODO output skipped domains
+    # TODO support wildcard subdomains, *.sentry.io
+    # filter all urls with blacklisted domains
+    browser_urls = [x for x in browser_urls if x[0].split("/")[2] not in domain_blacklist]
+
+    # join url and name with "-" and print to stdout
+    todoist_content = ""
+    for url_with_name in browser_urls:
+        if (
+            # if the url is in the bookmark list of chrome or safari, skip it
+            url_with_name[0] not in bookmark_urls
+            # TODO should allow for regex in the URL matching, or at least globbing
+            # if the url
+            and url_with_name[0] not in url_blacklist
+        ):
+            todoist_content += "* " + " - ".join(url_with_name) + "\n"
+        else:
+            print(f"skipping url\t{url_with_name[0]}")
+
+    if not todoist_content.strip():
+        print("no urls to add, exiting")
+        quit_browsers()
+        sys.exit()
+
+    print(f"\n{todoist_content}\n")
+
+    # since we've archived all content we can now close out Safari & Chrome
+    quit_browsers()
+
+    export_to_todoist(todoist_content, tab_description)
+
+    archive_old_tasks()
+
+def archive_old_tasks():
+    # find all old tasks (>1mo) and archive them
+    # optionally only do this when there is not a custom name in the title
+    pass
+
+def is_internet_connected():
+    import socket
+    s = socket.socket(socket.AF_INET)
+    try:
+        s.connect(("google.com",80))
+        return True
+    except socket.error as e: return False
+
+if __name__ == "__main__":
+    main()

clean_workspace-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "clean-workspace"
+version = "0.1.0"
+description = "Collect all browser URLs, output to terminal, and archive to todoist"
+authors = ["Michael Bianco <mike@mikebian.co>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+pyobjc-framework-ScriptingBridge = "^9.0.1"
+todoist-api-python = "^2.0.1"
+python-dotenv = "^1.0.0"
+chrome-bookmarks = "^2020.10.25"
+
+[tool.poetry.group.dev.dependencies]
+ipython = "^8.12.0"
+ipython-autoimport = "^0.4"
+pdbr = "^0.8.2"
+
+[tool.poetry.scripts]
+clean-workspace = "clean_workspace:main"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"