ghapi 2.0.7__tar.gz → 2.1.1__tar.gz

{ghapi-2.0.7/ghapi.egg-info → ghapi-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghapi
-Version: 2.0.7
+Version: 2.1.1
 Summary: A python client for the GitHub API
 Author-email: Jeremy Howard <info@fast.ai>
 License: Apache-2.0
@@ -16,7 +16,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: fastcore>=2.2.6
-Requires-Dist: fastspec>=0.1.7
+Requires-Dist: fastspec>=0.2.0
 Requires-Dist: tomli; python_version < "3.11"
 Provides-Extra: dev
 Requires-Dist: fastgit; extra == "dev"
@@ -26,6 +26,7 @@ Requires-Dist: nbdev; extra == "dev"
 Requires-Dist: pyyaml; extra == "dev"
 Requires-Dist: pysym2md>=0.0.6; extra == "dev"
 Requires-Dist: llms-txt>=0.0.6; extra == "dev"
+Requires-Dist: pyskills; extra == "dev"
 Dynamic: license-file
 
 # ghapi

{ghapi-2.0.7 → ghapi-2.1.1}/ghapi/__init__.py

@@ -5,4 +5,4 @@ Modules:
 - `ghapi.graphql`: Query GitHub's GraphQL API: schema-aware chained queries, one-request batching, and raw GraphQL
 - `ghapi.skill`: GitHub REST API access via `GhApi`, plus local git operations via `fastgit.Git`. Use this for day-to-day GitHub work: reading/creating issues and PRs, checking CI status, managing releases/branches/gists, and repo-local git operations -- all from Python, no shelling out to `gh`/`git` needed."""
 
-__version__ = "2.0.7"
+__version__ = "2.1.1"

{ghapi-2.0.7 → ghapi-2.1.1}/ghapi/_modidx.py

@@ -74,6 +74,11 @@ d = { 'settings': { 'branch': 'main',
                             'ghapi.core.GhTransport._post': ('core.html#ghtransport._post', 'ghapi/core.py'),
                             'ghapi.core.GhTransport._pre': ('core.html#ghtransport._pre', 'ghapi/core.py'),
                             'ghapi.core.GhTransport.request': ('core.html#ghtransport.request', 'ghapi/core.py'),
+                            'ghapi.core.PullRow': ('core.html#pullrow', 'ghapi/core.py'),
+                            'ghapi.core.PullRow.line': ('core.html#pullrow.line', 'ghapi/core.py'),
+                            'ghapi.core.PullRows': ('core.html#pullrows', 'ghapi/core.py'),
+                            'ghapi.core.PullRows.__init__': ('core.html#pullrows.__init__', 'ghapi/core.py'),
+                            'ghapi.core.PullRows.__repr__': ('core.html#pullrows.__repr__', 'ghapi/core.py'),
                             'ghapi.core._CheckStatus': ('core.html#_checkstatus', 'ghapi/core.py'),
                             'ghapi.core._CheckStatus._repr_markdown_': ('core.html#_checkstatus._repr_markdown_', 'ghapi/core.py'),
                             'ghapi.core._IssueInfo': ('core.html#_issueinfo', 'ghapi/core.py'),
@@ -82,6 +87,7 @@ d = { 'settings': { 'branch': 'main',
                             'ghapi.core._LiveDefaults.__contains__': ('core.html#_livedefaults.__contains__', 'ghapi/core.py'),
                             'ghapi.core._LiveDefaults.get': ('core.html#_livedefaults.get', 'ghapi/core.py'),
                             'ghapi.core._LiveDefaults.items': ('core.html#_livedefaults.items', 'ghapi/core.py'),
+                            'ghapi.core._age': ('core.html#_age', 'ghapi/core.py'),
                             'ghapi.core._dur': ('core.html#_dur', 'ghapi/core.py'),
                             'ghapi.core._filter_diff': ('core.html#_filter_diff', 'ghapi/core.py'),
                             'ghapi.core._find_matches': ('core.html#_find_matches', 'ghapi/core.py'),
@@ -89,6 +95,7 @@ d = { 'settings': { 'branch': 'main',
                             'ghapi.core._include': ('core.html#_include', 'ghapi/core.py'),
                             'ghapi.core._listed': ('core.html#_listed', 'ghapi/core.py'),
                             'ghapi.core._parse_tmpl': ('core.html#_parse_tmpl', 'ghapi/core.py'),
+                            'ghapi.core._pr_mark': ('core.html#_pr_mark', 'ghapi/core.py'),
                             'ghapi.core._reduce_ctx': ('core.html#_reduce_ctx', 'ghapi/core.py'),
                             'ghapi.core._run_subp': ('core.html#_run_subp', 'ghapi/core.py'),
                             'ghapi.core._transdeps': ('core.html#_transdeps', 'ghapi/core.py'),
@@ -119,6 +126,7 @@ d = { 'settings': { 'branch': 'main',
                             'ghapi.core.issue_template': ('core.html#issue_template', 'ghapi/core.py'),
                             'ghapi.core.list_branches': ('core.html#list_branches', 'ghapi/core.py'),
                             'ghapi.core.list_files': ('core.html#list_files', 'ghapi/core.py'),
+                            'ghapi.core.list_prs': ('core.html#list_prs', 'ghapi/core.py'),
                             'ghapi.core.list_tags': ('core.html#list_tags', 'ghapi/core.py'),
                             'ghapi.core.local_dep_graph': ('core.html#local_dep_graph', 'ghapi/core.py'),
                             'ghapi.core.pr_file_diff': ('core.html#pr_file_diff', 'ghapi/core.py'),
@@ -150,10 +158,16 @@ d = { 'settings': { 'branch': 'main',
                                'ghapi.graphql.GhGql.__init__': ('graphql.html#ghgql.__init__', 'ghapi/graphql.py'),
                                'ghapi.graphql.GhGql.repo': ('graphql.html#ghgql.repo', 'ghapi/graphql.py')},
             'ghapi.page': { 'ghapi.page.GhApi.last_page': ('page.html#ghapi.last_page', 'ghapi/page.py'),
+                            'ghapi.page.GhApi.mark_done': ('page.html#ghapi.mark_done', 'ghapi/page.py'),
+                            'ghapi.page.NotifRow': ('page.html#notifrow', 'ghapi/page.py'),
+                            'ghapi.page.NotifRow.__repr__': ('page.html#notifrow.__repr__', 'ghapi/page.py'),
+                            'ghapi.page.NotifRows': ('page.html#notifrows', 'ghapi/page.py'),
+                            'ghapi.page.NotifRows.__repr__': ('page.html#notifrows.__repr__', 'ghapi/page.py'),
                             'ghapi.page._Scanner': ('page.html#_scanner', 'ghapi/page.py'),
                             'ghapi.page._Scanner.__getitem__': ('page.html#_scanner.__getitem__', 'ghapi/page.py'),
                             'ghapi.page._Scanner.__init__': ('page.html#_scanner.__init__', 'ghapi/page.py'),
                             'ghapi.page._Scanner.scan': ('page.html#_scanner.scan', 'ghapi/page.py'),
+                            'ghapi.page._notif_mark': ('page.html#_notif_mark', 'ghapi/page.py'),
                             'ghapi.page._parse_link_hdr': ('page.html#_parse_link_hdr', 'ghapi/page.py'),
                             'ghapi.page.gh_notifs': ('page.html#gh_notifs', 'ghapi/page.py'),
                             'ghapi.page.paged': ('page.html#paged', 'ghapi/page.py'),

{ghapi-2.0.7 → ghapi-2.1.1}/ghapi/core.py

@@ -6,12 +6,12 @@ Docs: https://ghapi.fast.ai/core.html.md"""
 
 # %% auto #0
 __all__ = ['GH_HOST', 'pspec', 'img_md_pat', 'EMPTY_TREE_SHA', 'GhTransport', 'GhSyncTransport', 'print_summary', 'gh_patch',
-           'GhApi', 'call_gh', 'date2gh', 'gh2date', 'delete_release', 'create_release', 'list_tags', 'list_branches',
-           'create_branch_empty', 'delete_tag', 'delete_branch', 'get_branch', 'commit_tree', 'list_files',
-           'get_content', 'create_or_update_file', 'create_file', 'delete_file', 'update_contents', 'enable_pages',
-           'read_issue', 'read_pr', 'pr_file_diff', 'issue_template', 'issue_body', 'CheckRun', 'CommitStatus',
-           'GhRows', 'check_status', 'pr_status', 'failed_step_log', 'dep_key', 'local_dep_graph', 'dep_closure',
-           'dep_order', 'dep_dependents', 'dep_graph', 'APIError']
+           'GhApi', 'call_gh', 'date2gh', 'gh2date', 'GhRows', 'delete_release', 'create_release', 'list_tags',
+           'list_branches', 'create_branch_empty', 'delete_tag', 'delete_branch', 'get_branch', 'commit_tree',
+           'list_files', 'get_content', 'create_or_update_file', 'create_file', 'delete_file', 'update_contents',
+           'enable_pages', 'read_issue', 'read_pr', 'pr_file_diff', 'PullRow', 'PullRows', 'list_prs', 'issue_template',
+           'issue_body', 'CheckRun', 'CommitStatus', 'check_status', 'pr_status', 'failed_step_log', 'dep_key',
+           'local_dep_graph', 'dep_closure', 'dep_order', 'dep_dependents', 'dep_graph', 'APIError']
 
 # %% ../nbs/00_core.ipynb #5b5cba7b
 from contextvars import ContextVar
