ghapi 2.0.0__tar.gz → 2.0.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghapi
-Version: 2.0.0
+Version: 2.0.2
 Summary: A python client for the GitHub API
 Author-email: Jeremy Howard <info@fast.ai>
 License: Apache-2.0
@@ -15,14 +15,15 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastcore>=1.14.3
+Requires-Dist: fastcore>=1.14.5
 Requires-Dist: fastspec>=0.1.0
 Provides-Extra: dev
 Requires-Dist: fastgit; extra == "dev"
 Requires-Dist: matplotlib; extra == "dev"
 Requires-Dist: nbclassic; extra == "dev"
 Requires-Dist: nbdev; extra == "dev"
-Requires-Dist: pysymbol_llm; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
+Requires-Dist: pysym2md>=0.0.6; extra == "dev"
 Requires-Dist: llms-txt>=0.0.6; extra == "dev"
 Dynamic: license-file
 
@@ -31,49 +32,20 @@ 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
-[OpenAPI
-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 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
-through the `git` client, such as:
-
-- Open, list, comment on, or modify
-  [issues](https://guides.github.com/features/issues/) or [pull
-  requests](https://docs.github.com/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
-- Create, list, or modify [git
-  tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) or [GitHub
-  releases](https://docs.github.com/github/administering-a-repository/managing-releases-in-a-repository),
-  including uploading release assets
-- Configure and run GitHub
-  [Actions](https://github.com/features/actions) and
-  [webhooks](https://docs.github.com/developers/webhooks-and-events/about-webhooks)
-- Set up GitHub [users](https://docs.github.com/rest/reference/users)
-  and
-  [organizations](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-organizations)
-- Manage your
-  [deployments](https://docs.github.com/rest/guides/delivering-deployments)
+> **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 [OpenAPI 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 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 through the `git` client, such as:
+
+- Open, list, comment on, or modify [issues](https://guides.github.com/features/issues/) or [pull requests](https://docs.github.com/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
+- Create, list, or modify [git tags](https://git-scm.com/book/en/v2/Git-Basics-Tagging) or [GitHub releases](https://docs.github.com/github/administering-a-repository/managing-releases-in-a-repository), including uploading release assets
+- Configure and run GitHub [Actions](https://github.com/features/actions) and [webhooks](https://docs.github.com/developers/webhooks-and-events/about-webhooks)
+- Set up GitHub [users](https://docs.github.com/rest/reference/users) and [organizations](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-organizations)
+- Manage your [deployments](https://docs.github.com/rest/guides/delivering-deployments)
 - …and much, much more.
 
-There are two ways to use
-[`ghapi`](https://ghapi.fast.ai/cli.html#ghapi): either through Python,
-or from the command line. An overview of each is provided below.
+There are two ways to use [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi): either through Python, or from the command line. An overview of each is provided below.
 
 ## Installation
 
@@ -81,8 +53,7 @@ To install, run `pip install ghapi`.
 
 ## How to use - Python
 
-Throughout this documentation, you will see code inputs and outputs
-shown in this format:
+Throughout this documentation, you will see code inputs and outputs shown in this format:
 
 ``` python
 1+1
@@ -90,33 +61,18 @@ shown in this format:
 
     2
 
-We recommend reading the documentation on the [official
-site](https://ghapi.fast.ai/), rather than on GitHub, since not all the
-functionality described on this page is available through the GitHub
-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/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. 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).
+We recommend reading the documentation on the [official site](https://ghapi.fast.ai/), rather than on GitHub, since not all the functionality described on this page is available through the GitHub 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/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. 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
 api = GhApi()
 ```
 
-Every part of the API includes documentation directly in the `api`
-object itself. For instance, here’s how to explore the groups of
-functionality provided by the API by displaying the object:
+Every part of the API includes documentation directly in the `api` object itself. For instance, here’s how to explore the groups of functionality provided by the API by displaying the object:
 
 ``` python
 api
@@ -175,8 +131,7 @@ api
 
 </div>
 
-Then we can explore the endpoints provided by the API in each group,
-e.g. for the `git` group:
+Then we can explore the endpoints provided by the API in each group, e.g. for the `git` group:
 
 ``` python
 api.git
@@ -184,33 +139,19 @@ 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*
-- [git.get_commit](https://docs.github.com/rest/git/commits#get-a-commit-object)(owner,
-  repo, commit_sha): *Get a commit object*
-- [git.list_matching_refs](https://docs.github.com/rest/git/refs#list-matching-references)(owner,
-  repo, ref): *List matching references*
-- [git.get_ref](https://docs.github.com/rest/git/refs#get-a-reference)(owner,
-  repo, ref): *Get a reference*
-- [git.create_ref](https://docs.github.com/rest/git/refs#create-a-reference)(owner,
-  repo, ref, sha): *Create a reference*
-- [git.update_ref](https://docs.github.com/rest/git/refs#update-a-reference)(owner,
-  repo, ref, sha, force): *Update a reference*
-- [git.delete_ref](https://docs.github.com/rest/git/refs#delete-a-reference)(owner,
-  repo, ref): *Delete a reference*
-- [git.create_tag](https://docs.github.com/rest/git/tags#create-a-tag-object)(owner,
-  repo, tag, message, object, type, tagger): *Create a tag object*
-- [git.get_tag](https://docs.github.com/rest/git/tags#get-a-tag)(owner,
-  repo, tag_sha): *Get a tag*
-- [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*
+- [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*
+- [git.get_commit](https://docs.github.com/rest/git/commits#get-a-commit-object)(owner, repo, commit_sha): *Get a commit object*
+- [git.list_matching_refs](https://docs.github.com/rest/git/refs#list-matching-references)(owner, repo, ref): *List matching references*
+- [git.get_ref](https://docs.github.com/rest/git/refs#get-a-reference)(owner, repo, ref): *Get a reference*
+- [git.create_ref](https://docs.github.com/rest/git/refs#create-a-reference)(owner, repo, ref, sha): *Create a reference*
+- [git.update_ref](https://docs.github.com/rest/git/refs#update-a-reference)(owner, repo, ref, sha, force): *Update a reference*
+- [git.delete_ref](https://docs.github.com/rest/git/refs#delete-a-reference)(owner, repo, ref): *Delete a reference*
+- [git.create_tag](https://docs.github.com/rest/git/tags#create-a-tag-object)(owner, repo, tag, message, object, type, tagger): *Create a tag object*
+- [git.get_tag](https://docs.github.com/rest/git/tags#get-a-tag)(owner, repo, tag_sha): *Get a tag*
+- [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>
 
@@ -226,19 +167,14 @@ 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.
+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:
+In Jupyter Notebook full tab completion, parameter lists, etc are provided for all endpoints. Endpoints are called as standard Python methods:
 
 ``` python
 await api.git.get_ref(owner='fastai', repo='fastcore', ref='heads/master')
@@ -257,32 +193,15 @@ await api.git.get_ref(owner='fastai', repo='fastcore', ref='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 [`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:
 
     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\].
+…replacing the `xxx` with the token you just copied. (Don’t forget to `source` that file after you change it.), pass a \[GitHub token\].
 
-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 your `token`, you can also 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)
@@ -307,8 +226,7 @@ await api.git.get_ref('heads/master')
 
 </div>
 
-Now that we’ve provided our token, we can use authenticated endpoints
-such as creating an issue:
+Now that we’ve provided our token, we can use authenticated endpoints such as creating an issue:
 
 ``` python
 issue = await api.issues.create("Remember to check out GhApi!")
@@ -322,52 +240,29 @@ await api.issues.update(issue.number, state='closed')
 
 ## 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.
+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.
 
-We strongly recommend enabling tab completion for
-[`ghapi`](https://ghapi.fast.ai/cli.html#ghapi), which you can do by
-placing the following command at the end of your `~/.bashrc` or
-`~/.zshrc` file:
+We strongly recommend enabling tab completion for [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi), which you can do by placing the following command at the end of your `~/.bashrc` or `~/.zshrc` file:
 
 ``` bash
 eval "$(completion-ghapi --install)"
 ```
 
-To get started with the [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi)
-command, first find the name of the operation you wish to perform, for
-instance by searching the [full API
-reference](https://ghapi.fast.ai/fullapi.html).
+To get started with the [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi) command, first find the name of the operation you wish to perform, for instance by searching the [full API reference](https://ghapi.fast.ai/fullapi.html).
 
-To use [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi), pass the method
-name (exactly the same as you’d use in the Python API) as the first
-parameter, followed by any positional parameters required, and then
-keyword arguments with “`--`” before each parameter name.
+To use [`ghapi`](https://ghapi.fast.ai/cli.html#ghapi), pass the method name (exactly the same as you’d use in the Python API) as the first parameter, followed by any positional parameters required, and then keyword arguments with “`--`” before each parameter name.
 
-For instance, [git.get_ref](https://ghapi.fast.ai/fullapi.html#git)
-takes three parameters: `owner`, `repo`, and `ref`. If we wish to pass
-the first two as positional parameters, and the last as a named
-argument, then we’d call:
+For instance, [git.get_ref](https://ghapi.fast.ai/fullapi.html#git) takes three parameters: `owner`, `repo`, and `ref`. If we wish to pass the first two as positional parameters, and the last as a named argument, then we’d call:
 
 ``` bash
 ghapi git.get_ref fastai ghapi-test --ref heads/master
 ```
 
-If you have enabled tab completion, then after you’ve typed `ghapi g`
-try pressing <kbd>Tab</kbd>, and you’ll see all the operation groups
-available in the GitHub API that start with `g`. If you keep typing,
-e.g. `ghapi git.`, and hit <kbd>Tab</kbd> again, you’ll now see all the
-operations available in the `git` group, i.e:
+If you have enabled tab completion, then after you’ve typed `ghapi g` try pressing <kbd>Tab</kbd>, and you’ll see all the operation groups available in the GitHub API that start with `g`. If you keep typing, e.g. `ghapi git.`, and hit <kbd>Tab</kbd> again, you’ll now see all the operations available in the `git` group, i.e:
 
     git.create_blob git.create_commit git.create_ref git.create_tag git.create_tree git.delete_ref git.get_blob git.get_commit git.get_ref git.get_tag git.get_tree git.list_matching_refs git.name git.update_ref git.verbs
 
-If you pass just `--help` after the operation name, you’ll see a full
-list of all parameters accepted, and a link to the official GitHub
-documentation.
+If you pass just `--help` after the operation name, you’ll see a full list of all parameters accepted, and a link to the official GitHub documentation.
 
 ``` bash
 ghapi git.get_ref --help
@@ -375,8 +270,7 @@ ghapi git.get_ref --help
 >>> https://docs.github.com/rest/reference/git#get-a-reference
 ```
 
-In addition to `--help` and the GitHub operation parameters, you can
-also pass the following:
+In addition to `--help` and the GitHub operation parameters, you can also pass the following:
 
 - `--headers`: A list of extra headers to pass, JSON-encoded
 - `--token`: A GitHub authentation token