Organization¶

class github.Organization.Organization¶

This class represents Organizations. The reference can be found here https://docs.github.com/en/rest/reference/orgs

add_to_members(member: NamedUser, role: Opt[str] = NotSet) → None¶

Calls: PUT /orgs/{org}/memberships/{user}

add_to_public_members(public_member: NamedUser) → None¶

Calls: PUT /orgs/{org}/public_members/{user}

create_fork(repo: Repository, name: Opt[str] = NotSet, default_branch_only: Opt[bool] = NotSet) → Repository¶

Calls: POST /repos/{owner}/{repo}/forks

create_repo_from_template(name: str, repo: Repository, description: Opt[str] = NotSet, private: Opt[bool] = NotSet) → Repository¶: self.name :calls: POST /repos/{template_owner}/{template_repo}/generate

create_hook(name: str, config: dict[str, str], events: Opt[list[str]] = NotSet, active: Opt[bool] = NotSet) → Hook¶

Calls

POST /orgs/{owner}/hooks

Parameters

name – string
config – dict
events – list of string
active – bool

Return type

github.Hook.Hook

create_project(name: str, body: Union[str, github.GithubObject._NotSetType] = NotSet) → github.Project.Project¶

Calls: POST /orgs/{org}/projects

create_repo(name: str, description: Union[str, github.GithubObject._NotSetType] = NotSet, homepage: Union[str, github.GithubObject._NotSetType] = NotSet, private: Union[bool, github.GithubObject._NotSetType] = NotSet, visibility: Union[str, github.GithubObject._NotSetType] = NotSet, has_issues: Union[bool, github.GithubObject._NotSetType] = NotSet, has_wiki: Union[bool, github.GithubObject._NotSetType] = NotSet, has_downloads: Union[bool, github.GithubObject._NotSetType] = NotSet, has_projects: Union[bool, github.GithubObject._NotSetType] = NotSet, team_id: Union[int, github.GithubObject._NotSetType] = NotSet, auto_init: Union[bool, github.GithubObject._NotSetType] = NotSet, license_template: Union[str, github.GithubObject._NotSetType] = NotSet, gitignore_template: Union[str, github.GithubObject._NotSetType] = NotSet, allow_squash_merge: Union[bool, github.GithubObject._NotSetType] = NotSet, allow_merge_commit: Union[bool, github.GithubObject._NotSetType] = NotSet, allow_rebase_merge: Union[bool, github.GithubObject._NotSetType] = NotSet, delete_branch_on_merge: Union[bool, github.GithubObject._NotSetType] = NotSet, allow_update_branch: Union[bool, github.GithubObject._NotSetType] = NotSet) → github.Repository.Repository¶

Calls: POST /orgs/{org}/repos

create_secret(secret_name: str, unencrypted_value: str, visibility: str = 'all', selected_repositories: Opt[list[github.Repository.Repository]] = NotSet) → github.OrganizationSecret.OrganizationSecret¶

Calls: PUT /orgs/{org}/actions/secrets/{secret_name}

get_secrets() → PaginatedList[OrganizationSecret]¶: Gets all organization secrets :rtype: PaginatedList of github.OrganizationSecret.OrganizationSecret

get_secret(secret_name: str) → OrganizationSecret¶

Calls: ‘GET /orgs/{org}/actions/secrets/{secret_name} <https://docs.github.com/en/rest/actions/secrets#get-an-organization-secret>`_
Parameters: secret_name – string
Return type: github.OrganizationSecret.OrganizationSecret

create_team(name: str, repo_names: Opt[list[Repository]] = NotSet, permission: Opt[str] = NotSet, privacy: Opt[str] = NotSet, description: Opt[str] = NotSet) → Team¶

Calls

POST /orgs/{org}/teams

Parameters

name – string
repo_names – list of github.Repository.Repository
permission – string
privacy – string
description – string

Return type

github.Team.Team

create_variable(variable_name: str, value: str, visibility: str = 'all', selected_repositories: github.GithubObject.Opt[list[github.Repository.Repository]] = NotSet) → github.OrganizationVariable.OrganizationVariable¶

Calls

POST /orgs/{org}/actions/variables/

Parameters

variable_name – string
value – string
visibility – string
selected_repositories – list of github.Repository.Repository

Return type

github.OrganizationVariable.OrganizationVariable

get_variables() → PaginatedList[OrganizationVariable]¶: Gets all organization variables :rtype: PaginatedList of github.OrganizationVariable.OrganizationVariable

get_variable(variable_name: str) → OrganizationVariable¶

Calls: ‘GET /orgs/{org}/actions/variables/{variable_name} <https://docs.github.com/en/rest/actions/variables#get-an-organization-variable>`_
Parameters: variable_name – string
Return type: github.OrganizationVariable.OrganizationVariable

delete_hook(id: int) → None¶

Calls: DELETE /orgs/{owner}/hooks/{id}
Parameters: id – integer
Return type: None`

edit(billing_email: Union[str, github.GithubObject._NotSetType] = NotSet, blog: Union[str, github.GithubObject._NotSetType] = NotSet, company: Union[str, github.GithubObject._NotSetType] = NotSet, description: Union[str, github.GithubObject._NotSetType] = NotSet, email: Union[str, github.GithubObject._NotSetType] = NotSet, location: Union[str, github.GithubObject._NotSetType] = NotSet, name: Union[str, github.GithubObject._NotSetType] = NotSet) → None¶

Calls: PATCH /orgs/{org}

edit_hook(id: int, name: str, config: dict[str, str], events: Opt[list[str]] = NotSet, active: Opt[bool] = NotSet) → Hook¶

Calls: PATCH /orgs/{owner}/hooks/{id}

get_events() → PaginatedList[Event]¶

Calls: GET /orgs/{org}/events
Return type: PaginatedList of github.Event.Event

get_hook(id: int) → github.Hook.Hook¶

Calls: GET /orgs/{owner}/hooks/{id}

get_hooks() → PaginatedList[Hook]¶

Calls: GET /orgs/{owner}/hooks

get_hook_delivery(hook_id: int, delivery_id: int) → github.HookDelivery.HookDelivery¶

Calls

GET /orgs/{owner}/hooks/{hook_id}/deliveries/{delivery_id}

Parameters

hook_id – integer
delivery_id – integer

Return type

github.HookDelivery.HookDelivery

get_hook_deliveries(hook_id: int) → github.PaginatedList.PaginatedList[github.HookDelivery.HookDeliverySummary][github.HookDelivery.HookDeliverySummary]¶

Calls: GET /orgs/{owner}/hooks/{hook_id}/deliveries
Parameters: hook_id – integer
Return type: PaginatedList of github.HookDelivery.HookDeliverySummary

get_issues(filter: Opt[str] = NotSet, state: Opt[str] = NotSet, labels: Opt[list[Label]] = NotSet, sort: Opt[str] = NotSet, direction: Opt[str] = NotSet, since: Opt[datetime] = NotSet) → PaginatedList[Issue]¶

Calls

GET /orgs/{org}/issues

Return type

PaginatedList of github.Issue.Issue

Parameters