@@ -26,7 +26,7 @@ from fastspec.errors import APIError
 import mimetypes,base64
 from collections import Counter
 from urllib.parse import quote
-from datetime import datetime
+from datetime import datetime, timezone
 import os, shutil, tempfile, subprocess, fnmatch, html
 import asyncio
 
@@ -178,6 +178,11 @@ def gh2date(dtstr:str)->datetime:
     "Convert date string `dtstr` received from a GitHub API operation to a UTC `datetime`"
     return datetime.fromisoformat(dtstr.replace('Z', ''))
 
+# %% ../nbs/00_core.ipynb #7876622c
+class GhRows(L):
+    "Result rows whose bare display is one actionable line each"
+    def __repr__(self): return '\n'.join(map(repr, self))
+
 # %% ../nbs/00_core.ipynb #16068542
 img_md_pat = re.compile(r'!\[(?P<alt>.*?)\]\((?P<url>[^\s]+)\)')
 
@@ -427,13 +432,13 @@ async def read_issue(self:GhApi, issue_number:int):
     res = dict(title=iss.title, body=iss.body or '', is_pr=pr is not None,  # chkstyle: ignore-node
                comments=await self.issues.list_comments(issue_number))
     if pr is not None:
-        res['diff'] = await self.pulls.get(issue_number, _headers={'Accept': 'application/vnd.github.v3.diff'})
+        res['diff'] = await self.pulls.get(issue_number, headers_={'Accept': 'application/vnd.github.v3.diff'})
         res['review_comments'] = await self.pulls.list_review_comments(issue_number)
         res['reviews'] = await self.pulls.list_reviews(issue_number)
     else:
         evts = await self.issues.list_events(issue_number)
         sha = first(e.commit_id for e in evts if e.commit_id)
