github-overlord 0.6.9__tar.gz → 0.7.1__tar.gz

{github_overlord-0.6.9 → github_overlord-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: github-overlord
-Version: 0.6.9
+Version: 0.7.1
 Summary: Automatically merge Dependabot PRs in public repositories
 Home-page: https://github.com/iloveitaly/github-overlord
 Keywords: github,dependabot,automation
@@ -12,11 +12,11 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: apscheduler (>=3.10.4,<4.0.0)
 Requires-Dist: click (>=8.1.7,<9.0.0)
-Requires-Dist: funcy-pipe (>=0.11.0,<0.12.0)
-Requires-Dist: openai (>=1.35.3,<2.0.0)
+Requires-Dist: funcy-pipe (>=0.11.1,<0.12.0)
+Requires-Dist: openai (>=1.41.1,<2.0.0)
 Requires-Dist: pygithub (>=2.3.0,<3.0.0)
 Requires-Dist: python-decouple-typed (>=3.11.0,<4.0.0)
-Requires-Dist: structlog (>=24.2.0,<25.0.0)
+Requires-Dist: structlog (>=24.4.0,<25.0.0)
 Description-Content-Type: text/markdown
 
 [![Release Notes](https://img.shields.io/github/release/iloveitaly/github-overlord)](https://github.com/iloveitaly/github-overlord/releases) [![Downloads](https://static.pepy.tech/badge/github-overlord/month)](https://pepy.tech/project/github-overlord) [![Python Versions](https://img.shields.io/pypi/pyversions/github-overlord)](https://pypi.org/project/github-overlord) ![GitHub CI Status](https://github.com/iloveitaly/github-overlord/actions/workflows/build_and_publish.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

{github_overlord-0.6.9 → github_overlord-0.7.1}/github_overlord/__init__.py

@@ -10,12 +10,10 @@ from github.GithubObject import NotSet
 from github.Notification import Notification
 from github.PullRequest import PullRequest
 
-from github_overlord.stale_commenter import (
-    check_for_stale_comments,
-    inspect_repo_for_stale_prs,
-    is_stale_comment,
-)
-from github_overlord.utils import log
+import github_overlord.patch as _
+
+from .stale_commenter import inspect_repo_for_stale_prs
+from .utils import log
 
 AUTOMATIC_MERGE_MESSAGE = "Automatically merged with [github-overlord](https://github.com/iloveitaly/github-overlord)"
 
@@ -244,26 +242,86 @@ def keep_alive_prs(token, dry_run, repo):
     log.info("stale PR check complete")
 
 
-def notifications(token, dry_run):
+@click.command()
+@click.option(
+    "--token",
+    help="GitHub token, can also be set via GITHUB_TOKEN",
+    default=os.getenv("GITHUB_TOKEN"),
+)
+# TODO move this into the parent command
+@click.option("--dry-run", is_flag=True, help="Run script without merging PRs")
+@click.option(
+    "--only-unread", is_flag=True, help="Only process a single repository", default=True
+)
+def notifications(token, dry_run, only_unread):
     """
-    Look at notifications and mark them as read if they are dependabot notifications
+    Look at notifications and mark them as read if they are:
+
+    * Dependabot notifications
+    * Releases on repos I own
+    * Closed (merged, closed) pull requests on repos I own
+    * Closed pull requests that I authored
+
+    Helpful if you work across a lot of repos and want to keep your notifications clean.
     """
 
-    g = Github(token)
-    user = g.get_user()
-    notifications = user.get_notifications()
+    github = Github(token)
+    user = github.get_user()
+    login = user.login
+
+    # all includes read notifications AND done notifications :/
+    # there is no way to determine if a notification is marked as done
+    notifications = list(user.get_notifications(all=not only_unread))
+
+    # TODO fix funcy_pipe here
+    released_on_owned_repos = (
+        notifications
+        | fp.filter(
+            lambda n: n.subject.type == "Release"
+            and n.repository.owner.login == login
+            # TODO I think there is a way to convert the instance method to a standard method so it could be mapped
+            #      patchy had some code for this
+        )
+        | fp.lmap(Notification.mark_as_done)
+    )
+
+    log.info("marked releases as done", count=len(released_on_owned_repos))
 
-    def handle_notification(notification: Notification):
-        pass
+    def is_dependabot_notification(notification: Notification) -> bool:
+        return notification.get_pull_request().user.login == "dependabot[bot]"
+
+    def is_pull_request(notification: Notification) -> bool:
+        return notification.subject.type == "PullRequest"
+
+    def is_pull_request_open(notification: Notification) -> bool:
+        return notification.get_pull_request().state == "open"
+
+    # TODO github digest has some logic to detect bots, maybev we can use that
+    pull_requests_by_dependabot = (
+        notifications
+        | fp.filter(is_pull_request)
+        | fp.filter(is_dependabot_notification)
+        | fp.lmap(Notification.mark_as_done)
+    )
+
+    log.info("marked dependabot PRs as done", count=len(pull_requests_by_dependabot))
+
+    # Closed (merged, closed) pull requests that I authored
+    owned_closed_pull_requests = (
+        notifications
+        # PRs that I did not author may still be interesting
+        | fp.where_attr(reason="author")
+        | fp.filter(is_pull_request)
+        | fp.filter(fp.complement(is_pull_request_open))
+        | fp.lmap(Notification.mark_as_done)
+    )
 
-    # for notification in notifications:
-    #     print(f"Notification: {notification.subject['title']}, Reason: {notification.reason}")
-    #     if not read_only:
-    #         notification.mark_as_read()
+    log.info("marked owned closed PRs as done", count=len(owned_closed_pull_requests))
 
 
 cli.add_command(dependabot)
 cli.add_command(keep_alive_prs)
+cli.add_command(notifications)
 
 if __name__ == "__main__":
     cli()

github_overlord-0.7.1/github_overlord/patch.py

@@ -0,0 +1,14 @@
+from github.Notification import Notification
+
+
+def mark_as_done(self) -> None:
+    """
+    :calls: `PATCH /notifications/threads/{id} <https://docs.github.com/en/rest/activity/notifications?apiVersion=2022-11-28#mark-a-thread-as-done>`_
+    """
+    headers, data = self._requester.requestJsonAndCheck(
+        "DELETE",
+        self.url,
+    )
+
+
+Notification.mark_as_done = mark_as_done

{github_overlord-0.6.9 → github_overlord-0.7.1}/github_overlord/utils.py

@@ -9,8 +9,23 @@ from pathlib import Path
 import structlog
 from decouple import config
 
+root: Path
+
+# must type manually, unfortunately :/
+# https://www.structlog.org/en/21.3.0/types.html
+log: structlog.stdlib.BoundLogger
+
 
 def configure_logger():
+    global log
+
+    # context manager to auto-clear context
+    log.context = structlog.contextvars.bound_contextvars  # type: ignore
+    # set thread-local context
+    log.local = structlog.contextvars.bind_contextvars  # type: ignore
+    # clear thread-local context
+    log.clear = structlog.contextvars.clear_contextvars  # type: ignore
+
     logger_factory = structlog.PrintLoggerFactory()
 
     # allow user to specify a log in case they want to do something meaningful with the stdout
@@ -38,30 +53,15 @@ def configure_logger():
     )
 
 
-# must type manually, unfortunately :/
-# https://www.structlog.org/en/21.3.0/types.html
-log: structlog.stdlib.BoundLogger
-
-
 def setup():
     if hasattr(setup, "complete") and setup.complete:
         return
 
-    global root, logger, log
+    global root, log
 
     root = Path(__file__).parent.parent
 
     log = structlog.get_logger()
-
-    # context manager to auto-clear context
-    log.context = structlog.contextvars.bound_contextvars  # type: ignore
-    # set thread-local context
-    log.local = structlog.contextvars.bind_contextvars  # type: ignore
-    # clear thread-local context
-    log.clear = structlog.contextvars.clear_contextvars  # type: ignore
-
-    logger = log
-
     configure_logger()
 
     log.debug("application setup")

{github_overlord-0.6.9 → github_overlord-0.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "github-overlord"
-version = "0.6.9"
+version = "0.7.1"
 description = "Automatically merge Dependabot PRs in public repositories"
 authors = ["Michael Bianco <mike@mikebian.co>"]
 readme = "README.md"
@@ -12,10 +12,10 @@ python = "^3.11"
 pygithub = "^2.3.0"
 click = "^8.1.7"
 python-decouple-typed = "^3.11.0"
-funcy-pipe = "^0.11.0"
-structlog = "^24.2.0"
+funcy-pipe = "^0.11.1"
+structlog = "^24.4.0"
 apscheduler = "^3.10.4"
-openai = "^1.35.3"
+openai = "^1.41.1"
 
 [tool.poetry.scripts]
 github-overlord = "github_overlord:cli"
@@ -28,9 +28,9 @@ float_to_top = true
 
 [tool.poetry.group.dev.dependencies]
 isort = "^5.13.2"
-black = "^24.4.2"
-pyright = "^1.1.368"
-pylint = "^3.2.3"
+black = "^24.8.0"
+pyright = "^1.1.376"
+pylint = "^3.2.6"
 
 [build-system]
 requires = ["poetry-core"]