ghapi 2.0.1__tar.gz → 2.0.3__tar.gz

{ghapi-2.0.1/ghapi.egg-info → ghapi-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghapi
-Version: 2.0.1
+Version: 2.0.3
 Summary: A python client for the GitHub API
 Author-email: Jeremy Howard <info@fast.ai>
 License: Apache-2.0

ghapi-2.0.3/ghapi/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.0.3"

{ghapi-2.0.1 → ghapi-2.0.3}/ghapi/_modidx.py

@@ -49,6 +49,7 @@ d = { 'settings': { 'branch': 'main',
                             'ghapi.core.GhApi._get_repo_files': ('core.html#ghapi._get_repo_files', 'ghapi/core.py'),
                             'ghapi.core.GhApi._repr_markdown_': ('core.html#ghapi._repr_markdown_', 'ghapi/core.py'),
                             'ghapi.core.GhApi.check_status': ('core.html#ghapi.check_status', 'ghapi/core.py'),
+                            'ghapi.core.GhApi.commit_tree': ('core.html#ghapi.commit_tree', 'ghapi/core.py'),
                             'ghapi.core.GhApi.create_branch_empty': ('core.html#ghapi.create_branch_empty', 'ghapi/core.py'),
                             'ghapi.core.GhApi.create_file': ('core.html#ghapi.create_file', 'ghapi/core.py'),
                             'ghapi.core.GhApi.create_gist': ('core.html#ghapi.create_gist', 'ghapi/core.py'),

{ghapi-2.0.1 → ghapi-2.0.3}/ghapi/actions.py

@@ -18,7 +18,6 @@ from .templates import *
 
 import textwrap
 from contextlib import contextmanager
-from enum import Enum
 
 # %% ../nbs/01_actions.ipynb #fb69ba90
 # So we can run this outside of GitHub actions too, read from file if needed
@@ -26,8 +25,7 @@ for a,b in (('CONTEXT_GITHUB',context_example), ('CONTEXT_NEEDS',needs_example),
     if a not in os.environ: os.environ[a] = b
 
 contexts = 'github', 'env', 'job', 'steps', 'runner', 'secrets', 'strategy', 'matrix', 'needs'
-for context in contexts:
-    globals()[f'context_{context}'] = dict2obj(loads(os.getenv(f"CONTEXT_{context.upper()}", "{}")))
+for context in contexts: globals()[f'context_{context}'] = dict2obj(loads(os.getenv(f"CONTEXT_{context.upper()}", "{}")))
 
 # %% ../nbs/01_actions.ipynb #393990e1
 _all_ = ['context_github', 'context_env', 'context_job', 'context_steps', 'context_runner', 'context_secrets', 'context_strategy', 'context_matrix', 'context_needs']
@@ -41,7 +39,7 @@ def user_repo():
     return env_github.repository.split('/')
 
 # %% ../nbs/01_actions.ipynb #deb389d7
-Event = str_enum('Event',
+Event = str_enum('Event',  # chkstyle: ignore-node
     'page_build','content_reference','repository_import','create','workflow_run','delete','organization','sponsorship',
     'project_column','push','context','milestone','project_card','project','package','pull_request','repository_dispatch',
     'team_add','workflow_dispatch','member','meta','code_scanning_alert','public','needs','check_run','security_advisory',
@@ -54,8 +52,7 @@ Event = str_enum('Event',
 def _create_file(path:Path, fname:str, contents):
     if contents and not (path/fname).exists(): (path/fname).write_text(contents)
 
-def _replace(s:str, find, repl, i:int=0, suf:str=''):
-    return s.replace(find, textwrap.indent(repl, ' '*i)+suf)
+def _replace(s:str, find, repl, i:int=0, suf:str=''): return s.replace(find, textwrap.indent(repl, ' '*i)+suf)
 
 # %% ../nbs/01_actions.ipynb #26eb64e5
 def create_workflow_files(fname:str, workflow:str, build_script:str, prebuild:bool=False):
@@ -75,9 +72,9 @@ def fill_workflow_templates(name:str, event, run, context, script, opersys='ubun
     c = wf_tmpl
     if event=='workflow_dispatch:': event=''
     needs = '    needs: [prebuild]' if prebuild else ''
-    for find,repl,i in (('NAME',name,0), ('EVENT',event,2), ('RUN',run,8), ('CONTEXTS',context,8),
-                       ('OPERSYS',f'[{opersys}]',0), ('NEEDS',needs,0), ('PREBUILD',pre_tmpl if prebuild else '',2)):
-        c = _replace(c, f'${find}', str(repl), i)
+    repls = (('NAME',name,0), ('EVENT',event,2), ('RUN',run,8), ('CONTEXTS',context,8),
+        ('OPERSYS',f'[{opersys}]',0), ('NEEDS',needs,0), ('PREBUILD',pre_tmpl if prebuild else '',2))
+    for find,repl,i in repls: c = _replace(c, f'${find}', str(repl), i)
     create_workflow_files(name, c, script, prebuild=prebuild)
 
 # %% ../nbs/01_actions.ipynb #bc2f80a5
@@ -93,7 +90,7 @@ def_pipinst = 'pip install -Uq ghapi'
 def create_workflow(name:str, event:Event, contexts:list=None, opersys='ubuntu', prebuild=False):
     "Function to create a simple Ubuntu workflow that calls a Python `ghapi` script"
     script = "from fastcore.all import *\nfrom ghapi import *"
-    fill_workflow_templates(name, f'{event}:', def_pipinst, env_contexts(contexts),
+    fill_workflow_templates(name, f'{event}:', def_pipinst, env_contexts(contexts),  # chkstyle: ignore-node
                             script=script, opersys=opersys, prebuild=prebuild)
 
 # %% ../nbs/01_actions.ipynb #e8482286

{ghapi-2.0.1 → ghapi-2.0.3}/ghapi/auth.py

@@ -12,10 +12,10 @@ from fastcore.all import *
 from .core import *
 
 import webbrowser,time
-from urllib.parse import parse_qs,urlsplit
+from urllib.parse import parse_qs
 
 # %% ../nbs/02_auth.ipynb #46620407
-_scopes =(
+_scopes =(  # chkstyle: ignore-node
     'repo','repo:status','repo_deployment','public_repo','repo:invite','security_events','admin:repo_hook','write:repo_hook',
     'read:repo_hook','admin:org','write:org','read:org','admin:public_key','write:public_key','read:public_key','admin:org_hook',
     'gist','notifications','user','read:user','user:email','user:follow','delete_repo','write:discussion','read:discussion',
@@ -61,10 +61,8 @@ def open_browser(self:GhDeviceAuth):
 @patch
 def auth(self:GhDeviceAuth)->str:
     "Return token if authentication complete, or `None` otherwise"
-    resp = parse_qs(urlread(
-        'https://github.com/login/oauth/access_token',
-        client_id=self.client_id, device_code=self.device_code,
-        grant_type='urn:ietf:params:oauth:grant-type:device_code'))
+    resp = parse_qs(urlread('https://github.com/login/oauth/access_token',
+        client_id=self.client_id, device_code=self.device_code, grant_type='urn:ietf:params:oauth:grant-type:device_code'))
     err = nested_idx(resp, 'error', 0)
     if err == 'authorization_pending': return None
     if err: raise Exception(resp['error_description'][0])

{ghapi-2.0.1 → ghapi-2.0.3}/ghapi/core.py

@@ -11,7 +11,7 @@ __all__ = ['GH_HOST', 'pspec', 'img_md_pat', 'EMPTY_TREE_SHA', 'GhTransport', 'G
 # %% ../nbs/00_core.ipynb #5b5cba7b
 from fastcore.all import *
 from fastspec.spec import SpecParser
-from fastspec.oapi import OpenAPIClient, OpFunc, SyncOpFunc, _build_groups
+from fastspec.oapi import OpenAPIClient, OpFunc, SyncOpFunc, _build_groups, UNSET
 from fastspec.transport import AsyncTransport, SyncTransport
 from .gh_spec import spec
 from fastspec.errors import APIError
@@ -19,8 +19,7 @@ from fastspec.errors import APIError
 import mimetypes,base64
 from collections import Counter
 from urllib.parse import quote
-from datetime import datetime, timedelta, timezone
-from time import sleep
+from datetime import datetime
 import os, shutil, tempfile, subprocess, fnmatch, html
 
 # %% ../nbs/00_core.ipynb #ed04302a
@@ -60,8 +59,7 @@ class GhTransport(AsyncTransport):
         self.recv_hdrs = resp.headers
         if 'X-RateLimit-Remaining' in resp.headers:
             newlim = resp.headers['X-RateLimit-Remaining']
-            if self.limit_cb is not None and newlim != self.limit_rem:
-                self.limit_cb(int(newlim), int(resp.headers['X-RateLimit-Limit']))
+            if self.limit_cb is not None and newlim != self.limit_rem: self.limit_cb(int(newlim), int(resp.headers['X-RateLimit-Limit']))
             self.limit_rem = newlim
         if raw: return resp
         res = self._decode(resp)
@@ -90,7 +88,7 @@ def print_summary(method, url, kwargs):
 # %% ../nbs/00_core.ipynb #83e8a9ce
 class GhApi(OpenAPIClient):
     "GitHub API client. Endpoint groups (`issues`, `pulls`, ...) are generated per-instance from GitHub's OpenAPI metadata, so the class shows only convenience methods -- inspect a live instance, e.g. `doc(GhApi())`, to see the full API."
-    def __init__(self, owner=None, repo=None, token=None, jwt_token=None, debug=None, limit_cb=None, gh_host=None,
+    def __init__(self, owner=None, repo=None, token=None, jwt_token=None, debug=None, limit_cb=None, gh_host=None,  # chkstyle: ignore-node
                  authenticate=True, timeout=60.0, sync=False, **kwargs):
         self.headers = { 'Accept': 'application/vnd.github.v3+json' }
         if authenticate:
@@ -215,11 +213,11 @@ async def upload_file(self:GhApi, rel, fn):
 # %% ../nbs/00_core.ipynb #3cad71a4
 @patch
 async def create_release(self:GhApi, tag_name, branch='master', name=None, body='',
-                   draft=False, prerelease=False, files=None):
+    draft=False, prerelease=False, files=None, make_latest=UNSET):
     "Wrapper for `GhApi.repos.create_release` which also uploads `files`"
     if name is None: name = 'v'+tag_name
     rel = await self.repos.create_release(tag_name, target_commitish=branch, name=name, body=body,
-                                   draft=draft, prerelease=prerelease)
+        draft=draft, prerelease=prerelease, make_latest=make_latest)
     for file in listify(files): await self.upload_file(rel, file)
     return rel
 
@@ -265,6 +263,24 @@ async def get_branch(self:GhApi, branch=None):
     branch = branch or (await self.repos.get()).default_branch
     return (await self.list_branches(branch))[0]
 
+# %% ../nbs/00_core.ipynb #9f70ac44
+@patch
+async def commit_tree(self:GhApi, branch, message, tree, base=None):
+    "Commit `tree` entries to `branch`, creating it from `base` when needed"
+    try:
+        ref = await self.git.get_ref(f'heads/{branch}')
+        exists = True
+    except APIError as e:
+        if e.status_code != 404: raise
+        base = base or (await self.repos.get()).default_branch
+        ref,exists = await self.git.get_ref(f'heads/{base}'),False
+    parent = await self.git.get_commit(ref.object.sha)
+    new_tree = await self.git.create_tree(tree, parent.tree.sha)
+    commit = await self.git.create_commit(message, new_tree.sha, [parent.sha])
+    if exists: await self.git.update_ref(f'heads/{branch}', commit.sha)
+    else: await self.git.create_ref(f'refs/heads/{branch}', commit.sha)
+    return commit
+
 # %% ../nbs/00_core.ipynb #93b24881
 @patch
 async def list_files(self:GhApi, branch=None):
@@ -299,8 +315,7 @@ async def create_file(self:GhApi, path, message, committer, author, content=None
 async def delete_file(self:GhApi, path, message, committer, author, sha=None, branch=None):
     if not branch: branch = (await self.repos.get())['default_branch']
     if sha is None: sha = (await self.list_files())[path].sha
-    return await self.repos.delete_file(path, message=message, sha=sha,
-                                  branch=branch, committer=committer, author=author)
+    return await self.repos.delete_file(path, message=message, sha=sha, branch=branch, committer=committer, author=author)
 
 # %% ../nbs/00_core.ipynb #93f6b559
 @patch
@@ -346,7 +361,7 @@ async def get_repo_contents(self:GhApi, owner, repo, branch='main',
     n_workers=16, # Max concurrent downloads
     **kwargs
 ):
-    repo_files = await self.get_repo_files(owner, repo, **kwargs)
+    repo_files = await self.get_repo_files(owner, repo, branch, **kwargs)
     paths = repo_files.attrgot("path")
     return L(await parallel_async(self.get_file_content, paths, owner=owner, repo=repo, branch=branch, n_workers=n_workers))
 
@@ -379,7 +394,7 @@ async def read_issue(self:GhApi, issue_number:int):
     try: pr = await self.pulls.get(issue_number)
     except APIError: pr = None
     iss = await self.issues.get(issue_number)
-    res = dict(title=iss.title, body=iss.body or '', is_pr=pr is not None,
+    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'})
@@ -395,7 +410,7 @@ async def read_issue(self:GhApi, issue_number:int):
 def _filter_diff(diff, folder='', skip_files=('_modidx.py',)):
     "Filter unified diff to only include files under `folder`, skipping `skip_files`"
     sections = re.split(r'(?=^diff --git )', diff, flags=re.MULTILINE)
-    return ''.join(s for s in sections
+    return ''.join(s for s in sections  # chkstyle: ignore-node
                    if s.startswith(f'diff --git a/{folder}')
                    and not any(f'/{f} ' in s.split('\n')[0] for f in skip_files))
 
@@ -460,7 +475,7 @@ def _parse_tmpl(name, txt):
     if not name.endswith(('.yml','.yaml')): return dict2obj(dict(name=name, raw=txt))
     import yaml
     d = yaml.safe_load(txt)
-    secs = [dict(label=b['attributes']['label'], type=b['type'],
+    secs = [dict(label=b['attributes']['label'], type=b['type'],  # chkstyle: ignore-node
                  required=bool(nested_idx(b, 'validations', 'required')),
                  options=[o['label'] if isinstance(o, dict) else o for o in b['attributes'].get('options', [])])
             for b in d.get('body', []) if b['type']!='markdown']
@@ -475,7 +490,7 @@ async def issue_template(self:GhApi):
         except APIError as e:
             if e.status_code != 404: raise
             continue
-        return L([_parse_tmpl(f.name, base64.b64decode((await self.repos.get_content(path=f.path, **kw)).content).decode())
+        return L([_parse_tmpl(f.name, base64.b64decode((await self.repos.get_content(path=f.path, **kw)).content).decode())  # chkstyle: ignore-node
                   for f in fs if f.name.endswith(('.md','.yml','.yaml')) and f.name != 'config.yml'])
     return L()
 

{ghapi-2.0.1 → ghapi-2.0.3}/ghapi/event.py

@@ -129,7 +129,7 @@ def full_type(self:GhEvent):
 _all_ = ['PageBuildEvent', 'ContentReferenceEvent', 'RepositoryImportEvent', 'CreateEvent', 'WorkflowRunEvent', 'DeleteEvent', 'OrganizationEvent', 'SponsorshipEvent', 'ProjectColumnEvent', 'PushEvent', 'ContextEvent', 'MilestoneEvent', 'ProjectCardEvent', 'ProjectEvent', 'PackageEvent', 'PullRequestEvent', 'RepositoryDispatchEvent', 'TeamAddEvent', 'WorkflowDispatchEvent', 'MemberEvent', 'MetaEvent', 'CodeScanningAlertEvent',     'PublicEvent', 'NeedsEvent', 'CheckRunEvent', 'SecurityAdvisoryEvent', 'PullRequestReviewCommentEvent', 'OrgBlockEvent', 'CommitCommentEvent', 'WatchEvent', 'MarketplacePurchaseEvent', 'StarEvent', 'InstallationRepositoriesEvent', 'CheckSuiteEvent', 'GithubAppAuthorizationEvent', 'TeamEvent', 'StatusEvent', 'RepositoryVulnerabilityAlertEvent', 'PullRequestReviewEvent', 'LabelEvent', 'InstallationEvent', 'ReleaseEvent', 'IssuesEvent', 'RepositoryEvent', 'GollumEvent', 'MembershipEvent', 'DeploymentEvent', 'DeployKeyEvent', 'IssueCommentEvent', 'PingEvent', 'DeploymentStatusEvent', 'ForkEvent', 'ScheduleEvent']
 
 # %% ../nbs/04_event.ipynb #83be1955
-evt_emojis = dict(
+evt_emojis = dict(  # chkstyle: ignore-node
     PushEvent=                             '⭐',
     CreateEvent=                           '🏭',
     IssueCommentEvent_created=             '💬',
@@ -157,7 +157,7 @@ def _ref_detl(pay): return pay.ref_type + _ref(pay)
 
 def _action(self):
     pay = self.payload
-    det = (f'issue #{pay.issue.number} on' if isinstance(self,IssuesEvent) else
+    det = (f'issue #{pay.issue.number} on' if isinstance(self,IssuesEvent) else  # chkstyle: ignore-node
            f'PR #{pay.number} on' if isinstance(self,PullRequestEvent) else
            f'member {pay.member.login} in' if isinstance(self,MemberEvent) else
            f'review comment on PR #{pay.pull_request.number} in' if isinstance(self,PullRequestReviewCommentEvent) else
@@ -173,7 +173,7 @@ def description(self:GhEvent):
     "Description of event"
     act,pay,cls,repo = self.actor,self.payload,type(self),self.repo
     res = _action(self)
-    return res if res else (
+    return res if res else (  # chkstyle: ignore-node
         f'deleted {_ref_detl(pay)} in' if isinstance(self,DeleteEvent) else
         f'created {_ref_detl(pay)} in' if isinstance(self,CreateEvent) else
         f'pushed {len(pay.commits)} commits{_ref(pay," to")} in' if isinstance(self,PushEvent) else
@@ -184,17 +184,16 @@ def description(self:GhEvent):
         remove_suffix(self.type, "Event")
     )
 
-#export
 @patch(as_prop=True)
 def emoji(self:GhEvent):
     "Emoji for event from `evt_emojis`"
     return evt_emojis.get(self.full_type, '❌')
 
 # %% ../nbs/04_event.ipynb #daad2a54
-described_evts = (PushEvent,CreateEvent,IssueCommentEvent,WatchEvent,PullRequestEvent,PullRequestReviewEvent,PullRequestReviewCommentEvent,
+described_evts = (PushEvent,CreateEvent,IssueCommentEvent,WatchEvent,PullRequestEvent,PullRequestReviewEvent,PullRequestReviewCommentEvent,  # chkstyle: ignore-node
                   DeleteEvent,ForkEvent,IssuesEvent,ReleaseEvent,MemberEvent,CommitCommentEvent,GollumEvent,PublicEvent)
 
-_text_keys = dict(
+_text_keys = dict(  # chkstyle: ignore-node
     CreateEvent = "description",
     PullRequestEvent = "pull_request.title",
     PullRequestReviewCommentEvent = "comment.body",

{ghapi-2.0.1 → ghapi-2.0.3}/ghapi/gh_spec.py

@@ -6495,7 +6495,7 @@ spec = {'base_url': 'https://api.github.com',
           'verb': 'GET',
           'summary': 'List secret scanning alerts for an organization',
           'route_params': ['org'],
-          'query_params': ['state', 'secret_type', 'exclude_secret_types', 'exclude_providers', 'providers', 'resolution', 'assignee', 'sort', 'direction', 'page', 'per_page', 'before', 'after', 'validity', 'is_publicly_leaked', 'is_multi_repo', 'hide_secret', 'is_bypassed'],
+          'query_params': ['state', 'secret_type', 'exclude_secret_types', 'exclude_providers', 'providers', 'resolution', 'assignee', 'sort', 'direction', 'page', 'per_page', 'before', 'after', 'validity', 'is_publicly_leaked', 'is_multi_repo', 'hide_secret', 'is_bypassed', 'included_metadata', 'owner_email_hash'],
           'required_params': ['org'],
           'param_types': {'org': 'str',
                           'state': 'str',
@@ -6515,7 +6515,9 @@ spec = {'base_url': 'https://api.github.com',
                           'is_publicly_leaked': 'bool',
                           'is_multi_repo': 'bool',
                           'hide_secret': 'bool',
-                          'is_bypassed': 'bool'},
+                          'is_bypassed': 'bool',
+                          'included_metadata': 'str',
+                          'owner_email_hash': 'str'},
           'param_defaults': {'sort': 'created', 'direction': 'desc', 'page': 1, 'per_page': 30, 'is_publicly_leaked': False, 'is_multi_repo': False, 'hide_secret': False},
           'param_docs': {'org': 'The organization name. The name is not case sensitive.',
                          'state': 'Set to `open` or `resolved` to only list secret scanning alerts in a specific state.',
@@ -6538,7 +6540,11 @@ spec = {'base_url': 'https://api.github.com',
                          'is_multi_repo': 'A boolean value representing whether or not to filter alerts by the multi-repo tag being present.',
                          'hide_secret': 'A boolean value representing whether or not to hide literal secrets in the results.',
                          'is_bypassed': 'A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be '
-                                        'returned.'},
+                                        'returned.',
+                         'included_metadata': 'A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, '
+                                              '`organization-id`, `last-used-date`, and `has-organization-access`.',
+                         'owner_email_hash': 'Filters alerts to only those whose attached `owner_email` metadata field matches the provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email address to match (for example, the SHA-256 of `user@example.com`). Only alerts that have an `owner_email` metadata value whose SHA-256 hash '
+                                             'equals this parameter are returned.'},
           'docs_url': 'https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization'},
          {'group': 'secret_scanning',
           'name': 'list_org_pattern_configs',
@@ -11396,6 +11402,31 @@ spec = {'base_url': 'https://api.github.com',
           'param_types': {'owner': 'str', 'repo': 'str', 'users': 'list'},
           'param_docs': {'owner': 'The account owner of the repository. The name is not case sensitive.', 'repo': 'The name of the repository without the `.git` extension. The name is not case sensitive.', 'users': 'A list of user logins to add or remove from the bypass list.'},
           'docs_url': 'https://docs.github.com/rest/interactions/repos#remove-users-from-the-pull-request-creation-cap-bypass-list-for-a-repository'},
+         {'group': 'interactions',
+          'name': 'get_pull_request_creation_cap_for_repo',
+          'path': '/repos/{owner}/{repo}/interaction-limits/pulls/creation-cap',
+          'verb': 'GET',
+          'summary': 'Get pull request creation cap for a repository',
+          'route_params': ['owner', 'repo'],
+          'required_params': ['owner', 'repo'],
+          'param_types': {'owner': 'str', 'repo': 'str'},
+          'param_docs': {'owner': 'The account owner of the repository. The name is not case sensitive.', 'repo': 'The name of the repository without the `.git` extension. The name is not case sensitive.'},
+          'docs_url': 'https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-for-a-repository'},
+         {'group': 'interactions',
+          'name': 'update_pull_request_creation_cap_for_repo',
+          'path': '/repos/{owner}/{repo}/interaction-limits/pulls/creation-cap',
+          'verb': 'PATCH',
+          'summary': 'Update pull request creation cap for a repository',
+          'route_params': ['owner', 'repo'],
+          'body_params': ['enabled', 'max_open_pull_requests'],
+          'request_content_type': 'application/json',
+          'required_params': ['enabled', 'owner', 'repo'],
+          'param_types': {'owner': 'str', 'repo': 'str', 'enabled': 'bool', 'max_open_pull_requests': 'int'},
+          'param_docs': {'owner': 'The account owner of the repository. The name is not case sensitive.',
+                         'repo': 'The name of the repository without the `.git` extension. The name is not case sensitive.',
+                         'enabled': 'Whether the pull request creation cap is enabled',
+                         'max_open_pull_requests': 'The maximum number of open pull requests a user can have at one time'},
+          'docs_url': 'https://docs.github.com/rest/interactions/repos#update-pull-request-creation-cap-for-a-repository'},
          {'group': 'repos',
           'name': 'list_invitations',
           'path': '/repos/{owner}/{repo}/invitations',
@@ -13469,7 +13500,7 @@ spec = {'base_url': 'https://api.github.com',
           'verb': 'GET',
           'summary': 'List secret scanning alerts for a repository',
           'route_params': ['owner', 'repo'],
-          'query_params': ['state', 'secret_type', 'exclude_secret_types', 'exclude_providers', 'providers', 'resolution', 'assignee', 'sort', 'direction', 'page', 'per_page', 'before', 'after', 'validity', 'is_publicly_leaked', 'is_multi_repo', 'hide_secret', 'is_bypassed'],
+          'query_params': ['state', 'secret_type', 'exclude_secret_types', 'exclude_providers', 'providers', 'resolution', 'assignee', 'sort', 'direction', 'page', 'per_page', 'before', 'after', 'validity', 'is_publicly_leaked', 'is_multi_repo', 'hide_secret', 'is_bypassed', 'included_metadata', 'owner_email_hash'],
           'required_params': ['owner', 'repo'],
           'param_types': {'owner': 'str',
                           'repo': 'str',
@@ -13490,7 +13521,9 @@ spec = {'base_url': 'https://api.github.com',
                           'is_publicly_leaked': 'bool',
                           'is_multi_repo': 'bool',
                           'hide_secret': 'bool',
-                          'is_bypassed': 'bool'},
+                          'is_bypassed': 'bool',
+                          'included_metadata': 'str',
+                          'owner_email_hash': 'str'},
           'param_defaults': {'sort': 'created', 'direction': 'desc', 'page': 1, 'per_page': 30, 'is_publicly_leaked': False, 'is_multi_repo': False, 'hide_secret': False},
           'param_docs': {'owner': 'The account owner of the repository. The name is not case sensitive.',
                          'repo': 'The name of the repository without the `.git` extension. The name is not case sensitive.',
@@ -13514,7 +13547,11 @@ spec = {'base_url': 'https://api.github.com',
                          'is_multi_repo': 'A boolean value representing whether or not to filter alerts by the multi-repo tag being present.',
                          'hide_secret': 'A boolean value representing whether or not to hide literal secrets in the results.',
                          'is_bypassed': 'A boolean value (`true` or `false`) indicating whether to filter alerts by their push protection bypass status. When set to `true`, only alerts that were created because a push protection rule was bypassed will be returned. When set to `false`, only alerts that were not caused by a push protection bypass will be '
-                                        'returned.'},
+                                        'returned.',
+                         'included_metadata': 'A comma-separated list of metadata fields to filter alerts by. Only alerts that have all of the specified metadata fields attached will be returned. Possible values are: `owner-email`, `owner-id`, `owner-name`, `secret-id`, `secret-name`, `secret-issued-date`, `secret-expiration-date`, `organization-name`, '
+                                              '`organization-id`, `last-used-date`, and `has-organization-access`.',
+                         'owner_email_hash': 'Filters alerts to only those whose attached `owner_email` metadata field matches the provided value. The value must be the lowercase hex-encoded SHA-256 hash of the email address to match (for example, the SHA-256 of `user@example.com`). Only alerts that have an `owner_email` metadata value whose SHA-256 hash '
+                                             'equals this parameter are returned.'},
           'docs_url': 'https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository'},
          {'group': 'secret_scanning',
           'name': 'get_alert',

{ghapi-2.0.1 → ghapi-2.0.3}/ghapi/graphql.py

@@ -24,10 +24,7 @@ class GhGql:
         "Lazy-load the GraphQL client and schema"
         if self._client is None:
             if not self.token: raise ValueError("GITHUB_TOKEN not set")
-            transport = RequestsHTTPTransport(
-                url='https://api.github.com/graphql',
-                headers={'Authorization': f'bearer {self.token}'}
-            )
+            transport = RequestsHTTPTransport(url='https://api.github.com/graphql', headers={'Authorization': f'bearer {self.token}'})
             self._client = Client(transport=transport, fetch_schema_from_transport=True)
             self._client.execute(gql('{ __typename }'))  # Trigger schema fetch
         return self._client

{ghapi-2.0.1 → ghapi-2.0.3}/ghapi/skill.py

@@ -60,6 +60,14 @@ For anything that's about the local repo/working tree rather than GitHub itself
 
 `Git.__call__` prints (not raises) on a `CalledProcessError` unless you pass `mute_errors=True` -- check the return value, don't assume no exception means success.
 
+# External PRs
+
+For a PR to another owner's repo, use normal local Git through the commit, ensure your fork exists, then use one client scoped to the fork. `commit_tree` uploads GitHub tree entries as one commit without Git transport authentication; override `owner` only when creating the upstream PR:
+
+    api = GhApi('me', repo)
+    await api.commit_tree(branch, message, entries)
+    await api.pulls.create(owner='upstream', head=f'me:{branch}', base='main', title=title, body=body)
+
 # Gotchas
 
 - A PR *is* an issue for general comments (`issues.list_comments`, not `pulls.*`) -- inline code-review comments are the separate `pulls.list_review_comments`.

{ghapi-2.0.1 → ghapi-2.0.3/ghapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghapi
-Version: 2.0.1
+Version: 2.0.3
 Summary: A python client for the GitHub API
 Author-email: Jeremy Howard <info@fast.ai>
 License: Apache-2.0

ghapi-2.0.1/ghapi/__init__.py

@@ -1 +0,0 @@
-__version__ = "2.0.1"