-        if sha: res['diff'] = await self.repos.get_commit(sha, _headers={'Accept': 'application/vnd.github.v3.diff'})
+        if sha: res['diff'] = await self.repos.get_commit(sha, headers_={'Accept': 'application/vnd.github.v3.diff'})
     return _IssueInfo(dict2obj(res))
 
 # %% ../nbs/00_core.ipynb #ccf9d458
@@ -499,6 +504,44 @@ async def pr_file_diff(
         if f.filename == filename: return f"## {f.filename} (+{f.additions} -{f.deletions})\n\n```diff\n{html.unescape(f.patch)}\n```"
     return f"File `{filename}` not found in PR #{pr_number}"
 
+# %% ../nbs/00_core.ipynb #2c94c2c8
+def _age(s):
+    "Compact age of ISO-8601 timestamp `s`"
+    secs = (datetime.now(timezone.utc) - datetime.fromisoformat(s.replace('Z', '+00:00'))).total_seconds()
+    for n,u in ((31536000,'y'), (2592000,'mo'), (604800,'w'), (86400,'d'), (3600,'h')):
+        if secs >= n: return f'{int(secs//n)}{u}'
+    return f'{int(secs//60)}m'
+
+def _pr_mark(r):
+    if r.get('merged_at'): return 'merged '
+    if r.state == 'closed': return 'closed '
+    if r.get('draft'): return 'draft '
+    return ''
+
+class PullRow(AttrDict):
+    "One pull request as an actionable line"
+    def line(self, maxlen=120): return f'#{self.number}  {_age(self.updated_at)}  {_pr_mark(self)}{truncstr(self.title, maxlen)}'
+    __repr__ = line
+
+class PullRows(GhRows):
+    "Pull request rows, displayed with titles truncated to `maxlen`"
+    def __init__(self, items, maxlen=120):
+        super().__init__(items)
+        self.maxlen = maxlen
+    def __repr__(self): return '\n'.join(o.line(self.maxlen) for o in self)
+
+@gh_patch
+async def list_prs(
+    self:GhApi,
+    state='open', # 'open', 'closed', or 'all'
+    maxlen=120, # Title characters shown per row
+    per_page=100, # PRs per request (100 max)
+    page=1, # Page of results, for repos with more than `per_page` PRs
+)->PullRows:
+    "Pull requests as one-line rows, most recently updated first"
+    prs = await self.pulls.list(state=state, sort='updated', direction='desc', per_page=per_page, page=page)
+    return PullRows([PullRow(o) for o in prs], maxlen=maxlen)
+
 # %% ../nbs/00_core.ipynb #55a976ea
 def _parse_tmpl(name, txt):
     "Parse issue template `txt`: yml forms into section labels for `issue_body`; md templates kept as `raw`"
@@ -551,10 +594,6 @@ class CheckRun(AttrDict):
 class CommitStatus(AttrDict):
     def __repr__(self): return f'{self.context}: {self.state}'
 
-class GhRows(L):
-    "Result rows whose bare display is one actionable line each"
-    def __repr__(self): return '\n'.join(map(repr, self))
-
 class _CheckStatus(AttrDict):
     def _repr_markdown_(self):
         runs = self.check_runs

{ghapi-2.0.7 → ghapi-2.1.1}/ghapi/page.py

@@ -5,11 +5,13 @@ Docs: https://ghapi.fast.ai/page.html.md"""
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/03_page.ipynb.
 
 # %% auto #0
-__all__ = ['paged', 'parse_link_hdr', 'pages', 'sync_paged', 'sync_pages', 'gh_notifs']
+__all__ = ['paged', 'parse_link_hdr', 'pages', 'sync_paged', 'sync_pages', 'NotifRow', 'NotifRows', 'gh_notifs']
 
 # %% ../nbs/03_page.ipynb #6a0bf465
 from fastcore.all import *
 from .core import *
+from .core import _age
+from fastspec.errors import APIError
 
 import re, asyncio
 from datetime import datetime, timedelta, timezone
@@ -87,17 +89,41 @@ def sync_pages(oper, n_pages, *args, per_page=100, n_workers=16, **kwargs):
         range(n_pages), threadpool=True, n_workers=n_workers))
 
 # %% ../nbs/03_page.ipynb #58141083
