Github objects
- class github.GithubObject.GithubObject
Base class for all classes representing objects returned by the API.
- property requester: Requester
Return my Requester object.
For example, to make requests to API endpoints not yet supported by PyGitHub.
- property raw_data: dict[str, Any]
- Type:
dict
- property raw_headers: dict[str, str | int]
- Type:
dict
- property etag: str | None
- Type:
str
- property last_modified: str | None
- Type:
str
- property last_modified_datetime: datetime | None
- Type:
datetime
- get__repr__(params: dict[str, Any]) str
Converts the object to a nicely printable string.
- AccessToken
- AdvisoryBase
- AdvisoryCredit
- AdvisoryCreditDetailed
- AdvisoryVulnerability
- AdvisoryVulnerabilityPackage
- ApplicationOAuth
- Artifact
- AuthenticatedUser
AuthenticatedUserAuthenticatedUser.add_to_emails()AuthenticatedUser.add_to_following()AuthenticatedUser.add_to_starred()AuthenticatedUser.add_to_subscriptions()AuthenticatedUser.add_to_watched()AuthenticatedUser.create_authorization()AuthenticatedUser.create_fork()AuthenticatedUser.create_repo_from_template()AuthenticatedUser.create_gist()AuthenticatedUser.create_key()AuthenticatedUser.create_project()AuthenticatedUser.create_repo()AuthenticatedUser.edit()AuthenticatedUser.get_authorization()AuthenticatedUser.get_authorizations()AuthenticatedUser.get_emails()AuthenticatedUser.get_events()AuthenticatedUser.get_followers()AuthenticatedUser.get_following()AuthenticatedUser.get_gists()AuthenticatedUser.get_issues()AuthenticatedUser.get_user_issues()AuthenticatedUser.get_key()AuthenticatedUser.get_keys()AuthenticatedUser.get_notification()AuthenticatedUser.get_notifications()AuthenticatedUser.get_organization_events()AuthenticatedUser.get_orgs()AuthenticatedUser.get_repo()AuthenticatedUser.get_repos()AuthenticatedUser.get_starred()AuthenticatedUser.get_starred_gists()AuthenticatedUser.get_subscriptions()AuthenticatedUser.get_teams()AuthenticatedUser.get_watched()AuthenticatedUser.get_installations()AuthenticatedUser.has_in_following()AuthenticatedUser.has_in_starred()AuthenticatedUser.has_in_subscriptions()AuthenticatedUser.has_in_watched()AuthenticatedUser.mark_notifications_as_read()AuthenticatedUser.remove_from_emails()AuthenticatedUser.remove_from_following()AuthenticatedUser.remove_from_starred()AuthenticatedUser.remove_from_subscriptions()AuthenticatedUser.remove_from_watched()AuthenticatedUser.accept_invitation()AuthenticatedUser.get_invitations()AuthenticatedUser.create_migration()AuthenticatedUser.get_migrations()AuthenticatedUser.get_organization_memberships()AuthenticatedUser.get_organization_membership()
- Authorization
- AuthorizationApplication
- Autolink
- Branch
BranchBranch.get_protection()Branch.edit_protection()Branch.remove_protection()Branch.get_required_status_checks()Branch.edit_required_status_checks()Branch.remove_required_status_checks()Branch.get_required_pull_request_reviews()Branch.edit_required_pull_request_reviews()Branch.remove_required_pull_request_reviews()Branch.get_admin_enforcement()Branch.set_admin_enforcement()Branch.remove_admin_enforcement()Branch.get_user_push_restrictions()Branch.get_team_push_restrictions()Branch.add_user_push_restrictions()Branch.replace_user_push_restrictions()Branch.remove_user_push_restrictions()Branch.add_team_push_restrictions()Branch.replace_team_push_restrictions()Branch.remove_team_push_restrictions()Branch.remove_push_restrictions()Branch.get_required_signatures()Branch.add_required_signatures()Branch.remove_required_signatures()Branch.get_allow_deletions()Branch.set_allow_deletions()Branch.remove_allow_deletions()
- BranchProtection
- BypassPullRequestAllowances
- CVSS
- CWE
- Check
- CheckRun
- CheckRunAnnotation
- CheckRunOutput
- CheckSuite
CheckSuiteCheckSuite.afterCheckSuite.appCheckSuite.beforeCheckSuite.check_runs_urlCheckSuite.conclusionCheckSuite.created_atCheckSuite.head_branchCheckSuite.head_commitCheckSuite.head_shaCheckSuite.idCheckSuite.latest_check_runs_countCheckSuite.pull_requestsCheckSuite.repositoryCheckSuite.statusCheckSuite.updated_atCheckSuite.urlCheckSuite.rerequest()CheckSuite.get_check_runs()
- Clones
- CodeScanAlert
- CodeScanAlertInstance
- CodeScanAlertInstanceLocation
- CodeScanRule
- CodeScanTool
- CodeSecurityConfig
- CodeSecurityConfigRepository
- Commit
- CommitCombinedStatus
- CommitComment
- CommitSearchResult
- CommitStats
- CommitStatus
- Comparison
- ContentFile
- ContentFileSearchResult
- Copilot
- CopilotSeat
- DefaultCodeSecurityConfig
- DependabotAlert
- DependabotAlertAdvisory
- DependabotAlertDependency
- DependabotAlertVulnerability
- Deployment
- DeploymentStatus
- DiscussionBase
- DiscussionCommentBase
- DismissalRestrictions
- Download
- Enterprise
- EnterpriseConsumedLicenses
- Environment
- EnvironmentDeploymentBranchPolicy
- EnvironmentProtectionRule
- EnvironmentProtectionRuleReviewer
- Event
- File
- GeneratedReleaseNotes
- Gist
- GistComment
- GistFile
- GistHistoryState
- GitAuthor
- GitBlob
- GitCommit
- GitCommitVerification
- GitObject
- GitRef
- GitRelease
- GitReleaseAsset
- GitTag
- GitTree
- GitTreeElement
- GithubApp
- GitignoreTemplate
- GlobalAdvisory
- Hook
- HookDelivery
- HookDeliveryRequest
- HookDeliveryResponse
- HookDeliverySummary
- HookDescription
- HookResponse
- Installation
- InstallationAuthorization
- Invitation
- Issue
IssueIssue.as_pull_request()Issue.add_to_assignees()Issue.add_to_labels()Issue.create_comment()Issue.delete_labels()Issue.edit()Issue.lock()Issue.unlock()Issue.get_comment()Issue.get_comments()Issue.get_events()Issue.get_labels()Issue.remove_from_assignees()Issue.remove_from_labels()Issue.set_labels()Issue.get_reactions()Issue.get_sub_issues()Issue.add_sub_issue()Issue.remove_sub_issue()Issue.prioritize_sub_issue()Issue.create_reaction()Issue.delete_reaction()Issue.get_timeline()
- IssueComment
- IssueDependenciesSummary
- IssueEvent
- IssuePullRequest
- IssueSearchResult
- IssueType
- Label
- License
- Membership
- MergedUpstream
- Migration
- Milestone
- NamedEnterpriseUser
- NamedUser
NamedUserNamedUser.get_events()NamedUser.get_followers()NamedUser.get_following()NamedUser.get_gists()NamedUser.get_keys()NamedUser.get_orgs()NamedUser.get_projects()NamedUser.get_public_events()NamedUser.get_public_received_events()NamedUser.get_received_events()NamedUser.get_repo()NamedUser.get_repos()NamedUser.get_starred()NamedUser.get_subscriptions()NamedUser.get_watched()NamedUser.has_in_following()NamedUser.get_organization_membership()
- NamedUserSearchResult
- Notification
- NotificationSubject
- Organization
OrganizationOrganization.add_to_members()Organization.add_to_public_members()Organization.create_fork()Organization.create_repo_from_template()Organization.create_hook()Organization.create_project()Organization.create_repo()Organization.create_secret()Organization.get_secrets()Organization.get_secret()Organization.create_team()Organization.create_variable()Organization.get_variables()Organization.get_variable()Organization.delete_hook()Organization.edit()Organization.edit_hook()Organization.get_events()Organization.get_hook()Organization.get_hooks()Organization.get_hook_delivery()Organization.get_hook_deliveries()Organization.get_issues()Organization.get_members()Organization.get_projects()Organization.get_public_members()Organization.get_outside_collaborators()Organization.remove_outside_collaborator()Organization.convert_to_outside_collaborator()Organization.get_public_key()Organization.get_copilot()Organization.get_repo()Organization.get_repos()Organization.get_team()Organization.get_team_by_slug()Organization.get_teams()Organization.invitations()Organization.invite_user()Organization.cancel_invitation()Organization.has_in_members()Organization.has_in_public_members()Organization.remove_from_membership()Organization.remove_from_members()Organization.remove_from_public_members()Organization.create_migration()Organization.get_migrations()Organization.get_installations()Organization.get_dependabot_alerts()Organization.get_codescan_alerts()Organization.get_secret_scanning_alerts()Organization.get_custom_properties()Organization.get_custom_property()Organization.create_custom_properties()Organization.create_custom_property()Organization.remove_custom_property()Organization.list_custom_property_values()Organization.create_custom_property_values()Organization.get_code_security_configs()Organization.create_code_security_config()Organization.edit_code_security_config()Organization.delete_code_security_config()Organization.get_code_security_config()Organization.set_default_code_security_config()Organization.get_default_code_security_configs()Organization.attach_security_config_to_repositories()Organization.detach_security_config_from_repositories()Organization.get_repos_for_code_security_config()Organization.get_self_hosted_runners()Organization.get_self_hosted_runner_applications()Organization.create_self_hosted_runner_jitconfig()Organization.create_self_hosted_runner_registration_token()Organization.create_self_hosted_runner_remove_token()Organization.get_self_hosted_runner()Organization.delete_self_hosted_runner()
- OrganizationCodeScanAlert
- OrganizationCustomProperty
- OrganizationDependabotAlert
- OrganizationInvitation
- OrganizationSecret
- OrganizationSecretScanAlert
- OrganizationVariable
- Path
- Permissions
- Plan
- Project
- ProjectCard
- ProjectColumn
- PublicKey
- PullRequest
PullRequestPullRequest.as_issue()PullRequest.create_comment()PullRequest.create_review_comment()PullRequest.create_review_comment_reply()PullRequest.create_issue_comment()PullRequest.create_review()PullRequest.create_review_request()PullRequest.delete_review_request()PullRequest.edit()PullRequest.get_comment()PullRequest.get_review_comment()PullRequest.get_comments()PullRequest.get_review_comments()PullRequest.get_single_review_comments()PullRequest.get_commits()PullRequest.get_files()PullRequest.get_issue_comment()PullRequest.get_issue_comments()PullRequest.get_issue_events()PullRequest.get_issue_timeline()PullRequest.get_review()PullRequest.get_reviews()PullRequest.get_review_requests()PullRequest.get_labels()PullRequest.add_to_labels()PullRequest.delete_labels()PullRequest.remove_from_labels()PullRequest.set_labels()PullRequest.is_merged()PullRequest.restore_branch()PullRequest.delete_branch()PullRequest.enable_automerge()PullRequest.disable_automerge()PullRequest.merge()PullRequest.add_to_assignees()PullRequest.remove_from_assignees()PullRequest.update_branch()PullRequest.convert_to_draft()PullRequest.mark_ready_for_review()
- PullRequestComment
- PullRequestMergeStatus
- PullRequestPart
- PullRequestReview
- Rate
- RateLimit
- RateLimitOverview
- Reaction
- Referrer
- RepoCodeSecurityConfig
- Repository
RepositoryRepository.allow_auto_mergeRepository.allow_forkingRepository.allow_merge_commitRepository.allow_rebase_mergeRepository.allow_squash_mergeRepository.allow_update_branchRepository.archive_urlRepository.archivedRepository.assignees_urlRepository.blobs_urlRepository.branches_urlRepository.clone_urlRepository.collaborators_urlRepository.comments_urlRepository.commits_urlRepository.compare_urlRepository.contents_urlRepository.contributors_urlRepository.created_atRepository.custom_propertiesRepository.default_branchRepository.delete_branch_on_mergeRepository.deployments_urlRepository.descriptionRepository.downloads_urlRepository.events_urlRepository.forkRepository.forksRepository.forks_countRepository.forks_urlRepository.full_nameRepository.git_commits_urlRepository.git_refs_urlRepository.git_tags_urlRepository.git_urlRepository.has_discussionsRepository.has_downloadsRepository.has_issuesRepository.has_pagesRepository.has_projectsRepository.has_wikiRepository.homepageRepository.hooks_urlRepository.html_urlRepository.idRepository.is_templateRepository.issue_comment_urlRepository.issue_events_urlRepository.issues_urlRepository.keys_urlRepository.labels_urlRepository.languageRepository.languages_urlRepository.merge_commit_messageRepository.merge_commit_titleRepository.merges_urlRepository.milestones_urlRepository.mirror_urlRepository.nameRepository.network_countRepository.notifications_urlRepository.open_issuesRepository.open_issues_countRepository.organizationRepository.ownerRepository.parentRepository.permissionsRepository.privateRepository.pulls_urlRepository.pushed_atRepository.releases_urlRepository.security_and_analysisRepository.sizeRepository.sourceRepository.squash_merge_commit_messageRepository.squash_merge_commit_titleRepository.ssh_urlRepository.stargazers_countRepository.stargazers_urlRepository.statuses_urlRepository.subscribers_countRepository.subscribers_urlRepository.subscription_urlRepository.svn_urlRepository.tags_urlRepository.teams_urlRepository.topicsRepository.trees_urlRepository.updated_atRepository.web_commit_signoff_requiredRepository.add_to_collaborators()Repository.get_collaborator_permission()Repository.get_collaborator_role_name()Repository.get_pending_invitations()Repository.remove_invitation()Repository.compare()Repository.create_autolink()Repository.create_git_blob()Repository.create_git_commit()Repository.create_git_ref()Repository.create_git_tag_and_release()Repository.create_git_release()Repository.generate_release_notes()Repository.create_git_tag()Repository.create_git_tree()Repository.create_hook()Repository.create_issue()Repository.create_key()Repository.create_label()Repository.create_milestone()Repository.create_project()Repository.create_pull()Repository.create_repository_advisory()Repository.report_security_vulnerability()Repository.create_repository_dispatch()Repository.create_secret()Repository.get_secrets()Repository.get_secret()Repository.create_variable()Repository.get_variables()Repository.get_variable()Repository.delete_secret()Repository.delete_variable()Repository.create_source_import()Repository.delete()Repository.edit()Repository.get_archive_link()Repository.get_assignees()Repository.get_branch()Repository.rename_branch()Repository.get_branches()Repository.get_collaborators()Repository.get_comment()Repository.get_comments()Repository.get_commit()Repository.get_commits()Repository.get_contents()Repository.get_deployments()Repository.get_deployment()Repository.create_deployment()Repository.get_top_referrers()Repository.get_top_paths()Repository.get_views_traffic()Repository.get_clones_traffic()Repository.get_projects()Repository.get_autolinks()Repository.create_file()Repository.get_repository_advisories()Repository.get_repository_advisory()Repository.update_file()Repository.delete_file()Repository.get_dir_contents()Repository.get_contributors()Repository.get_download()Repository.get_downloads()Repository.get_events()Repository.get_forks()Repository.create_fork()Repository.get_git_blob()Repository.get_git_commit()Repository.get_git_ref()Repository.get_git_refs()Repository.get_git_matching_refs()Repository.get_git_tag()Repository.get_git_tree()Repository.get_hook()Repository.get_hooks()Repository.get_hook_delivery()Repository.get_hook_deliveries()Repository.get_issue()Repository.get_issues()Repository.get_issues_comments()Repository.get_issues_event()Repository.get_issues_events()Repository.get_key()Repository.get_keys()Repository.get_label()Repository.get_labels()Repository.get_languages()Repository.get_license()Repository.get_milestone()Repository.get_milestones()Repository.get_network_events()Repository.get_public_key()Repository.get_pull()Repository.get_pulls()Repository.get_pulls_comments()Repository.get_pulls_review_comments()Repository.get_readme()Repository.get_self_hosted_runner()Repository.get_self_hosted_runners()Repository.get_source_import()Repository.get_stargazers()Repository.get_stargazers_with_dates()Repository.get_stats_contributors()Repository.get_stats_commit_activity()Repository.get_stats_code_frequency()Repository.get_stats_participation()Repository.get_stats_punch_card()Repository.get_subscribers()Repository.get_tags()Repository.get_releases()Repository.get_release()Repository.get_latest_release()Repository.get_teams()Repository.get_topics()Repository.get_watchers()Repository.get_workflows()Repository.get_workflow()Repository.get_workflow_runs()Repository.get_workflow_run()Repository.has_in_assignees()Repository.has_in_collaborators()Repository.legacy_search_issues()Repository.get_notifications()Repository.mark_notifications_as_read()Repository.merge()Repository.merge_upstream()Repository.replace_topics()Repository.get_vulnerability_alert()Repository.enable_vulnerability_alert()Repository.disable_vulnerability_alert()Repository.get_automated_security_fixes()Repository.enable_automated_security_fixes()Repository.disable_automated_security_fixes()Repository.remove_from_collaborators()Repository.remove_self_hosted_runner()Repository.remove_autolink()Repository.subscribe_to_hub()Repository.unsubscribe_from_hub()Repository.create_check_suite()Repository.get_check_suite()Repository.update_check_suites_preferences()Repository.create_check_run()Repository.get_check_run()Repository.get_artifacts()Repository.get_artifact()Repository.get_codescan_alerts()Repository.get_codescan_alert()Repository.get_secret_scanning_alerts()Repository.get_secret_scanning_alert()Repository.get_environments()Repository.get_environment()Repository.create_environment()Repository.delete_environment()Repository.get_dependabot_alerts()Repository.get_dependabot_alert()Repository.update_dependabot_alert()Repository.get_custom_properties()Repository.update_custom_properties()Repository.attach_security_config()Repository.detach_security_config()Repository.get_security_config()Repository.transfer_ownership()
- RepositoryAdvisory
RepositoryAdvisoryRepositoryAdvisory.add_vulnerability()RepositoryAdvisory.add_vulnerabilities()RepositoryAdvisory.offer_credit()RepositoryAdvisory.offer_credits()RepositoryAdvisory.revoke_credit()RepositoryAdvisory.clear_credits()RepositoryAdvisory.edit()RepositoryAdvisory.accept_report()RepositoryAdvisory.publish()RepositoryAdvisory.request_cve()RepositoryAdvisory.close()
- RepositoryCustomPropertyValues
- RepositoryDiscussion
- RepositoryDiscussionCategory
- RepositoryDiscussionComment
- RepositoryKey
- RepositoryPreferences
- RepositorySearchResult
- RequiredPullRequestReviews
- RequiredStatusChecks
- Secret
- SecretScanAlert
- SecretScanAlertInstance
- SecurityAndAnalysis
- SecurityAndAnalysisFeature
- SelfHostedActionsRunner
- SelfHostedActionsRunnerApplication
- SelfHostedActionsRunnerJitConfig
- SelfHostedActionsRunnerToken
- SourceImport
- Stargazer
- StatsCodeFrequency
- StatsCommitActivity
- StatsContributor
- StatsParticipation
- StatsPunchCard
- SubIssue
- SubIssueSummary
- Tag
- Team
TeamTeam.add_to_members()Team.add_membership()Team.get_team_membership()Team.add_to_repos()Team.get_repo_permission()Team.set_repo_permission()Team.update_team_repository()Team.delete()Team.edit()Team.get_teams()Team.get_discussions()Team.get_members()Team.get_repos()Team.invitations()Team.has_in_members()Team.has_in_repos()Team.remove_membership()Team.remove_from_members()Team.remove_from_repos()
- TeamDiscussion
- TimelineEvent
- TimelineEventSource
- Topic
- Traffic
- UserKey
- Variable
- View
- Workflow
- WorkflowJob
- WorkflowRun
- WorkflowStep