ghapi 1.1.0__tar.gz → 2.0.0__tar.gz

{ghapi-1.1.0 → ghapi-2.0.0}/MANIFEST.in

@@ -1,4 +1,3 @@
-include settings.ini
 include LICENSE
 include CONTRIBUTING.md
 include README.md

{ghapi-1.1.0/ghapi.egg-info → ghapi-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghapi
-Version: 1.1.0
+Version: 2.0.0
 Summary: A python client for the GitHub API
 Author-email: Jeremy Howard <info@fast.ai>
 License: Apache-2.0
@@ -12,13 +12,13 @@ Classifier: Intended Audience :: Developers
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.7
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastcore>=1.12.19
+Requires-Dist: fastcore>=1.14.3
+Requires-Dist: fastspec>=0.1.0
 Provides-Extra: dev
 Requires-Dist: fastgit; extra == "dev"
-Requires-Dist: jsonref; extra == "dev"
 Requires-Dist: matplotlib; extra == "dev"
 Requires-Dist: nbclassic; extra == "dev"
 Requires-Dist: nbdev; extra == "dev"
@@ -31,6 +31,15 @@ Dynamic: license-file
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
+> **ghapi v2 (July 2026) is now async by default.** Every API call is
+> now awaited: `res = await api.repos.get()`. Top-level `await` works
+> directly in Jupyter and modern REPLs; in scripts, use
+> [`asyncio.run`](https://docs.python.org/3/library/asyncio-runner.html#asyncio.run).
+> For sync code (which should be largely compatible with v1), use
+> `GhApi(sync=True)`. See the [Sync
+> usage](https://ghapi.fast.ai/core.html#sync-usage) section of the docs
+> for details. To stay on the old version, pin `ghapi<2`.
+
 [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) provides 100%
 always-updated coverage of the entire [GitHub
 API](https://docs.github.com/rest). Because we automatically convert the
@@ -38,7 +47,8 @@ API](https://docs.github.com/rest). Because we automatically convert the
 spec](https://docs.github.com/rest/overview/openapi-description) to a
 Pythonic API, [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) is always
 up to date with the latest changes to GitHub APIs. Furthermore, because
-this is all done dynamically, the entire package is only 35kB in size!
+this is all built dynamically from a compact pre-parsed copy of the
+spec, the package stays small and is always up to date.
 
 Using [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi), you can automate
 nearly anything that you can do through the GitHub web interface or
@@ -67,8 +77,7 @@ or from the command line. An overview of each is provided below.
 
 ## Installation
 
-To install, run either `pip install ghapi` or
-`conda install -c fastai ghapi`.
+To install, run `pip install ghapi`.
 
 ## How to use - Python
 
@@ -88,12 +97,17 @@ viewer.
 
 All of the documentation is available directly as Jupyter Notebooks, for
 instance the current page you’re reading is available as a notebook
-[here](https://github.com/fastai/ghapi/blob/master/index.ipynb). To open
-any page as an interactive notebook in Google Colab, click the *Colab*
-badge at the top of the page.
+[here](https://github.com/AnswerDotAI/ghapi/blob/main/nbs/index.ipynb).
+To open any page as an interactive notebook in Google Colab, click the
+*Colab* badge at the top of the page.
 
 To access the GitHub API, first create a
-[`GhApi`](https://ghapi.fast.ai/core.html#ghapi) object:
+[`GhApi`](https://ghapi.fast.ai/core.html#ghapi) object. Note that as of
+v2, [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) is async: every
+endpoint call is `await`ed. In Jupyter and modern Python REPLs top-level
+`await` just works, as shown below; in scripts, wrap your code in a
+function run with
+[`asyncio.run`](https://docs.python.org/3/library/asyncio-runner.html#asyncio.run).
 
 ``` python
 from ghapi.all import GhApi
@@ -108,21 +122,32 @@ functionality provided by the API by displaying the object:
 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)
+- [agents](https://docs.github.com/rest/reference/agents)
 - [api_insights](https://docs.github.com/rest/reference/api-insights)
 - [apps](https://docs.github.com/rest/reference/apps)
 - [billing](https://docs.github.com/rest/reference/billing)
+- [campaigns](https://docs.github.com/rest/reference/campaigns)
 - [checks](https://docs.github.com/rest/reference/checks)
 - [classroom](https://docs.github.com/rest/reference/classroom)
+- [code_quality](https://docs.github.com/rest/reference/code-quality)
 - [code_scanning](https://docs.github.com/rest/reference/code-scanning)
 - [code_security](https://docs.github.com/rest/reference/code-security)
 - [codes_of_conduct](https://docs.github.com/rest/reference/codes-of-conduct)
 - [codespaces](https://docs.github.com/rest/reference/codespaces)
 - [copilot](https://docs.github.com/rest/reference/copilot)
+- [copilot_spaces](https://docs.github.com/rest/reference/copilot-spaces)
+- [credentials](https://docs.github.com/rest/reference/credentials)
 - [dependabot](https://docs.github.com/rest/reference/dependabot)
 - [dependency_graph](https://docs.github.com/rest/reference/dependency-graph)
 - [emojis](https://docs.github.com/rest/reference/emojis)
+- [enterprise_team_memberships](https://docs.github.com/rest/reference/enterprise-team-memberships)
+- [enterprise_team_organizations](https://docs.github.com/rest/reference/enterprise-team-organizations)
+- [enterprise_teams](https://docs.github.com/rest/reference/enterprise-teams)
 - [gists](https://docs.github.com/rest/reference/gists)
 - [git](https://docs.github.com/rest/reference/git)
 - [gitignore](https://docs.github.com/rest/reference/gitignore)
@@ -148,6 +173,8 @@ 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:
 
@@ -155,6 +182,8 @@ e.g. for the `git` group:
 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,
@@ -183,24 +212,41 @@ api.git
 - [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
 ```
 
-[git.get_ref](https://docs.github.com/rest/git/refs#get-a-reference)(owner,
-repo, ref): *Get a reference*
+<div class="prose" markdown="1">
+
+Get a reference
+
+Docs: https://docs.github.com/rest/git/refs#get-a-reference
+
+Parameters: - owner (str, required): The account owner of the
+repository. The name is not case sensitive. - 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:
 
 ``` python
-api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
+await api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
 ```
 
-``` json
+<div class="prose" markdown="1">
+
+``` python
 { 'node_id': 'MDM6UmVmMjI1NDYwNTk5OnJlZnMvaGVhZHMvbWFzdGVy',
   'object': { 'sha': 'c0608379fe60014534c8dffe2e381138e8160f53',
               'type': 'commit',
@@ -209,6 +255,8 @@ 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
@@ -243,10 +291,12 @@ api = GhApi(owner='fastai', repo='fastcore', token=github_token)
 We can now repeat the previous method, but only need to pass `ref`:
 
 ``` python
-api.git.get_ref('heads/master')
+await api.git.get_ref('heads/master')
 ```
 
-``` json
+<div class="prose" markdown="1">
+
+``` python
 { 'node_id': 'MDM6UmVmMjI1NDYwNTk5OnJlZnMvaGVhZHMvbWFzdGVy',
   'object': { 'sha': 'c0608379fe60014534c8dffe2e381138e8160f53',
               'type': 'commit',
@@ -255,17 +305,19 @@ 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
-issue = api.issues.create("Remember to check out GhApi!")
+issue = await api.issues.create("Remember to check out GhApi!")
 ```
 
 Since we’ve now checked out GhApi, let’s close this issue. 😎
 
 ``` python
-api.issues.update(issue.number, state='closed')
+await api.issues.update(issue.number, state='closed')
 ```
 
 ## How to use - command line

{ghapi-1.1.0 → ghapi-2.0.0}/README.md

@@ -3,6 +3,15 @@
 
 <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
 
+> **ghapi v2 (July 2026) is now async by default.** Every API call is
+> now awaited: `res = await api.repos.get()`. Top-level `await` works
+> directly in Jupyter and modern REPLs; in scripts, use
+> [`asyncio.run`](https://docs.python.org/3/library/asyncio-runner.html#asyncio.run).
+> For sync code (which should be largely compatible with v1), use
+> `GhApi(sync=True)`. See the [Sync
+> usage](https://ghapi.fast.ai/core.html#sync-usage) section of the docs
+> for details. To stay on the old version, pin `ghapi<2`.
+
 [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) provides 100%
 always-updated coverage of the entire [GitHub
 API](https://docs.github.com/rest). Because we automatically convert the
@@ -10,7 +19,8 @@ API](https://docs.github.com/rest). Because we automatically convert the
 spec](https://docs.github.com/rest/overview/openapi-description) to a
 Pythonic API, [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) is always
 up to date with the latest changes to GitHub APIs. Furthermore, because
-this is all done dynamically, the entire package is only 35kB in size!
+this is all built dynamically from a compact pre-parsed copy of the
+spec, the package stays small and is always up to date.
 
 Using [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi), you can automate
 nearly anything that you can do through the GitHub web interface or
@@ -39,8 +49,7 @@ or from the command line. An overview of each is provided below.
 
 ## Installation
 
-To install, run either `pip install ghapi` or
-`conda install -c fastai ghapi`.
+To install, run `pip install ghapi`.
 
 ## How to use - Python
 
@@ -60,12 +69,17 @@ viewer.
 
 All of the documentation is available directly as Jupyter Notebooks, for
 instance the current page you’re reading is available as a notebook
-[here](https://github.com/fastai/ghapi/blob/master/index.ipynb). To open
-any page as an interactive notebook in Google Colab, click the *Colab*
-badge at the top of the page.
+[here](https://github.com/AnswerDotAI/ghapi/blob/main/nbs/index.ipynb).
+To open any page as an interactive notebook in Google Colab, click the
+*Colab* badge at the top of the page.
 
 To access the GitHub API, first create a
-[`GhApi`](https://ghapi.fast.ai/core.html#ghapi) object:
+[`GhApi`](https://ghapi.fast.ai/core.html#ghapi) object. Note that as of
+v2, [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) is async: every
+endpoint call is `await`ed. In Jupyter and modern Python REPLs top-level
+`await` just works, as shown below; in scripts, wrap your code in a
+function run with
+[`asyncio.run`](https://docs.python.org/3/library/asyncio-runner.html#asyncio.run).
 
 ``` python
 from ghapi.all import GhApi
@@ -80,21 +94,32 @@ functionality provided by the API by displaying the object:
 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)
+- [agents](https://docs.github.com/rest/reference/agents)
 - [api_insights](https://docs.github.com/rest/reference/api-insights)
 - [apps](https://docs.github.com/rest/reference/apps)
 - [billing](https://docs.github.com/rest/reference/billing)
+- [campaigns](https://docs.github.com/rest/reference/campaigns)
 - [checks](https://docs.github.com/rest/reference/checks)
 - [classroom](https://docs.github.com/rest/reference/classroom)
+- [code_quality](https://docs.github.com/rest/reference/code-quality)
 - [code_scanning](https://docs.github.com/rest/reference/code-scanning)
 - [code_security](https://docs.github.com/rest/reference/code-security)
 - [codes_of_conduct](https://docs.github.com/rest/reference/codes-of-conduct)
 - [codespaces](https://docs.github.com/rest/reference/codespaces)
 - [copilot](https://docs.github.com/rest/reference/copilot)
+- [copilot_spaces](https://docs.github.com/rest/reference/copilot-spaces)
+- [credentials](https://docs.github.com/rest/reference/credentials)
 - [dependabot](https://docs.github.com/rest/reference/dependabot)
 - [dependency_graph](https://docs.github.com/rest/reference/dependency-graph)
 - [emojis](https://docs.github.com/rest/reference/emojis)
+- [enterprise_team_memberships](https://docs.github.com/rest/reference/enterprise-team-memberships)
+- [enterprise_team_organizations](https://docs.github.com/rest/reference/enterprise-team-organizations)
+- [enterprise_teams](https://docs.github.com/rest/reference/enterprise-teams)
 - [gists](https://docs.github.com/rest/reference/gists)
 - [git](https://docs.github.com/rest/reference/git)
 - [gitignore](https://docs.github.com/rest/reference/gitignore)
@@ -120,6 +145,8 @@ 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:
 
@@ -127,6 +154,8 @@ e.g. for the `git` group:
 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,
@@ -155,24 +184,41 @@ api.git
 - [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
 ```
 
-[git.get_ref](https://docs.github.com/rest/git/refs#get-a-reference)(owner,
-repo, ref): *Get a reference*
+<div class="prose" markdown="1">
+
+Get a reference
+
+Docs: https://docs.github.com/rest/git/refs#get-a-reference
+
+Parameters: - owner (str, required): The account owner of the
+repository. The name is not case sensitive. - 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:
 
 ``` python
-api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
+await api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
 ```
 
-``` json
+<div class="prose" markdown="1">
+
+``` python
 { 'node_id': 'MDM6UmVmMjI1NDYwNTk5OnJlZnMvaGVhZHMvbWFzdGVy',
   'object': { 'sha': 'c0608379fe60014534c8dffe2e381138e8160f53',
               'type': 'commit',
@@ -181,6 +227,8 @@ 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
@@ -215,10 +263,12 @@ api = GhApi(owner='fastai', repo='fastcore', token=github_token)
 We can now repeat the previous method, but only need to pass `ref`:
 
 ``` python
-api.git.get_ref('heads/master')
+await api.git.get_ref('heads/master')
 ```
 
-``` json
+<div class="prose" markdown="1">
+
+``` python
 { 'node_id': 'MDM6UmVmMjI1NDYwNTk5OnJlZnMvaGVhZHMvbWFzdGVy',
   'object': { 'sha': 'c0608379fe60014534c8dffe2e381138e8160f53',
               'type': 'commit',
@@ -227,17 +277,19 @@ 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
-issue = api.issues.create("Remember to check out GhApi!")
+issue = await api.issues.create("Remember to check out GhApi!")
 ```
 
 Since we’ve now checked out GhApi, let’s close this issue. 😎
 
 ``` python
-api.issues.update(issue.number, state='closed')
+await api.issues.update(issue.number, state='closed')
 ```
 
 ## How to use - command line

ghapi-2.0.0/ghapi/__init__.py

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

{ghapi-1.1.0 → ghapi-2.0.0}/ghapi/_modidx.py

@@ -32,9 +32,7 @@ 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._detls': ('build_lib.html#_detls', 'ghapi/build_lib.py'),
-                                 'ghapi.build_lib._find_data': ('build_lib.html#_find_data', 'ghapi/build_lib.py'),
-                                 'ghapi.build_lib.build_funcs': ('build_lib.html#build_funcs', 'ghapi/build_lib.py')},
+            'ghapi.build_lib': {'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'),
@@ -46,8 +44,6 @@ d = { 'settings': { 'branch': 'main',
                            'ghapi.cli.ghraw': ('cli.html#ghraw', 'ghapi/cli.py')},
             'ghapi.core': { 'ghapi.core.GhApi': ('core.html#ghapi', 'ghapi/core.py'),
                             'ghapi.core.GhApi.__call__': ('core.html#ghapi.__call__', 'ghapi/core.py'),
-                            'ghapi.core.GhApi.__dir__': ('core.html#ghapi.__dir__', 'ghapi/core.py'),
-                            'ghapi.core.GhApi.__getattr__': ('core.html#ghapi.__getattr__', 'ghapi/core.py'),
                             'ghapi.core.GhApi.__getitem__': ('core.html#ghapi.__getitem__', 'ghapi/core.py'),
                             'ghapi.core.GhApi.__init__': ('core.html#ghapi.__init__', 'ghapi/core.py'),
                             'ghapi.core.GhApi._get_repo_files': ('core.html#ghapi._get_repo_files', 'ghapi/core.py'),
@@ -58,53 +54,48 @@ d = { 'settings': { 'branch': 'main',
                             'ghapi.core.GhApi.create_gist': ('core.html#ghapi.create_gist', 'ghapi/core.py'),
                             'ghapi.core.GhApi.create_or_update_file': ('core.html#ghapi.create_or_update_file', 'ghapi/core.py'),
                             'ghapi.core.GhApi.create_release': ('core.html#ghapi.create_release', 'ghapi/core.py'),
+                            'ghapi.core.GhApi.debug': ('core.html#ghapi.debug', 'ghapi/core.py'),
                             'ghapi.core.GhApi.delete_branch': ('core.html#ghapi.delete_branch', 'ghapi/core.py'),
                             'ghapi.core.GhApi.delete_file': ('core.html#ghapi.delete_file', 'ghapi/core.py'),
                             'ghapi.core.GhApi.delete_release': ('core.html#ghapi.delete_release', 'ghapi/core.py'),
                             'ghapi.core.GhApi.delete_tag': ('core.html#ghapi.delete_tag', 'ghapi/core.py'),
                             'ghapi.core.GhApi.enable_pages': ('core.html#ghapi.enable_pages', 'ghapi/core.py'),
-                            'ghapi.core.GhApi.full_docs': ('core.html#ghapi.full_docs', 'ghapi/core.py'),
                             'ghapi.core.GhApi.get_branch': ('core.html#ghapi.get_branch', 'ghapi/core.py'),
                             'ghapi.core.GhApi.get_content': ('core.html#ghapi.get_content', 'ghapi/core.py'),
                             'ghapi.core.GhApi.get_file_content': ('core.html#ghapi.get_file_content', 'ghapi/core.py'),
                             'ghapi.core.GhApi.get_repo_contents': ('core.html#ghapi.get_repo_contents', 'ghapi/core.py'),
                             'ghapi.core.GhApi.get_repo_files': ('core.html#ghapi.get_repo_files', 'ghapi/core.py'),
                             'ghapi.core.GhApi.gist_file': ('core.html#ghapi.gist_file', 'ghapi/core.py'),
+                            'ghapi.core.GhApi.limit_rem': ('core.html#ghapi.limit_rem', 'ghapi/core.py'),
                             'ghapi.core.GhApi.list_branches': ('core.html#ghapi.list_branches', 'ghapi/core.py'),
                             'ghapi.core.GhApi.list_files': ('core.html#ghapi.list_files', 'ghapi/core.py'),
                             'ghapi.core.GhApi.list_tags': ('core.html#ghapi.list_tags', 'ghapi/core.py'),
                             'ghapi.core.GhApi.load_gist': ('core.html#ghapi.load_gist', 'ghapi/core.py'),
                             'ghapi.core.GhApi.pr_status': ('core.html#ghapi.pr_status', 'ghapi/core.py'),
                             'ghapi.core.GhApi.read_issue': ('core.html#ghapi.read_issue', 'ghapi/core.py'),
+                            'ghapi.core.GhApi.recv_hdrs': ('core.html#ghapi.recv_hdrs', 'ghapi/core.py'),
                             'ghapi.core.GhApi.update_contents': ('core.html#ghapi.update_contents', 'ghapi/core.py'),
                             'ghapi.core.GhApi.update_gist': ('core.html#ghapi.update_gist', 'ghapi/core.py'),
                             'ghapi.core.GhApi.upload_file': ('core.html#ghapi.upload_file', 'ghapi/core.py'),
+                            'ghapi.core.GhSyncTransport': ('core.html#ghsynctransport', 'ghapi/core.py'),
+                            'ghapi.core.GhSyncTransport.request': ('core.html#ghsynctransport.request', 'ghapi/core.py'),
+                            'ghapi.core.GhTransport': ('core.html#ghtransport', 'ghapi/core.py'),
+                            'ghapi.core.GhTransport.__init__': ('core.html#ghtransport.__init__', 'ghapi/core.py'),
+                            'ghapi.core.GhTransport._decode': ('core.html#ghtransport._decode', 'ghapi/core.py'),
+                            '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._CheckStatus': ('core.html#_checkstatus', 'ghapi/core.py'),
                             'ghapi.core._CheckStatus._repr_markdown_': ('core.html#_checkstatus._repr_markdown_', 'ghapi/core.py'),
-                            'ghapi.core._GhObj': ('core.html#_ghobj', 'ghapi/core.py'),
-                            'ghapi.core._GhVerb': ('core.html#_ghverb', 'ghapi/core.py'),
-                            'ghapi.core._GhVerb.__call__': ('core.html#_ghverb.__call__', 'ghapi/core.py'),
-                            'ghapi.core._GhVerb.__init__': ('core.html#_ghverb.__init__', 'ghapi/core.py'),
-                            'ghapi.core._GhVerb.__signature__': ('core.html#_ghverb.__signature__', 'ghapi/core.py'),
-                            'ghapi.core._GhVerb.__str__': ('core.html#_ghverb.__str__', 'ghapi/core.py'),
-                            'ghapi.core._GhVerb._repr_markdown_': ('core.html#_ghverb._repr_markdown_', 'ghapi/core.py'),
-                            'ghapi.core._GhVerb.doc_url': ('core.html#_ghverb.doc_url', 'ghapi/core.py'),
-                            'ghapi.core._GhVerbGroup': ('core.html#_ghverbgroup', 'ghapi/core.py'),
-                            'ghapi.core._GhVerbGroup.__init__': ('core.html#_ghverbgroup.__init__', 'ghapi/core.py'),
-                            'ghapi.core._GhVerbGroup.__str__': ('core.html#_ghverbgroup.__str__', 'ghapi/core.py'),
-                            'ghapi.core._GhVerbGroup._repr_markdown_': ('core.html#_ghverbgroup._repr_markdown_', 'ghapi/core.py'),
                             'ghapi.core._IssueInfo': ('core.html#_issueinfo', 'ghapi/core.py'),
                             'ghapi.core._IssueInfo._repr_markdown_': ('core.html#_issueinfo._repr_markdown_', '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'),
                             'ghapi.core._fmt_replies': ('core.html#_fmt_replies', 'ghapi/core.py'),
                             'ghapi.core._include': ('core.html#_include', 'ghapi/core.py'),
-                            'ghapi.core._mk_param': ('core.html#_mk_param', 'ghapi/core.py'),
-                            'ghapi.core._mk_sig': ('core.html#_mk_sig', 'ghapi/core.py'),
-                            'ghapi.core._mk_sig_detls': ('core.html#_mk_sig_detls', 'ghapi/core.py'),
-                            'ghapi.core._preview_hdr': ('core.html#_preview_hdr', '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.call_gh': ('core.html#call_gh', 'ghapi/core.py'),
                             'ghapi.core.date2gh': ('core.html#date2gh', 'ghapi/core.py'),
                             'ghapi.core.gh2date': ('core.html#gh2date', 'ghapi/core.py'),
                             'ghapi.core.print_summary': ('core.html#print_summary', 'ghapi/core.py'),
@@ -126,6 +117,7 @@ d = { 'settings': { 'branch': 'main',
                              'ghapi.event._want_evt': ('event.html#_want_evt', 'ghapi/event.py'),
                              '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.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'),
@@ -139,16 +131,16 @@ d = { 'settings': { 'branch': 'main',
                                '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.metadata': {},
             '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.page._Scanner.__init__': ('page.html#_scanner.__init__', 'ghapi/page.py'),
                             'ghapi.page._Scanner.scan': ('page.html#_scanner.scan', 'ghapi/page.py'),
-                            'ghapi.page._call_page': ('page.html#_call_page', 'ghapi/page.py'),
                             'ghapi.page._parse_link_hdr': ('page.html#_parse_link_hdr', 'ghapi/page.py'),
                             'ghapi.page.paged': ('page.html#paged', 'ghapi/page.py'),
                             'ghapi.page.pages': ('page.html#pages', 'ghapi/page.py'),
-                            'ghapi.page.parse_link_hdr': ('page.html#parse_link_hdr', 'ghapi/page.py')},
+                            'ghapi.page.parse_link_hdr': ('page.html#parse_link_hdr', 'ghapi/page.py'),
+                            'ghapi.page.sync_paged': ('page.html#sync_paged', 'ghapi/page.py'),
+                            'ghapi.page.sync_pages': ('page.html#sync_pages', 'ghapi/page.py')},
             'ghapi.skill': {},
             'ghapi.templates': {}}}

{ghapi-1.1.0 → ghapi-2.0.0}/ghapi/actions.py

@@ -74,7 +74,7 @@ def fill_workflow_templates(name:str, event, run, context, script, opersys='ubun
     "Function to create a simple Ubuntu workflow that calls a Python `ghapi` script"
     c = wf_tmpl
     if event=='workflow_dispatch:': event=''
-    needs = '    needs: [prebuild]' if prebuild else None
+    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)
@@ -153,11 +153,11 @@ def actions_mask(value):
     print(f"::add-mask::{value}")
 
 # %% ../nbs/01_actions.ipynb #8682ff46
-def set_git_user(api=None):
+async def set_git_user(api=None):
     "Set git user name/email to authenticated user (if `api`) or GitHub Actions bot (otherwise)"
     if api:
-        user  = api.users.get_authenticated().name
-        email = first(api.users.list_emails_for_authenticated(), attrgetter('primary')).email
+        user  = (await api.users.get_authenticated()).name
+        email = first(await api.users.list_emails_for_authenticated(), attrgetter('primary')).email
     else:
         user  = 'github-actions[bot]'
         email = 'github-actions[bot]@users.noreply.github.com'

ghapi-2.0.0/ghapi/build_lib.py

@@ -0,0 +1,20 @@
+"""Docs: https://ghapi.fast.ai/build_lib.html.md"""
+
+# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/90_build_lib.ipynb.
+
+# %% auto #0
+__all__ = ['GH_OPENAPI_URL', 'build_spec']
+
+# %% ../nbs/90_build_lib.ipynb #cdbcf258
+from fastcore.all import *
+from fastspec.spec import SpecParser
+
+import json
+
+# %% ../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' 
+
+# %% ../nbs/90_build_lib.ipynb #cf7204d9
+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)

{ghapi-1.1.0 → ghapi-2.0.0}/ghapi/cli.py

@@ -9,9 +9,10 @@ __all__ = ['ghapi', 'ghpath', 'ghraw', 'completion_ghapi']
 
 # %% ../nbs/10_cli.ipynb #e10a0628
 from fastcore.all import *
-import ghapi.core as gh,inspect
 from .core import *
-from collections import defaultdict
+from fastspec.oapi import OpFunc
+
+import asyncio
 
 # %% ../nbs/10_cli.ipynb #44ebb54f
 def _parse_args(a):
@@ -43,7 +44,7 @@ def _call_api(f):
     cmd,api,pos,kw = _api()
     if not pos: return print(f"Usage: `{cmd}` operation <params>")
     call = f(pos, api)
-    return call if kw.get('help', None) else call(*pos, **kw)
+    return call if kw.get('help', None) else asyncio.run(call(*pos, **kw))
 
 # %% ../nbs/10_cli.ipynb #55f9002f
 def _ghapi(arg, api):
@@ -54,8 +55,8 @@ def _ghapi(arg, api):
 def ghapi():
     "Python backend for the `ghapi` command, which calls an endpoint by operation name"
     res = _call_api(_ghapi)
-    if isinstance(res, (gh._GhObj,dict,L)): print(res)
-    elif res: print(inspect.signature(res))
+    if isinstance(res, OpFunc): print(repr(res))
+    elif res is not None: print(res)
 
 # %% ../nbs/10_cli.ipynb #524623ba
 def _ghpath(arg, api): return api[arg.pop(0),arg.pop(0)]
@@ -70,7 +71,7 @@ def ghraw():
     "Python backend for the `ghraw` command, which calls a fully-specified endpoint"
     cmd,api,pos,kw = _api()
     if not pos: return print(f"Usage: `{cmd}` operation <params>")
-    print(api(*pos, **kw))
+    print(asyncio.run(api(*pos, **kw)))
 
 # %% ../nbs/10_cli.ipynb #21033494
 _TAB_COMPLETION="""