+class NotifRow(AttrDict):
+    "One notification thread as an actionable line"
+    def __repr__(self):
+        s = self.subject
+        num = s.url.rpartition('/')[2] if s.url else ''
+        kind = ('PR' if s.type=='PullRequest' else s.type) + (f' #{num}' if num.isdigit() else '')
+        return f'{self.id}  {_age(self.updated_at)}  {self.reason}  {self.repository.full_name}  {self.get("mark","")}{kind}: {s.title}'
+
+class NotifRows(GhRows):
+    "Notification rows; displays 'no notifications' when empty"
+    def __repr__(self): return super().__repr__() or 'no notifications'
+
+def _notif_mark(sub):
+    "`[merged] `/`[closed] ` marker for a fetched subject; empty for open or unfetchable subjects"
+    if not sub: return ''
+    if sub.get('merged_at'): return '[merged] '
+    if sub.get('state') == 'closed': return '[closed] '
+    return ''
+
 async def gh_notifs(days=5, reasons=('mention', 'review_requested', 'author', 'assign'), include_read=False, per_page=100):
-    "Get GitHub notifications from the past `days`, formatted as a summary string"
+    "Notifications from the past `days` (all available if None) as `NotifRows`, marked `[closed]`/`[merged]` when the subject is no longer open; `reasons=None` includes every reason"
+    api = GhApi()
     since = (datetime.now(timezone.utc) - timedelta(days=days)).isoformat() if days else None
