ghapi 2.0.6__tar.gz → 2.0.7__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghapi
-Version: 2.0.6
+Version: 2.0.7
 Summary: A python client for the GitHub API
 Author-email: Jeremy Howard <info@fast.ai>
 License: Apache-2.0
@@ -15,8 +15,8 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastcore>=2.1.16
-Requires-Dist: fastspec>=0.1.5
+Requires-Dist: fastcore>=2.2.6
+Requires-Dist: fastspec>=0.1.7
 Requires-Dist: tomli; python_version < "3.11"
 Provides-Extra: dev
 Requires-Dist: fastgit; extra == "dev"
@@ -70,6 +70,9 @@ To access the GitHub API, first create a [`GhApi`](https://ghapi.fast.ai/core.ht
 
 ``` python
 from ghapi.all import GhApi
+```
+
+``` python
 api = GhApi()
 ```
 
@@ -79,8 +82,6 @@ Every part of the API includes documentation directly in the `api` object itself
 api
 ```
 
-<div class="prose" markdown="1">
-
 - [actions](https://docs.github.com/rest/reference/actions)
 - [activity](https://docs.github.com/rest/reference/activity)
 - [agent_tasks](https://docs.github.com/rest/reference/agent-tasks)
@@ -120,6 +121,7 @@ api
 - [packages](https://docs.github.com/rest/reference/packages)
 - [private_registries](https://docs.github.com/rest/reference/private-registries)
 - [projects](https://docs.github.com/rest/reference/projects)
+- [pull_request_stacks](https://docs.github.com/rest/reference/pull-request-stacks)
 - [pulls](https://docs.github.com/rest/reference/pulls)
 - [rate_limit](https://docs.github.com/rest/reference/rate-limit)
 - [reactions](https://docs.github.com/rest/reference/reactions)
@@ -130,16 +132,12 @@ api
 - [teams](https://docs.github.com/rest/reference/teams)
 - [users](https://docs.github.com/rest/reference/users)
 
-</div>
-
 Then we can explore the endpoints provided by the API in each group, e.g. for the `git` group:
 
 ``` python
 api.git
 ```
 
-<div class="prose" markdown="1">
-
 - [git.create_blob](https://docs.github.com/rest/git/blobs#create-a-blob)(owner, repo, content, encoding): *Create a blob*
 - [git.get_blob](https://docs.github.com/rest/git/blobs#get-a-blob)(owner, repo, file_sha): *Get a blob*
 - [git.create_commit](https://docs.github.com/rest/git/commits#create-a-commit)(owner, repo, message, tree, parents, author, committer, signature): *Create a commit*
@@ -154,16 +152,12 @@ api.git
 - [git.create_tree](https://docs.github.com/rest/git/trees#create-a-tree)(owner, repo, tree, base_tree): *Create a tree*
 - [git.get_tree](https://docs.github.com/rest/git/trees#get-a-tree)(owner, repo, tree_sha, recursive): *Get a tree*
 
-</div>
-
 Here’s how to learn about an endpoint you want to use, e.g.:
 
 ``` python
 api.git.get_ref
 ```
 
-<div class="prose" markdown="1">
-
 Get a reference
 
 Docs: https://docs.github.com/rest/git/refs#get-a-reference
@@ -173,16 +167,12 @@ Parameters:
 - repo (str, required): The name of the repository without the `.git` extension. The name is not case sensitive.
 - ref (str, required): The Git reference. For more information, see “[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)” in the Git documentation.
 
-</div>
-
-In Jupyter Notebook full tab completion, parameter lists, etc are provided for all endpoints. Endpoints are called as standard Python methods:
+Jupyter provides full tab completion and parameter lists for every endpoint. Endpoints are called as standard Python methods:
 
 ``` python
 await api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
 ```
 
-<div class="prose" markdown="1">
-
 ``` python
 { 'node_id': 'MDM6UmVmMjI1NDYwNTk5OnJlZnMvaGVhZHMvbWFzdGVy',
   'object': { 'sha': 'c0608379fe60014534c8dffe2e381138e8160f53',
@@ -192,17 +182,13 @@ await api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
   'url': 'https://api.github.com/repos/AnswerDotAI/fastcore/git/refs/heads/master'}
 ```
 
-</div>
-
-To use [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) to access authenticated operations (other than when running through GitHub Actions), you will need a GitHub [personal access token](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token), which is a secret code used to access your account. If you don’t have one, [click here](https://github.com/settings/tokens/new) to create one. You’ll be asked to enter a name – choose anything you like, for instance “*ghapi*”. You’ll also be asked to choose “scopes”; this limits what you’ll be able to do with the API using this token. If you’re not sure, click “*repo*” “*gist*”, “*notifications*”, and “*workflow*”. Then click “Generate Token” at the bottom of the screen, and copy the token (the long string of letters and numbers shown). You can easily do that by clicking the little clipboard icon next to the token.
-
-Rather than pasting that token into every script, it’s easiest to save it as an environment variable. If you save it as `$GITHUB_TOKEN` then it will be most convenient, so add this to the end of your `.bashrc` or `.zshrc` file:
+To use authenticated operations (other than when running through GitHub Actions), you will need a GitHub [personal access token](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token). If you don’t have one, [click here](https://github.com/settings/tokens/new) to create it, choosing the scopes you need (“repo”, “gist”, “notifications”, and “workflow” cover most uses). Save it as an environment variable named `GITHUB_TOKEN`, e.g. by adding this to your `.bashrc` or `.zshrc`:
 
     export GITHUB_TOKEN=xxx
 
-…replacing the `xxx` with the token you just copied. (Don’t forget to `source` that file after you change it.), pass a \[GitHub token\].
+[`GhApi`](https://ghapi.fast.ai/core.html#ghapi) uses that variable automatically, or you can pass `token=` explicitly.
 
-As well as your `token`, you can also pass any parameters you want auto-inserted into relevant methods, such as `owner` and `repo`:
+As well as `token`, you can pass any parameters you want auto-inserted into relevant methods, such as `owner` and `repo`:
 
 ``` python
 api = GhApi(owner='fastai', repo='fastcore', token=github_token)
@@ -214,8 +200,6 @@ We can now repeat the previous method, but only need to pass `ref`:
 await api.git.get_ref('heads/master')
 ```
 
-<div class="prose" markdown="1">
-
 ``` python
 { 'node_id': 'MDM6UmVmMjI1NDYwNTk5OnJlZnMvaGVhZHMvbWFzdGVy',
   'object': { 'sha': 'c0608379fe60014534c8dffe2e381138e8160f53',
@@ -225,8 +209,6 @@ await api.git.get_ref('heads/master')
   'url': 'https://api.github.com/repos/AnswerDotAI/fastcore/git/refs/heads/master'}
 ```
 
-</div>
-
 Now that we’ve provided our token, we can use authenticated endpoints such as creating an issue:
 
 ``` python
@@ -239,6 +221,38 @@ Since we’ve now checked out GhApi, let’s close this issue. 😎
 await api.issues.update(issue.number, state='closed')
 ```
 
+## Beyond the endpoints
+
+[`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) also layers task-level conveniences over the generated endpoints – see the [GhApi details](https://ghapi.fast.ai/core.html) page for the full set. Highlights: [`paged`](https://ghapi.fast.ai/page.html#paged)/[`pages`](https://ghapi.fast.ai/page.html#pages) iterate any list endpoint; [`read_issue`](https://ghapi.fast.ai/core.html#read_issue)/[`read_pr`](https://ghapi.fast.ai/core.html#read_pr) gather a whole issue or PR (body, comments, diff, reviews) in one call; [`dep_graph`](https://ghapi.fast.ai/core.html#dep_graph)/[`dep_order`](https://ghapi.fast.ai/core.html#dep_order) sort an ecosystem’s repos dependency-first; plus helpers for gists, releases, branches, and repo files. For CI, [`check_status`](https://ghapi.fast.ai/core.html#check_status) combines commit statuses and check runs into one verdict, and [`failed_step_log`](https://ghapi.fast.ai/core.html#failed_step_log) drills into why a run went red:
+
+``` python
+api = GhApi(owner='AnswerDotAI', repo='ghapi', token=github_token)
+await api.check_status('main')
+```
+
+**failure**
+
+- 93199230629 update-pip-graph: success (46s)
+- 93199227080 deploy: failure (22s)
+
+## GraphQL
+
+When a read fans out across many repos, the [GraphQL client](https://ghapi.fast.ai/graphql.html) fetches it in a single `batch` call – issued as parallel chunked requests under the hood, at a fraction of the rate-limit cost of per-repo REST calls. Build schema-checked query fragments by attribute chaining, then `batch` them: here, the head commit of several repos at once. The same page covers interactive schema discovery, cursor pagination, raw queries, and more:
+
+``` python
+from ghapi.graphql import GhGql
+```
+
+``` python
+gql = GhGql()
+await gql.batch(*[gql.repository(owner='AnswerDotAI', name=n).defaultBranchRef.target.oid
+    for n in ('fastcore', 'fasthtml', 'ghapi')])
+```
+
+    ['25c4f3228ccac3c5a63da71b5eaa4be3c428f602',
+     'e5d967ae627c63035e296e6f319f220e278327e7',
+     'ad07893daac86de6693bc9bb57ae7216c1b347d0']
+
 ## How to use - command line
 
 You can use [`GhApi`](https://ghapi.fast.ai/core.html#ghapi) via the command line, and can access nearly everything in the [GitHub API](https://docs.github.com/rest). We provide an overview here of one of the command line programs, [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) – see the full CLI docs page for details on all the programs available.

{ghapi-2.0.6 → ghapi-2.0.7}/README.md

@@ -40,6 +40,9 @@ To access the GitHub API, first create a [`GhApi`](https://ghapi.fast.ai/core.ht
 
 ``` python
 from ghapi.all import GhApi
+```
+
+``` python
 api = GhApi()
 ```
 
@@ -49,8 +52,6 @@ Every part of the API includes documentation directly in the `api` object itself
 api
 ```
 
-<div class="prose" markdown="1">
-
 - [actions](https://docs.github.com/rest/reference/actions)
 - [activity](https://docs.github.com/rest/reference/activity)
 - [agent_tasks](https://docs.github.com/rest/reference/agent-tasks)
@@ -90,6 +91,7 @@ api
 - [packages](https://docs.github.com/rest/reference/packages)
 - [private_registries](https://docs.github.com/rest/reference/private-registries)
 - [projects](https://docs.github.com/rest/reference/projects)
+- [pull_request_stacks](https://docs.github.com/rest/reference/pull-request-stacks)
 - [pulls](https://docs.github.com/rest/reference/pulls)
 - [rate_limit](https://docs.github.com/rest/reference/rate-limit)
 - [reactions](https://docs.github.com/rest/reference/reactions)
@@ -100,16 +102,12 @@ api
 - [teams](https://docs.github.com/rest/reference/teams)
 - [users](https://docs.github.com/rest/reference/users)
 
-</div>
-
 Then we can explore the endpoints provided by the API in each group, e.g. for the `git` group:
 
 ``` python
 api.git
 ```
 
-<div class="prose" markdown="1">
-
 - [git.create_blob](https://docs.github.com/rest/git/blobs#create-a-blob)(owner, repo, content, encoding): *Create a blob*
 - [git.get_blob](https://docs.github.com/rest/git/blobs#get-a-blob)(owner, repo, file_sha): *Get a blob*
 - [git.create_commit](https://docs.github.com/rest/git/commits#create-a-commit)(owner, repo, message, tree, parents, author, committer, signature): *Create a commit*
@@ -124,16 +122,12 @@ api.git
 - [git.create_tree](https://docs.github.com/rest/git/trees#create-a-tree)(owner, repo, tree, base_tree): *Create a tree*
 - [git.get_tree](https://docs.github.com/rest/git/trees#get-a-tree)(owner, repo, tree_sha, recursive): *Get a tree*
 
-</div>
-
 Here’s how to learn about an endpoint you want to use, e.g.:
 
 ``` python
 api.git.get_ref
 ```
 
-<div class="prose" markdown="1">
-
 Get a reference
 
 Docs: https://docs.github.com/rest/git/refs#get-a-reference
@@ -143,16 +137,12 @@ Parameters:
 - repo (str, required): The name of the repository without the `.git` extension. The name is not case sensitive.
 - ref (str, required): The Git reference. For more information, see “[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)” in the Git documentation.
 
-</div>
-
-In Jupyter Notebook full tab completion, parameter lists, etc are provided for all endpoints. Endpoints are called as standard Python methods:
+Jupyter provides full tab completion and parameter lists for every endpoint. Endpoints are called as standard Python methods:
 
 ``` python
 await api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
 ```
 
-<div class="prose" markdown="1">
-
 ``` python
 { 'node_id': 'MDM6UmVmMjI1NDYwNTk5OnJlZnMvaGVhZHMvbWFzdGVy',
   'object': { 'sha': 'c0608379fe60014534c8dffe2e381138e8160f53',
@@ -162,17 +152,13 @@ await api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
   'url': 'https://api.github.com/repos/AnswerDotAI/fastcore/git/refs/heads/master'}
 ```
 
-</div>
-
-To use [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) to access authenticated operations (other than when running through GitHub Actions), you will need a GitHub [personal access token](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token), which is a secret code used to access your account. If you don’t have one, [click here](https://github.com/settings/tokens/new) to create one. You’ll be asked to enter a name – choose anything you like, for instance “*ghapi*”. You’ll also be asked to choose “scopes”; this limits what you’ll be able to do with the API using this token. If you’re not sure, click “*repo*” “*gist*”, “*notifications*”, and “*workflow*”. Then click “Generate Token” at the bottom of the screen, and copy the token (the long string of letters and numbers shown). You can easily do that by clicking the little clipboard icon next to the token.
-
-Rather than pasting that token into every script, it’s easiest to save it as an environment variable. If you save it as `$GITHUB_TOKEN` then it will be most convenient, so add this to the end of your `.bashrc` or `.zshrc` file:
+To use authenticated operations (other than when running through GitHub Actions), you will need a GitHub [personal access token](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token). If you don’t have one, [click here](https://github.com/settings/tokens/new) to create it, choosing the scopes you need (“repo”, “gist”, “notifications”, and “workflow” cover most uses). Save it as an environment variable named `GITHUB_TOKEN`, e.g. by adding this to your `.bashrc` or `.zshrc`:
 
     export GITHUB_TOKEN=xxx
 
-…replacing the `xxx` with the token you just copied. (Don’t forget to `source` that file after you change it.), pass a \[GitHub token\].
+[`GhApi`](https://ghapi.fast.ai/core.html#ghapi) uses that variable automatically, or you can pass `token=` explicitly.
 
-As well as your `token`, you can also pass any parameters you want auto-inserted into relevant methods, such as `owner` and `repo`:
+As well as `token`, you can pass any parameters you want auto-inserted into relevant methods, such as `owner` and `repo`:
 
 ``` python
 api = GhApi(owner='fastai', repo='fastcore', token=github_token)
@@ -184,8 +170,6 @@ We can now repeat the previous method, but only need to pass `ref`:
 await api.git.get_ref('heads/master')
 ```
 
-<div class="prose" markdown="1">
-
 ``` python
 { 'node_id': 'MDM6UmVmMjI1NDYwNTk5OnJlZnMvaGVhZHMvbWFzdGVy',
   'object': { 'sha': 'c0608379fe60014534c8dffe2e381138e8160f53',
@@ -195,8 +179,6 @@ await api.git.get_ref('heads/master')
   'url': 'https://api.github.com/repos/AnswerDotAI/fastcore/git/refs/heads/master'}
 ```
 
-</div>
-
 Now that we’ve provided our token, we can use authenticated endpoints such as creating an issue:
 
 ``` python
@@ -209,6 +191,38 @@ Since we’ve now checked out GhApi, let’s close this issue. 😎
 await api.issues.update(issue.number, state='closed')
 ```
 
+## Beyond the endpoints
+
+[`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) also layers task-level conveniences over the generated endpoints – see the [GhApi details](https://ghapi.fast.ai/core.html) page for the full set. Highlights: [`paged`](https://ghapi.fast.ai/page.html#paged)/[`pages`](https://ghapi.fast.ai/page.html#pages) iterate any list endpoint; [`read_issue`](https://ghapi.fast.ai/core.html#read_issue)/[`read_pr`](https://ghapi.fast.ai/core.html#read_pr) gather a whole issue or PR (body, comments, diff, reviews) in one call; [`dep_graph`](https://ghapi.fast.ai/core.html#dep_graph)/[`dep_order`](https://ghapi.fast.ai/core.html#dep_order) sort an ecosystem’s repos dependency-first; plus helpers for gists, releases, branches, and repo files. For CI, [`check_status`](https://ghapi.fast.ai/core.html#check_status) combines commit statuses and check runs into one verdict, and [`failed_step_log`](https://ghapi.fast.ai/core.html#failed_step_log) drills into why a run went red:
+
+``` python
+api = GhApi(owner='AnswerDotAI', repo='ghapi', token=github_token)
+await api.check_status('main')
+```
+
+**failure**
+
+- 93199230629 update-pip-graph: success (46s)
+- 93199227080 deploy: failure (22s)
+
+## GraphQL
+
+When a read fans out across many repos, the [GraphQL client](https://ghapi.fast.ai/graphql.html) fetches it in a single `batch` call – issued as parallel chunked requests under the hood, at a fraction of the rate-limit cost of per-repo REST calls. Build schema-checked query fragments by attribute chaining, then `batch` them: here, the head commit of several repos at once. The same page covers interactive schema discovery, cursor pagination, raw queries, and more:
+
+``` python
+from ghapi.graphql import GhGql
+```
+
+``` python
+gql = GhGql()
+await gql.batch(*[gql.repository(owner='AnswerDotAI', name=n).defaultBranchRef.target.oid
+    for n in ('fastcore', 'fasthtml', 'ghapi')])
+```
+
+    ['25c4f3228ccac3c5a63da71b5eaa4be3c428f602',
+     'e5d967ae627c63035e296e6f319f220e278327e7',
+     'ad07893daac86de6693bc9bb57ae7216c1b347d0']
+
 ## How to use - command line
 
 You can use [`GhApi`](https://ghapi.fast.ai/core.html#ghapi) via the command line, and can access nearly everything in the [GitHub API](https://docs.github.com/rest). We provide an overview here of one of the command line programs, [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) – see the full CLI docs page for details on all the programs available.

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

@@ -2,6 +2,7 @@
 
 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.6"
+__version__ = "2.0.7"

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

@@ -32,7 +32,8 @@ d = { 'settings': { 'branch': 'main',
                             'ghapi.auth.GhDeviceAuth.wait': ('auth.html#ghdeviceauth.wait', 'ghapi/auth.py'),
                             'ghapi.auth.github_auth_device': ('auth.html#github_auth_device', 'ghapi/auth.py'),
                             'ghapi.auth.scope_str': ('auth.html#scope_str', 'ghapi/auth.py')},
-            'ghapi.build_lib': {'ghapi.build_lib.build_spec': ('build_lib.html#build_spec', 'ghapi/build_lib.py')},
+            'ghapi.build_lib': { 'ghapi.build_lib.build_gql_spec': ('build_lib.html#build_gql_spec', 'ghapi/build_lib.py'),
+                                 'ghapi.build_lib.build_spec': ('build_lib.html#build_spec', 'ghapi/build_lib.py')},
             'ghapi.cli': { 'ghapi.cli._api': ('cli.html#_api', 'ghapi/cli.py'),
                            'ghapi.cli._call_api': ('cli.html#_call_api', 'ghapi/cli.py'),
                            'ghapi.cli._ghapi': ('cli.html#_ghapi', 'ghapi/cli.py'),
@@ -144,19 +145,10 @@ d = { 'settings': { 'branch': 'main',
                              'ghapi.event.load_sample_events': ('event.html#load_sample_events', 'ghapi/event.py'),
                              'ghapi.event.save_sample_events': ('event.html#save_sample_events', 'ghapi/event.py')},
             'ghapi.gh_spec': {},
+            'ghapi.gql_spec': {},
             'ghapi.graphql': { 'ghapi.graphql.GhGql': ('graphql.html#ghgql', 'ghapi/graphql.py'),
-                               'ghapi.graphql.GhGql.__call__': ('graphql.html#ghgql.__call__', 'ghapi/graphql.py'),
                                'ghapi.graphql.GhGql.__init__': ('graphql.html#ghgql.__init__', 'ghapi/graphql.py'),
-                               'ghapi.graphql.GhGql.client': ('graphql.html#ghgql.client', 'ghapi/graphql.py'),
-                               'ghapi.graphql.GhGql.list_queries': ('graphql.html#ghgql.list_queries', 'ghapi/graphql.py'),
-                               'ghapi.graphql.GhGql.query_args': ('graphql.html#ghgql.query_args', 'ghapi/graphql.py'),
-                               'ghapi.graphql.GhGql.schema': ('graphql.html#ghgql.schema', 'ghapi/graphql.py'),
-                               'ghapi.graphql.GhGql.type_fields': ('graphql.html#ghgql.type_fields', 'ghapi/graphql.py'),
-                               'ghapi.graphql._get_client': ('graphql.html#_get_client', 'ghapi/graphql.py'),
-                               'ghapi.graphql.gh_query': ('graphql.html#gh_query', 'ghapi/graphql.py'),
-                               'ghapi.graphql.list_queries': ('graphql.html#list_queries', 'ghapi/graphql.py'),
-                               'ghapi.graphql.query_args': ('graphql.html#query_args', 'ghapi/graphql.py'),
-                               'ghapi.graphql.type_fields': ('graphql.html#type_fields', '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._Scanner': ('page.html#_scanner', 'ghapi/page.py'),
                             'ghapi.page._Scanner.__getitem__': ('page.html#_scanner.__getitem__', 'ghapi/page.py'),

{ghapi-2.0.6 → ghapi-2.0.7}/ghapi/build_lib.py

@@ -3,13 +3,14 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/90_build_lib.ipynb.
 
 # %% auto #0
-__all__ = ['GH_OPENAPI_URL', 'build_spec']
+__all__ = ['GH_OPENAPI_URL', 'build_spec', 'build_gql_spec']
 
 # %% ../nbs/90_build_lib.ipynb #cdbcf258
 from fastcore.all import *
 from fastspec.spec import SpecParser
+from fastspec.gql import GqlSpec, INTROSPECT
 
-import json
+import json, httpx
 
 # %% ../nbs/90_build_lib.ipynb #c215ed8d
 GH_OPENAPI_URL = 'https://github.com/github/rest-api-description/raw/main/descriptions/api.github.com/api.github.com.json?raw=true' 
@@ -18,3 +19,10 @@ GH_OPENAPI_URL = 'https://github.com/github/rest-api-description/raw/main/descri
 def build_spec(nm='ghapi/gh_spec.py', url=GH_OPENAPI_URL):
     "Regenerate the compact spec module `gh_spec.py` from GitHub's OpenAPI description."
     SpecParser.from_openapi(dict2obj(json.loads(urlread(url)))).save(nm)
+
+# %% ../nbs/90_build_lib.ipynb #9aef0afb
+def build_gql_spec(nm='ghapi/gql_spec.py', url='https://api.github.com/graphql'):
+    "Regenerate the distilled GraphQL schema tables shipped as `ghapi.gql_spec`."
+    r = httpx.post(url, json=dict(query=INTROSPECT), headers=dict(Authorization=f'bearer {os.environ["GITHUB_TOKEN"]}'), timeout=60)
+    r.raise_for_status()
+    GqlSpec.from_introspection(r.json()).save(nm)

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

@@ -242,11 +242,11 @@ async def upload_file(self:GhApi, rel, fn):
 
 # %% ../nbs/00_core.ipynb #3cad71a4
 @gh_patch
-async def create_release(self:GhApi, tag_name, branch='master', name=None, body='',
+async def create_release(self:GhApi, tag_name, branch=None, name=None, body='',
     draft=False, prerelease=False, files=None, make_latest=UNSET):
-    "Wrapper for `GhApi.repos.create_release` which also uploads `files`"
+    "Wrapper for `GhApi.repos.create_release` which also uploads `files`; `branch` defaults to the repo's default branch"
     if name is None: name = 'v'+tag_name
-    rel = await self.repos.create_release(tag_name, target_commitish=branch, name=name, body=body,
+    rel = await self.repos.create_release(tag_name, target_commitish=branch or UNSET, name=name, body=body,
         draft=draft, prerelease=prerelease, make_latest=make_latest)
     for file in listify(files): await self.upload_file(rel, file)
     return rel
@@ -393,7 +393,7 @@ async def get_repo_contents(self:GhApi, owner, repo, branch='main',
 ):
     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))
+    return await parallel_async(self.get_file_content, paths, owner=owner, repo=repo, branch=branch, n_workers=n_workers)
 
 # %% ../nbs/00_core.ipynb #ac4ab4e0
 @gh_patch