Skip to content
master
Switch branches/tags
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Feb 21, 2018
Feb 21, 2018
Jan 18, 2019
Feb 10, 2021

README.md

github3apps.py

This project is an extension to the github3.py project, with the purpose of enabling GitHub Application 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.

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.

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.

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 client already authenticated against a specific installation.

from github3apps import GithubApp

gha = GithubApp(app_id, path_to_private_key)
installation = gha.get_installation(installation_id)
gh = installation.get_github3_client()