-    notifs = L([o async for o in paged(GhApi().activity.list_notifications_for_authenticated_user, all=include_read, since=since, per_page=per_page)]).concat()
+    notifs = L([o async for o in paged(api.activity.list_notifications_for_authenticated_user, all=include_read, since=since, per_page=per_page)]).concat()
     if reasons: notifs = notifs.filter(lambda n: n.reason in reasons)
-    lines = []
-    for n in notifs:
-        repo, kind = n.repository.full_name, n.subject.type
-        num = n.subject.url.split('/')[-1] if n.subject.url else '?'
-        url = f"https://github.com/{repo}/pull/{num}" if kind == 'PullRequest' else f"https://github.com/{repo}/issues/{num}" if kind == 'Issue' else n.subject.url
-        lines.append(f"- [{kind} #{num}]({url}) {repo} — {n.subject.title} ({n.reason})")
-    scope = f"past {days} days" if days else "all available"
-    reason_txt = ", ".join(reasons) if reasons else "all reasons"
-    return f"**{len(lines)} notifications** ({scope}; {reason_txt})\n\n" + "\n".join(lines)
+    async def _get(u):
+        if not u: return None
+        try: return await api(u, 'GET')
+        except APIError: return None   # deleted or inaccessible subjects lose their mark, not the whole listing
+    subs = await asyncio.gather(*(_get(n.subject.url) for n in notifs))
+    for n, s in zip(notifs, subs): n['mark'] = _notif_mark(s)
+    return NotifRows(NotifRow(o) for o in notifs)
+
+# %% ../nbs/03_page.ipynb #abc91f9e
+@patch
+async def mark_done(self:GhApi, *ids):
+    "Mark notification threads as done, removing them from the inbox (the API cannot list done threads back)"
+    await asyncio.gather(*(self.activity.mark_thread_as_done(i) for i in ids))

{ghapi-2.0.7 → ghapi-2.1.1}/ghapi/skill.py

@@ -87,11 +87,12 @@ Once the PR exists, the fork branch is the source of truth, and the local clone
 
 # Gotchas
 
