# github3apps.py
This project is an extension to the [github3.py](https://github.com/sigmavirus24/github3.py) project, with the purpose of enabling [GitHub Application](https://developer.github.com/apps/) development.
Using this library developers can access all of the special App endpoints as well as pull out a `github3.py` client authenticated by a specific installation.
## Usage
### Connect to Github as Application
To connect you need to pass the app id and the location of your app's private key.
```python
from github3apps import GithubApp
gha = GithubApp(app_id, path_to_private_key)
gha.set_user_agent('MyApp')
gha.get_app()
```
### List Available Installations
This returns the list of installations IDs available to your application.
```python
from github3apps import GithubApp
gha = GithubApp(app_id, path_to_private_key)
installation_ids = gha.get_installations()
```
### Get Repositories Available to Installation
This returns the list of repositories available to your specific installation.
```python
from github3apps import GithubApp
gha = GithubApp(app_id, path_to_private_key)
installation = gha.get_installation(installation_id)
installation.get_repositories()
```
### Communicate with Github API as Installation
This returns a [github3.py](https://github.com/sigmavirus24/github3.py) client already authenticated against a specific installation.
```python
from github3apps import GithubApp
gha = GithubApp(app_id, path_to_private_key)
installation = gha.get_installation(installation_id)
gh = installation.get_github3_client()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/onediversified/div.lib.github3apps",
"name": "divlibgithub3apps",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "automation github apps git",
"author": "OneDiversified",
"author_email": "github@onediversified.com",
"download_url": "https://files.pythonhosted.org/packages/73/5d/70cd04a742813e8634f6e3da42593caee95c7488d488e665ea104a5e2371/divlibgithub3apps-1.0.8.tar.gz",
"platform": null,
"description": "# github3apps.py\n\nThis project is an extension to the [github3.py](https://github.com/sigmavirus24/github3.py) project, with the purpose of enabling [GitHub Application](https://developer.github.com/apps/) development.\n\nUsing this library developers can access all of the special App endpoints as well as pull out a `github3.py` client authenticated by a specific installation.\n\n\n## Usage\n\n### Connect to Github as Application\n\nTo connect you need to pass the app id and the location of your app's private key.\n\n```python\nfrom github3apps import GithubApp\n\ngha = GithubApp(app_id, path_to_private_key)\ngha.set_user_agent('MyApp')\ngha.get_app()\n```\n\n\n### List Available Installations\n\nThis returns the list of installations IDs available to your application.\n\n```python\nfrom github3apps import GithubApp\n\ngha = GithubApp(app_id, path_to_private_key)\ninstallation_ids = gha.get_installations()\n```\n\n\n### Get Repositories Available to Installation\n\nThis returns the list of repositories available to your specific installation.\n\n```python\nfrom github3apps import GithubApp\n\ngha = GithubApp(app_id, path_to_private_key)\n\ninstallation = gha.get_installation(installation_id)\ninstallation.get_repositories()\n```\n\n\n### Communicate with Github API as Installation\n\nThis returns a [github3.py](https://github.com/sigmavirus24/github3.py) client already authenticated against a specific installation.\n\n```python\nfrom github3apps import GithubApp\n\ngha = GithubApp(app_id, path_to_private_key)\ninstallation = gha.get_installation(installation_id)\ngh = installation.get_github3_client()\n```\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Access the Github API as an Application",
"version": "1.0.8",
"split_keywords": [
"automation",
"github",
"apps",
"git"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7bca8e7641e70b03794accd8d9f88bacfc9e059a03a1c8b32ec5720dabba0fde",
"md5": "0c67ba6cb642396589e7d705d37cc72b",
"sha256": "8b0366e5ce7b43c80326ff5200e2bf213c6a6a4699edd4ac1be4245356b9de6a"
},
"downloads": -1,
"filename": "divlibgithub3apps-1.0.8-py3.10.egg",
"has_sig": false,
"md5_digest": "0c67ba6cb642396589e7d705d37cc72b",
"packagetype": "bdist_egg",
"python_version": "1.0.8",
"requires_python": ">=3.10",
"size": 6811,
"upload_time": "2023-03-15T13:27:02",
"upload_time_iso_8601": "2023-03-15T13:27:02.519989Z",
"url": "https://files.pythonhosted.org/packages/7b/ca/8e7641e70b03794accd8d9f88bacfc9e059a03a1c8b32ec5720dabba0fde/divlibgithub3apps-1.0.8-py3.10.egg",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea1903ae1a2e4d5ab53a8fffefb67ef7bcb9f6e96fb182bb384e57d4c9a6dceb",
"md5": "bf22c98ad54491e2292f72d6235a0bd3",
"sha256": "a55c99daf0d96c95cdfee5b292c1bbb490de78348e987c55c43ade90cc3c820a"
},
"downloads": -1,
"filename": "divlibgithub3apps-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf22c98ad54491e2292f72d6235a0bd3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4768,
"upload_time": "2023-03-15T13:26:59",
"upload_time_iso_8601": "2023-03-15T13:26:59.925513Z",
"url": "https://files.pythonhosted.org/packages/ea/19/03ae1a2e4d5ab53a8fffefb67ef7bcb9f6e96fb182bb384e57d4c9a6dceb/divlibgithub3apps-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "735d70cd04a742813e8634f6e3da42593caee95c7488d488e665ea104a5e2371",
"md5": "1b630d4880ab4cf974dde872a9688088",
"sha256": "2e8d76c9de218c11f03e6dce01c80d2ff3bd5ba69a08acb96bd73222cc11e63c"
},
"downloads": -1,
"filename": "divlibgithub3apps-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "1b630d4880ab4cf974dde872a9688088",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4457,
"upload_time": "2023-03-15T13:27:04",
"upload_time_iso_8601": "2023-03-15T13:27:04.537516Z",
"url": "https://files.pythonhosted.org/packages/73/5d/70cd04a742813e8634f6e3da42593caee95c7488d488e665ea104a5e2371/divlibgithub3apps-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-15 13:27:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "onediversified",
"github_project": "div.lib.github3apps",
"lcname": "divlibgithub3apps"
}
JSON
