PyGithub/ReferenceOfClasses.md

You don't normaly create instances of any class but Github. You obtain instances through calls to get_ and create_ methods.

In this documentation:

• login is a string containing a user's or organization's login
• user is an instance of AuthenticatedUser or NamedUser
• name is a string containing the name of a repository
• repo is an instance of Repository

Class Github

• Constructed from user's login and password
• get_user(): AuthenticatedUser
• get_user( login ): NamedUser
• get_organization( login ): Organization

Class AuthenticatedUser

• Attributes: see API
• edit( ... ): see API for parameters

Emails

• get_emails(): list of strings
• add_to_emails( email, ... ) *
• remove_from_emails( email, ... ) *

Followers

• get_followers() : list of NamedUser

Following

• get_following() : list of NamedUser
• add_to_following( user ) *
• remove_from_following( user ) *
• has_in_following( user ): bool *

Orgs

• get_orgs() : list of Organization

Repos

• get_repos(): list of Repository: see API for type parameter
• get_repo( name ): Repository
• create_repo( ... ): Repository: see API for parameters
• create_fork( repo ): Repository

Watched

• get_watched(): list of Repository
• add_to_watched( repo ) *
• remove_from_watched( repo ) *
• has_in_watched( repo ): bool *

Class Branch

• Attributes: see API

Class Commit

• Attributes: see API

Comments

• get_comments(): list of CommitComment
• create_comment( ... ): CommitComment: see API for parameters

Class CommitComment

• Attributes: see API
• edit( ... ): see API for parameters
• delete()

Class Download

• Attributes: see API
• delete()

Class GitBlob

• Attributes: see API

Class GitCommit

• Attributes: see API

Class GitRef

• Attributes: see API
• edit( ... ): see API for parameters

Class GitTag

• Attributes: see API

Class GitTree

• Attributes: see API

Class Issue

• Attributes: see API
• edit( ... ): see API for parameters

Labels

• get_labels(): list of Label
• add_to_labels( label, ... ) *
• set_labels( label, ... ) *
• delete_labels()
• remove_from_labels( label ) *

Comments

• get_comments(): list of IssueComment
• get_comment( id ): IssueComment
• create_comment( ... ): IssueComment: see API for parameters

Class IssueComment

• Attributes: see API
• edit( ... ): see API for parameters
• delete()

Class Label

• Attributes: see API
• edit( ... ): see API for parameters
• delete()

Class Milestone

• Attributes: see API
• edit( ... ): see API for parameters
• delete()
• get_labels(): list of Label

Class NamedUser

• Attributes: see API

Followers

• get_followers() : list of NamedUser

Following

• get_following() : list of NamedUser

Orgs

• get_orgs() : list of Organization

Repos

• get_repos(): list of Repository: see API for type parameter
• get_repo( name ): Repository

Watched

• get_watched(): list of Repository

Class Organization

• Attributes: see API
• edit( ... ): see API for parameters

Public members

• get_public_members(): list of NamedUser
• add_to_public_members( user ) *
• remove_from_public_members( user ) *
• has_in_public_members( user ): bool *

Members

• get_members(): list of NamedUser
• remove_from_members( user ) *
• has_in_members( user ): bool *

Repos

• get_repos(): list of Repository: see API for type parameter
• get_repo( name ): Repository
• create_repo( ... ): Repository: see API for parameters
• create_fork( repo ): Repository

Teams

• get_teams(): list of Team
• create_team( ... ): Team: see API for parameters

Class Repository

• Attributes: see API
• edit( ... ): see API for parameters
• get_languages(): dictionary of strings to integers

Collaborators

• get_collaborators(): list of NamedUser
• add_to_collaborators( user ) *
• remove_from_collaborators( user ) *
• has_in_collaborators( user ): bool *

Contributors

• get_contributors(): list of NamedUser

Watchers

• get_watchers(): list of NamedUser

Git refs

• get_git_refs(): list of GitRef
• get_git_ref( ref ): GitRef
• create_git_ref( ... ): GitRef: see API for parameters

Git commits

• get_git_commit( sha ): GitCommit
• create_git_commit( ... ): GitCommit: see API for parameters

Git trees

• get_git_tree( sha ): GitTree
• create_git_tree( ... ): GitTree: see API for parameters

Git blobs

• get_git_blob( sha ): GitBlob
• create_git_blob( ... ): GitBlob: see API for parameters

Git tags

• get_git_tag( sha ): GitTag
• create_git_tag( ... ): GitTag: see API for parameters

Labels

• get_labels(): list of Label
• create_label( ... ): Label: see API for parameters
• get_label( id ): Label

Milestones

• get_milestones( ... ): list of Milestone: see API for parameters
• create_milestone( ... ): Milestone: see API for parameters
• get_milestone( number ): Milestone

Issues

• get_issues( ... ): list of Issue: see API for parameters
• create_issue( ... ): Issue: see API for parameters
• get_issue( id ): Issue

Downloads

Repository.get_downloads() list of Download Repository.create_download( ... ): Download: see API Repository.get_download( id ): Download

Comments

• get_comments(): list of CommitComment
• get_comment( id ): CommitComment

Commits

• get_commits( ... ): list of Commit: see API for parameters
• get_commit( sha ): Commit

Tags

• get_tags(): list of Tag

Branches

• get_branches(): list of Branch

Forks

• get_forks(): list of Repository

Teams

• get_teams(): list of Team

Class Tag

• Attributes: see API

Class Team

• Attributes: see API
• edit( ... ): see API for parameters
• delete()

Members

• get_members(): list of NamedUser
• add_to_members( user ) *
• remove_from_members( user ) *
• has_in_members( user ): bool *

Repos

• get_repos(): list of Repository
• add_to_repos( repo ) *
• remove_from_repos( repo ) *
• has_in_repos( repo ): bool *