+- Results with tuned reprs (`read_issue`, `check_status`, `list_prs`, `gh_notifs`) display bare. Raw endpoint results don't, so when only confirmation matters (a `create_comment`, a `pulls.update`), assign the result to a variable and show one key (`r.html_url`, `r.state`) instead of displaying the whole payload.
 - A PR *is* an issue for general comments (`issues.list_comments`, not `pulls.*`) -- inline code-review comments are the separate `pulls.list_review_comments`.
 - Rate limits: register `limit_cb` on `GhApi(...)` to get called back whenever the remaining quota changes, or check `api.limit_rem` any time.
 - HTTP errors raise `fastspec.errors.APIError`, which carries `.status_code` and the endpoint called.
 - `per_page` maxes out at 100; beyond that, use `paged`/`pages` rather than manually looping `page=`.
-- Per-call headers on named endpoints use `_headers=` (e.g. `await api.pulls.get(n, _headers={'Accept': 'application/vnd.github.v3.diff'})` for the raw diff); plain `headers=` is a kwarg only for direct `api(path, verb, ...)` calls.
+- Per-call headers on named endpoints use `headers_=` (e.g. `await api.pulls.get(n, headers_={'Accept': 'application/vnd.github.v3.diff'})` for the raw diff); plain `headers=` is a kwarg only for direct `api(path, verb, ...)` calls.
 - `GITHUB_TOKEN` unset means unauthenticated (heavily rate-limited, no write access) -- `GhApi()` warns but doesn't raise.
 """
 

{ghapi-2.0.7 → ghapi-2.1.1/ghapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghapi
-Version: 2.0.7
+Version: 2.1.1
 Summary: A python client for the GitHub API
 Author-email: Jeremy Howard <info@fast.ai>
 License: Apache-2.0
@@ -16,7 +16,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: fastcore>=2.2.6
-Requires-Dist: fastspec>=0.1.7
+Requires-Dist: fastspec>=0.2.0
 Requires-Dist: tomli; python_version < "3.11"
 Provides-Extra: dev
 Requires-Dist: fastgit; extra == "dev"
@@ -26,6 +26,7 @@ Requires-Dist: nbdev; extra == "dev"
 Requires-Dist: pyyaml; extra == "dev"
 Requires-Dist: pysym2md>=0.0.6; extra == "dev"
 Requires-Dist: llms-txt>=0.0.6; extra == "dev"
+Requires-Dist: pyskills; extra == "dev"
 Dynamic: license-file
 
 # ghapi

{ghapi-2.0.7 → ghapi-2.1.1}/ghapi.egg-info/requires.txt

@@ -1,5 +1,5 @@
 fastcore>=2.2.6
-fastspec>=0.1.7
+fastspec>=0.2.0
 
 [:python_version < "3.11"]
 tomli
@@ -12,3 +12,4 @@ nbdev
 pyyaml
 pysym2md>=0.0.6
 llms-txt>=0.0.6
+pyskills

{ghapi-2.0.7 → ghapi-2.1.1}/pyproject.toml

@@ -12,7 +12,7 @@ license = {text = "Apache-2.0"}
 authors = [{name = "Jeremy Howard", email = "info@fast.ai"}]
 keywords = ['github', 'api']
 classifiers = ["Natural Language :: English", "Intended Audience :: Developers", "Development Status :: 5 - Production/Stable", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only"]
-dependencies = ['fastcore>=2.2.6', 'fastspec>=0.1.7', 'tomli; python_version < "3.11"']
+dependencies = ['fastcore>=2.2.6', 'fastspec>=0.2.0', 'tomli; python_version < "3.11"']
 
 [project.urls]
 Repository = "https://github.com/fastai/ghapi"
@@ -25,7 +25,7 @@ ghapi = "ghapi._modidx:d"
 ghapi = "ghapi.skill"
 
 [project.optional-dependencies]
-dev = ['fastgit', 'matplotlib', 'nbclassic', 'nbdev', 'pyyaml', 'pysym2md>=0.0.6', 'llms-txt>=0.0.6']
+dev = ['fastgit', 'matplotlib', 'nbclassic', 'nbdev', 'pyyaml', 'pysym2md>=0.0.6', 'llms-txt>=0.0.6', 'pyskills']
 
 
 [project.scripts]