Description

# ghapi <!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! --> [`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 done dynamically, the entire package is only 35kB in size! 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. ## Installation To install, run either `pip install ghapi` or `conda install -c fastai ghapi`. ## How to use - Python Throughout this documentation, you will see code inputs and outputs shown in this format: ``` python 1+1 ``` 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/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. To access the GitHub API, first create a [`GhApi`](https://ghapi.fast.ai/core.html#ghapi) object: ``` 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: ``` python api ``` - [actions](https://docs.github.com/rest/reference/actions) - [activity](https://docs.github.com/rest/reference/activity) - [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) - [checks](https://docs.github.com/rest/reference/checks) - [classroom](https://docs.github.com/rest/reference/classroom) - [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) - [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) - [gists](https://docs.github.com/rest/reference/gists) - [git](https://docs.github.com/rest/reference/git) - [gitignore](https://docs.github.com/rest/reference/gitignore) - [hosted_compute](https://docs.github.com/rest/reference/hosted-compute) - [interactions](https://docs.github.com/rest/reference/interactions) - [issues](https://docs.github.com/rest/reference/issues) - [licenses](https://docs.github.com/rest/reference/licenses) - [markdown](https://docs.github.com/rest/reference/markdown) - [meta](https://docs.github.com/rest/reference/meta) - [migrations](https://docs.github.com/rest/reference/migrations) - [oidc](https://docs.github.com/rest/reference/oidc) - [orgs](https://docs.github.com/rest/reference/orgs) - [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) - [pulls](https://docs.github.com/rest/reference/pulls) - [rate_limit](https://docs.github.com/rest/reference/rate-limit) - [reactions](https://doc