mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 10:51:14 +00:00
Co-authored-by: Enrico Minack <github@enrico.minack.dev>
1456 lines
61 KiB
Python
1456 lines
61 KiB
Python
############################ Copyrights and license ############################
|
|
# #
|
|
# Copyright 2012 Steve English <steve.english@navetas.com> #
|
|
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2012 Zearin <zearin@gonk.net> #
|
|
# Copyright 2013 AKFish <akfish@gmail.com> #
|
|
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2013 martinqt <m.ki2@laposte.net> #
|
|
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
|
|
# Copyright 2015 Sebastien Besson <seb.besson@gmail.com> #
|
|
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
|
|
# Copyright 2016 Matthew Neal <meneal@matthews-mbp.raleigh.ibm.com> #
|
|
# Copyright 2016 Michael Pereira <pereira.m@gmail.com> #
|
|
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
|
|
# Copyright 2017 Balázs Rostás <rostas.balazs@gmail.com> #
|
|
# Copyright 2018 Anton Nguyen <afnguyen85@gmail.com> #
|
|
# Copyright 2018 Jacopo Notarstefano <jacopo.notarstefano@gmail.com> #
|
|
# Copyright 2018 Jasper van Wanrooy <jasper@vanwanrooy.net> #
|
|
# Copyright 2018 Raihaan <31362124+res0nance@users.noreply.github.com> #
|
|
# Copyright 2018 Tim Boring <tboring@hearst.com> #
|
|
# Copyright 2018 sfdye <tsfdye@gmail.com> #
|
|
# Copyright 2018 Steve Kowalik <steven@wedontsleep.org> #
|
|
# Copyright 2023 Mauricio Martinez <mauricio.martinez@premise.com> #
|
|
# #
|
|
# This file is part of PyGithub. #
|
|
# http://pygithub.readthedocs.io/ #
|
|
# #
|
|
# PyGithub is free software: you can redistribute it and/or modify it under #
|
|
# the terms of the GNU Lesser General Public License as published by the Free #
|
|
# Software Foundation, either version 3 of the License, or (at your option) #
|
|
# any later version. #
|
|
# #
|
|
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY #
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS #
|
|
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
|
|
# details. #
|
|
# #
|
|
# You should have received a copy of the GNU Lesser General Public License #
|
|
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>. #
|
|
# #
|
|
################################################################################
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime
|
|
from typing import Any
|
|
|
|
import github.Event
|
|
import github.GithubObject
|
|
import github.NamedUser
|
|
import github.OrganizationSecret
|
|
import github.OrganizationVariable
|
|
import github.PaginatedList
|
|
import github.Plan
|
|
import github.Project
|
|
import github.Repository
|
|
import github.Team
|
|
|
|
from . import Consts
|
|
|
|
|
|
class Organization(github.GithubObject.CompletableGithubObject):
|
|
"""
|
|
This class represents Organizations. The reference can be found here https://docs.github.com/en/rest/reference/orgs
|
|
"""
|
|
|
|
def __repr__(self) -> str:
|
|
return self.get__repr__({"login": self._login.value})
|
|
|
|
@property
|
|
def avatar_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._avatar_url)
|
|
return self._avatar_url.value
|
|
|
|
@property
|
|
def billing_email(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._billing_email)
|
|
return self._billing_email.value
|
|
|
|
@property
|
|
def blog(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._blog)
|
|
return self._blog.value
|
|
|
|
@property
|
|
def collaborators(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._collaborators)
|
|
return self._collaborators.value
|
|
|
|
@property
|
|
def company(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._company)
|
|
return self._company.value
|
|
|
|
@property
|
|
def created_at(self):
|
|
"""
|
|
:type: datetime
|
|
"""
|
|
self._completeIfNotSet(self._created_at)
|
|
return self._created_at.value
|
|
|
|
@property
|
|
def default_repository_permission(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._default_repository_permission)
|
|
return self._default_repository_permission.value
|
|
|
|
@property
|
|
def description(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._description)
|
|
return self._description.value
|
|
|
|
@property
|
|
def disk_usage(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._disk_usage)
|
|
return self._disk_usage.value
|
|
|
|
@property
|
|
def email(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._email)
|
|
return self._email.value
|
|
|
|
@property
|
|
def events_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._events_url)
|
|
return self._events_url.value
|
|
|
|
@property
|
|
def followers(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._followers)
|
|
return self._followers.value
|
|
|
|
@property
|
|
def following(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._following)
|
|
return self._following.value
|
|
|
|
@property
|
|
def gravatar_id(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._gravatar_id)
|
|
return self._gravatar_id.value
|
|
|
|
@property
|
|
def has_organization_projects(self):
|
|
"""
|
|
:type: bool
|
|
"""
|
|
self._completeIfNotSet(self._has_organization_projects)
|
|
return self._has_organization_projects.value
|
|
|
|
@property
|
|
def has_repository_projects(self):
|
|
"""
|
|
:type: bool
|
|
"""
|
|
self._completeIfNotSet(self._has_repository_projects)
|
|
return self._has_repository_projects.value
|
|
|
|
@property
|
|
def hooks_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._hooks_url)
|
|
return self._hooks_url.value
|
|
|
|
@property
|
|
def html_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._html_url)
|
|
return self._html_url.value
|
|
|
|
@property
|
|
def id(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._id)
|
|
return self._id.value
|
|
|
|
@property
|
|
def issues_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._issues_url)
|
|
return self._issues_url.value
|
|
|
|
@property
|
|
def location(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._location)
|
|
return self._location.value
|
|
|
|
@property
|
|
def login(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._login)
|
|
return self._login.value
|
|
|
|
@property
|
|
def members_can_create_repositories(self):
|
|
"""
|
|
:type: bool
|
|
"""
|
|
self._completeIfNotSet(self._members_can_create_repositories)
|
|
return self._members_can_create_repositories.value
|
|
|
|
@property
|
|
def members_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._members_url)
|
|
return self._members_url.value
|
|
|
|
@property
|
|
def name(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._name)
|
|
return self._name.value
|
|
|
|
@property
|
|
def owned_private_repos(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._owned_private_repos)
|
|
return self._owned_private_repos.value
|
|
|
|
@property
|
|
def plan(self):
|
|
"""
|
|
:type: :class:`github.Plan.Plan`
|
|
"""
|
|
self._completeIfNotSet(self._plan)
|
|
return self._plan.value
|
|
|
|
@property
|
|
def private_gists(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._private_gists)
|
|
return self._private_gists.value
|
|
|
|
@property
|
|
def public_gists(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._public_gists)
|
|
return self._public_gists.value
|
|
|
|
@property
|
|
def public_members_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._public_members_url)
|
|
return self._public_members_url.value
|
|
|
|
@property
|
|
def public_repos(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._public_repos)
|
|
return self._public_repos.value
|
|
|
|
@property
|
|
def repos_url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._repos_url)
|
|
return self._repos_url.value
|
|
|
|
@property
|
|
def total_private_repos(self):
|
|
"""
|
|
:type: integer
|
|
"""
|
|
self._completeIfNotSet(self._total_private_repos)
|
|
return self._total_private_repos.value
|
|
|
|
@property
|
|
def two_factor_requirement_enabled(self):
|
|
"""
|
|
:type: bool
|
|
"""
|
|
self._completeIfNotSet(self._two_factor_requirement_enabled)
|
|
return self._two_factor_requirement_enabled.value
|
|
|
|
@property
|
|
def type(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._type)
|
|
return self._type.value
|
|
|
|
@property
|
|
def updated_at(self):
|
|
"""
|
|
:type: datetime
|
|
"""
|
|
self._completeIfNotSet(self._updated_at)
|
|
return self._updated_at.value
|
|
|
|
@property
|
|
def url(self):
|
|
"""
|
|
:type: string
|
|
"""
|
|
self._completeIfNotSet(self._url)
|
|
return self._url.value
|
|
|
|
def add_to_members(self, member, role=github.GithubObject.NotSet):
|
|
"""
|
|
:calls: `PUT /orgs/{org}/memberships/{user} <https://docs.github.com/en/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user>`_
|
|
:param member: :class:`github.NamedUser.NamedUser`
|
|
:param role: string
|
|
:rtype: None
|
|
"""
|
|
assert role is github.GithubObject.NotSet or isinstance(role, str), role
|
|
assert isinstance(member, github.NamedUser.NamedUser), member
|
|
put_parameters = {}
|
|
if role is not github.GithubObject.NotSet:
|
|
put_parameters["role"] = role
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"PUT", f"{self.url}/memberships/{member._identity}", input=put_parameters
|
|
)
|
|
|
|
def add_to_public_members(self, public_member):
|
|
"""
|
|
:calls: `PUT /orgs/{org}/public_members/{user} <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:param public_member: :class:`github.NamedUser.NamedUser`
|
|
:rtype: None
|
|
"""
|
|
assert isinstance(public_member, github.NamedUser.NamedUser), public_member
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"PUT", f"{self.url}/public_members/{public_member._identity}"
|
|
)
|
|
|
|
def create_fork(
|
|
self,
|
|
repo,
|
|
name=github.GithubObject.NotSet,
|
|
default_branch_only=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `POST /repos/{owner}/{repo}/forks <https://docs.github.com/en/rest/reference/repos#forks>`_
|
|
:param repo: :class:`github.Repository.Repository`
|
|
:param name: string
|
|
:param default_branch_only: bool
|
|
:rtype: :class:`github.Repository.Repository`
|
|
"""
|
|
assert isinstance(repo, github.Repository.Repository), repo
|
|
return repo.create_fork(
|
|
self,
|
|
name=name,
|
|
default_branch_only=default_branch_only,
|
|
)
|
|
|
|
def create_repo_from_template(
|
|
self,
|
|
name,
|
|
repo,
|
|
description=github.GithubObject.NotSet,
|
|
private=github.GithubObject.NotSet,
|
|
):
|
|
"""self.name
|
|
:calls: `POST /repos/{template_owner}/{template_repo}/generate <https://docs.github.com/en/rest/reference/repos#create-a-repository-using-a-template>`_
|
|
:param name: string
|
|
:param repo :class:`github.Repository.Repository`
|
|
:param description: string
|
|
:param private: bool
|
|
:rtype: :class:`github.Repository.Repository`
|
|
"""
|
|
assert isinstance(name, str), name
|
|
assert isinstance(repo, github.Repository.Repository), repo
|
|
assert description is github.GithubObject.NotSet or isinstance(description, str), description
|
|
assert private is github.GithubObject.NotSet or isinstance(private, bool), private
|
|
post_parameters = {
|
|
"name": name,
|
|
"owner": self.login,
|
|
}
|
|
if description is not github.GithubObject.NotSet:
|
|
post_parameters["description"] = description
|
|
if private is not github.GithubObject.NotSet:
|
|
post_parameters["private"] = private
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"POST",
|
|
f"/repos/{repo.owner.login}/{repo.name}/generate",
|
|
input=post_parameters,
|
|
headers={"Accept": "application/vnd.github.v3+json"},
|
|
)
|
|
return github.Repository.Repository(self._requester, headers, data, completed=True)
|
|
|
|
def create_hook(
|
|
self,
|
|
name,
|
|
config,
|
|
events=github.GithubObject.NotSet,
|
|
active=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `POST /orgs/{owner}/hooks <https://docs.github.com/en/rest/reference/orgs#webhooks>`_
|
|
:param name: string
|
|
:param config: dict
|
|
:param events: list of string
|
|
:param active: bool
|
|
:rtype: :class:`github.Hook.Hook`
|
|
"""
|
|
assert isinstance(name, str), name
|
|
assert isinstance(config, dict), config
|
|
assert events is github.GithubObject.NotSet or all(isinstance(element, str) for element in events), events
|
|
assert active is github.GithubObject.NotSet or isinstance(active, bool), active
|
|
post_parameters = {
|
|
"name": name,
|
|
"config": config,
|
|
}
|
|
if events is not github.GithubObject.NotSet:
|
|
post_parameters["events"] = events
|
|
if active is not github.GithubObject.NotSet:
|
|
post_parameters["active"] = active
|
|
headers, data = self._requester.requestJsonAndCheck("POST", f"{self.url}/hooks", input=post_parameters)
|
|
return github.Hook.Hook(self._requester, headers, data, completed=True)
|
|
|
|
def create_project(self, name, body=github.GithubObject.NotSet):
|
|
"""
|
|
:calls: `POST /orgs/{org}/projects <https://docs.github.com/en/rest/reference/projects#create-an-organization-project>`_
|
|
:param name: string
|
|
:param body: string
|
|
:rtype: :class:`github.Project.Project`
|
|
"""
|
|
assert isinstance(name, str), name
|
|
assert body is github.GithubObject.NotSet or isinstance(body, str), body
|
|
post_parameters = {"name": name}
|
|
if body is not github.GithubObject.NotSet:
|
|
post_parameters["body"] = body
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"POST",
|
|
f"{self.url}/projects",
|
|
input=post_parameters,
|
|
headers={"Accept": Consts.mediaTypeProjectsPreview},
|
|
)
|
|
return github.Project.Project(self._requester, headers, data, completed=True)
|
|
|
|
def create_repo(
|
|
self,
|
|
name,
|
|
description=github.GithubObject.NotSet,
|
|
homepage=github.GithubObject.NotSet,
|
|
private=github.GithubObject.NotSet,
|
|
visibility=github.GithubObject.NotSet,
|
|
has_issues=github.GithubObject.NotSet,
|
|
has_wiki=github.GithubObject.NotSet,
|
|
has_downloads=github.GithubObject.NotSet,
|
|
has_projects=github.GithubObject.NotSet,
|
|
team_id=github.GithubObject.NotSet,
|
|
auto_init=github.GithubObject.NotSet,
|
|
license_template=github.GithubObject.NotSet,
|
|
gitignore_template=github.GithubObject.NotSet,
|
|
allow_squash_merge=github.GithubObject.NotSet,
|
|
allow_merge_commit=github.GithubObject.NotSet,
|
|
allow_rebase_merge=github.GithubObject.NotSet,
|
|
delete_branch_on_merge=github.GithubObject.NotSet,
|
|
allow_update_branch=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `POST /orgs/{org}/repos <https://docs.github.com/en/rest/reference/repos>`_
|
|
:param name: string
|
|
:param description: string
|
|
:param homepage: string
|
|
:param private: bool
|
|
:param has_issues: bool
|
|
:param has_wiki: bool
|
|
:param has_downloads: bool
|
|
:param has_projects: bool
|
|
:param team_id: : int
|
|
:param auto_init: bool
|
|
:param license_template: string
|
|
:param gitignore_template: string
|
|
:param allow_squash_merge: bool
|
|
:param allow_merge_commit: bool
|
|
:param allow_rebase_merge: bool
|
|
:param delete_branch_on_merge: bool
|
|
:param allow_update_branch: bool
|
|
:rtype: :class:`github.Repository.Repository`
|
|
"""
|
|
assert isinstance(name, str), name
|
|
assert description is github.GithubObject.NotSet or isinstance(description, str), description
|
|
assert homepage is github.GithubObject.NotSet or isinstance(homepage, str), homepage
|
|
assert private is github.GithubObject.NotSet or isinstance(private, bool), private
|
|
assert visibility is github.GithubObject.NotSet or isinstance(visibility, str), visibility
|
|
assert has_issues is github.GithubObject.NotSet or isinstance(has_issues, bool), has_issues
|
|
assert has_wiki is github.GithubObject.NotSet or isinstance(has_wiki, bool), has_wiki
|
|
assert has_downloads is github.GithubObject.NotSet or isinstance(has_downloads, bool), has_downloads
|
|
assert has_projects is github.GithubObject.NotSet or isinstance(has_projects, bool), has_projects
|
|
assert team_id is github.GithubObject.NotSet or isinstance(team_id, int), team_id
|
|
assert auto_init is github.GithubObject.NotSet or isinstance(auto_init, bool), auto_init
|
|
assert license_template is github.GithubObject.NotSet or isinstance(license_template, str), license_template
|
|
assert gitignore_template is github.GithubObject.NotSet or isinstance(
|
|
gitignore_template, str
|
|
), gitignore_template
|
|
assert allow_squash_merge is github.GithubObject.NotSet or isinstance(
|
|
allow_squash_merge, bool
|
|
), allow_squash_merge
|
|
assert allow_merge_commit is github.GithubObject.NotSet or isinstance(
|
|
allow_merge_commit, bool
|
|
), allow_merge_commit
|
|
assert allow_rebase_merge is github.GithubObject.NotSet or isinstance(
|
|
allow_rebase_merge, bool
|
|
), allow_rebase_merge
|
|
assert delete_branch_on_merge is github.GithubObject.NotSet or isinstance(
|
|
delete_branch_on_merge, bool
|
|
), delete_branch_on_merge
|
|
assert allow_update_branch is github.GithubObject.NotSet or isinstance(
|
|
allow_update_branch, bool
|
|
), allow_update_branch
|
|
post_parameters = {
|
|
"name": name,
|
|
}
|
|
if description is not github.GithubObject.NotSet:
|
|
post_parameters["description"] = description
|
|
if homepage is not github.GithubObject.NotSet:
|
|
post_parameters["homepage"] = homepage
|
|
if private is not github.GithubObject.NotSet:
|
|
post_parameters["private"] = private
|
|
if visibility is not github.GithubObject.NotSet:
|
|
post_parameters["visibility"] = visibility
|
|
if has_issues is not github.GithubObject.NotSet:
|
|
post_parameters["has_issues"] = has_issues
|
|
if has_wiki is not github.GithubObject.NotSet:
|
|
post_parameters["has_wiki"] = has_wiki
|
|
if has_downloads is not github.GithubObject.NotSet:
|
|
post_parameters["has_downloads"] = has_downloads
|
|
if has_projects is not github.GithubObject.NotSet:
|
|
post_parameters["has_projects"] = has_projects
|
|
if team_id is not github.GithubObject.NotSet:
|
|
post_parameters["team_id"] = team_id
|
|
if auto_init is not github.GithubObject.NotSet:
|
|
post_parameters["auto_init"] = auto_init
|
|
if license_template is not github.GithubObject.NotSet:
|
|
post_parameters["license_template"] = license_template
|
|
if gitignore_template is not github.GithubObject.NotSet:
|
|
post_parameters["gitignore_template"] = gitignore_template
|
|
if allow_squash_merge is not github.GithubObject.NotSet:
|
|
post_parameters["allow_squash_merge"] = allow_squash_merge
|
|
if allow_merge_commit is not github.GithubObject.NotSet:
|
|
post_parameters["allow_merge_commit"] = allow_merge_commit
|
|
if allow_rebase_merge is not github.GithubObject.NotSet:
|
|
post_parameters["allow_rebase_merge"] = allow_rebase_merge
|
|
if delete_branch_on_merge is not github.GithubObject.NotSet:
|
|
post_parameters["delete_branch_on_merge"] = delete_branch_on_merge
|
|
if allow_update_branch is not github.GithubObject.NotSet:
|
|
post_parameters["allow_update_branch"] = allow_update_branch
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"POST",
|
|
f"{self.url}/repos",
|
|
input=post_parameters,
|
|
headers={"Accept": Consts.repoVisibilityPreview},
|
|
)
|
|
return github.Repository.Repository(self._requester, headers, data, completed=True)
|
|
|
|
def create_secret(
|
|
self,
|
|
secret_name,
|
|
unencrypted_value,
|
|
visibility="all",
|
|
selected_repositories: github.GithubObject.Opt[list[github.Repository.Repository]] = github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `PUT /orgs/{org}/actions/secrets/{secret_name} <https://docs.github.com/en/rest/actions/secrets#create-or-update-an-organization-secret>`_
|
|
:param secret_name: string
|
|
:param unencrypted_value: string
|
|
:param visibility: string
|
|
:param selected_repositories: Optional list of :class:`github.Repository.Repository`
|
|
:rtype: github.OrganizationSecret.OrganizationSecret
|
|
"""
|
|
assert isinstance(secret_name, str), secret_name
|
|
assert isinstance(unencrypted_value, str), unencrypted_value
|
|
assert isinstance(visibility, str), visibility
|
|
if visibility == "selected":
|
|
assert isinstance(selected_repositories, list) and all(
|
|
isinstance(element, github.Repository.Repository) for element in selected_repositories
|
|
), selected_repositories
|
|
else:
|
|
assert selected_repositories is github.GithubObject.NotSet
|
|
|
|
public_key = self.get_public_key()
|
|
payload = public_key.encrypt(unencrypted_value)
|
|
put_parameters = {
|
|
"key_id": public_key.key_id,
|
|
"encrypted_value": payload,
|
|
"visibility": visibility,
|
|
}
|
|
if selected_repositories is not github.GithubObject.NotSet:
|
|
put_parameters["selected_repository_ids"] = [element.id for element in selected_repositories]
|
|
|
|
self._requester.requestJsonAndCheck("PUT", f"{self.url}/actions/secrets/{secret_name}", input=put_parameters)
|
|
|
|
return github.OrganizationSecret.OrganizationSecret(
|
|
requester=self._requester,
|
|
headers={},
|
|
attributes={
|
|
"name": secret_name,
|
|
"visibility": visibility,
|
|
"selected_repositories_url": f"{self.url}/actions/secrets/{secret_name}/repositories",
|
|
"url": f"{self.url}/actions/secrets/{secret_name}",
|
|
},
|
|
completed=False,
|
|
)
|
|
|
|
def get_secrets(self):
|
|
"""
|
|
Gets all organization secrets
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.OrganizationSecret.OrganizationSecret`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(
|
|
github.OrganizationSecret.OrganizationSecret,
|
|
self._requester,
|
|
f"{self.url}/actions/secrets",
|
|
None,
|
|
list_item="secrets",
|
|
)
|
|
|
|
def get_secret(self, secret_name: str):
|
|
"""
|
|
:calls: 'GET /orgs/{org}/actions/secrets/{secret_name} <https://docs.github.com/en/rest/actions/secrets#get-an-organization-secret>`_
|
|
:param secret_name: string
|
|
:rtype: github.OrganizationSecret.OrganizationSecret
|
|
"""
|
|
assert isinstance(secret_name, str), secret_name
|
|
return github.OrganizationSecret.OrganizationSecret(
|
|
requester=self._requester,
|
|
headers={},
|
|
attributes={"url": f"{self.url}/actions/secrets/{secret_name}"},
|
|
completed=False,
|
|
)
|
|
|
|
def create_team(
|
|
self,
|
|
name,
|
|
repo_names=github.GithubObject.NotSet,
|
|
permission=github.GithubObject.NotSet,
|
|
privacy=github.GithubObject.NotSet,
|
|
description=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `POST /orgs/{org}/teams <https://docs.github.com/en/rest/reference/teams#list-teams>`_
|
|
:param name: string
|
|
:param repo_names: list of :class:`github.Repository.Repository`
|
|
:param permission: string
|
|
:param privacy: string
|
|
:param description: string
|
|
:rtype: :class:`github.Team.Team`
|
|
"""
|
|
assert isinstance(name, str), name
|
|
assert repo_names is github.GithubObject.NotSet or all(
|
|
isinstance(element, github.Repository.Repository) for element in repo_names
|
|
), repo_names
|
|
assert permission is github.GithubObject.NotSet or isinstance(permission, str), permission
|
|
assert privacy is github.GithubObject.NotSet or isinstance(privacy, str), privacy
|
|
assert description is github.GithubObject.NotSet or isinstance(description, str), description
|
|
post_parameters = {
|
|
"name": name,
|
|
}
|
|
if repo_names is not github.GithubObject.NotSet:
|
|
post_parameters["repo_names"] = [element._identity for element in repo_names]
|
|
if permission is not github.GithubObject.NotSet:
|
|
post_parameters["permission"] = permission
|
|
if privacy is not github.GithubObject.NotSet:
|
|
post_parameters["privacy"] = privacy
|
|
if description is not github.GithubObject.NotSet:
|
|
post_parameters["description"] = description
|
|
headers, data = self._requester.requestJsonAndCheck("POST", f"{self.url}/teams", input=post_parameters)
|
|
return github.Team.Team(self._requester, headers, data, completed=True)
|
|
|
|
def create_variable(
|
|
self,
|
|
variable_name: str,
|
|
value: str,
|
|
visibility: str = "all",
|
|
selected_repositories: github.GithubObject.Opt[list[github.Repository.Repository]] = github.GithubObject.NotSet,
|
|
) -> github.OrganizationVariable.OrganizationVariable:
|
|
"""
|
|
:calls: `POST /orgs/{org}/actions/variables/ <https://docs.github.com/en/rest/actions/variables#create-an-organization-variable>`_
|
|
:param variable_name: string
|
|
:param value: string
|
|
:param visibility: string
|
|
:param selected_repositories: list of :class:`github.Repository.Repository`
|
|
:rtype: github.OrganizationVariable.OrganizationVariable
|
|
"""
|
|
assert isinstance(variable_name, str), variable_name
|
|
assert isinstance(value, str), value
|
|
assert isinstance(visibility, str), visibility
|
|
if visibility == "selected":
|
|
assert isinstance(selected_repositories, list) and all(
|
|
isinstance(element, github.Repository.Repository) for element in selected_repositories
|
|
), selected_repositories
|
|
else:
|
|
assert selected_repositories is github.GithubObject.NotSet
|
|
|
|
post_parameters = {
|
|
"name": variable_name,
|
|
"value": value,
|
|
"visibility": visibility,
|
|
}
|
|
if selected_repositories is not github.GithubObject.NotSet:
|
|
post_parameters["selected_repository_ids"] = [element.id for element in selected_repositories]
|
|
|
|
self._requester.requestJsonAndCheck("POST", f"{self.url}/actions/variables", input=post_parameters)
|
|
|
|
return github.OrganizationVariable.OrganizationVariable(
|
|
requester=self._requester,
|
|
headers={},
|
|
attributes={
|
|
"name": variable_name,
|
|
"visibility": visibility,
|
|
"value": value,
|
|
"selected_repositories_url": f"{self.url}/actions/variables/{variable_name}/repositories",
|
|
"url": self.url,
|
|
},
|
|
completed=False,
|
|
)
|
|
|
|
def get_variables(self):
|
|
"""
|
|
Gets all organization variables
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.OrganizationVariable.OrganizationVariable`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(
|
|
github.OrganizationVariable.OrganizationVariable,
|
|
self._requester,
|
|
f"{self.url}/actions/variables",
|
|
None,
|
|
list_item="variables",
|
|
)
|
|
|
|
def get_variable(self, variable_name: str):
|
|
"""
|
|
:calls: 'GET /orgs/{org}/actions/variables/{variable_name} <https://docs.github.com/en/rest/actions/variables#get-an-organization-variable>`_
|
|
:param variable_name: string
|
|
:rtype: github.OrganizationVariable.OrganizationVariable
|
|
"""
|
|
assert isinstance(variable_name, str), variable_name
|
|
return github.OrganizationVariable.OrganizationVariable(
|
|
requester=self._requester,
|
|
headers={},
|
|
attributes={"url": f"{self.url}/actions/variables/{variable_name}"},
|
|
completed=False,
|
|
)
|
|
|
|
def delete_hook(self, id):
|
|
"""
|
|
:calls: `DELETE /orgs/{owner}/hooks/{id} <https://docs.github.com/en/rest/reference/orgs#webhooks>`_
|
|
:param id: integer
|
|
:rtype: None`
|
|
"""
|
|
assert isinstance(id, int), id
|
|
headers, data = self._requester.requestJsonAndCheck("DELETE", f"{self.url}/hooks/{id}")
|
|
|
|
def edit(
|
|
self,
|
|
billing_email=github.GithubObject.NotSet,
|
|
blog=github.GithubObject.NotSet,
|
|
company=github.GithubObject.NotSet,
|
|
description=github.GithubObject.NotSet,
|
|
email=github.GithubObject.NotSet,
|
|
location=github.GithubObject.NotSet,
|
|
name=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `PATCH /orgs/{org} <https://docs.github.com/en/rest/reference/orgs>`_
|
|
:param billing_email: string
|
|
:param blog: string
|
|
:param company: string
|
|
:param description: string
|
|
:param email: string
|
|
:param location: string
|
|
:param name: string
|
|
:rtype: None
|
|
"""
|
|
assert billing_email is github.GithubObject.NotSet or isinstance(billing_email, str), billing_email
|
|
assert blog is github.GithubObject.NotSet or isinstance(blog, str), blog
|
|
assert company is github.GithubObject.NotSet or isinstance(company, str), company
|
|
assert description is github.GithubObject.NotSet or isinstance(description, str), description
|
|
assert email is github.GithubObject.NotSet or isinstance(email, str), email
|
|
assert location is github.GithubObject.NotSet or isinstance(location, str), location
|
|
assert name is github.GithubObject.NotSet or isinstance(name, str), name
|
|
post_parameters = dict()
|
|
if billing_email is not github.GithubObject.NotSet:
|
|
post_parameters["billing_email"] = billing_email
|
|
if blog is not github.GithubObject.NotSet:
|
|
post_parameters["blog"] = blog
|
|
if company is not github.GithubObject.NotSet:
|
|
post_parameters["company"] = company
|
|
if description is not github.GithubObject.NotSet:
|
|
post_parameters["description"] = description
|
|
if email is not github.GithubObject.NotSet:
|
|
post_parameters["email"] = email
|
|
if location is not github.GithubObject.NotSet:
|
|
post_parameters["location"] = location
|
|
if name is not github.GithubObject.NotSet:
|
|
post_parameters["name"] = name
|
|
headers, data = self._requester.requestJsonAndCheck("PATCH", self.url, input=post_parameters)
|
|
self._useAttributes(data)
|
|
|
|
def edit_hook(
|
|
self,
|
|
id,
|
|
name,
|
|
config,
|
|
events=github.GithubObject.NotSet,
|
|
active=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `PATCH /orgs/{owner}/hooks/{id} <https://docs.github.com/en/rest/reference/orgs#webhooks>`_
|
|
:param id: integer
|
|
:param name: string
|
|
:param config: dict
|
|
:param events: list of string
|
|
:param active: bool
|
|
:rtype: :class:`github.Hook.Hook`
|
|
"""
|
|
assert isinstance(id, int), id
|
|
assert isinstance(name, str), name
|
|
assert isinstance(config, dict), config
|
|
assert events is github.GithubObject.NotSet or all(isinstance(element, str) for element in events), events
|
|
assert active is github.GithubObject.NotSet or isinstance(active, bool), active
|
|
post_parameters = {
|
|
"name": name,
|
|
"config": config,
|
|
}
|
|
if events is not github.GithubObject.NotSet:
|
|
post_parameters["events"] = events
|
|
if active is not github.GithubObject.NotSet:
|
|
post_parameters["active"] = active
|
|
headers, data = self._requester.requestJsonAndCheck("PATCH", f"{self.url}/hooks/{id}", input=post_parameters)
|
|
return github.Hook.Hook(self._requester, headers, data, completed=True)
|
|
|
|
def get_events(self):
|
|
"""
|
|
:calls: `GET /orgs/{org}/events <https://docs.github.com/en/rest/reference/activity#events>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(github.Event.Event, self._requester, f"{self.url}/events", None)
|
|
|
|
def get_hook(self, id):
|
|
"""
|
|
:calls: `GET /orgs/{owner}/hooks/{id} <https://docs.github.com/en/rest/reference/orgs#webhooks>`_
|
|
:param id: integer
|
|
:rtype: :class:`github.Hook.Hook`
|
|
"""
|
|
assert isinstance(id, int), id
|
|
headers, data = self._requester.requestJsonAndCheck("GET", f"{self.url}/hooks/{id}")
|
|
return github.Hook.Hook(self._requester, headers, data, completed=True)
|
|
|
|
def get_hooks(self):
|
|
"""
|
|
:calls: `GET /orgs/{owner}/hooks <https://docs.github.com/en/rest/reference/orgs#webhooks>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Hook.Hook`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(github.Hook.Hook, self._requester, f"{self.url}/hooks", None)
|
|
|
|
def get_hook_delivery(self, hook_id: int, delivery_id: int) -> github.HookDelivery.HookDelivery:
|
|
"""
|
|
:calls: `GET /orgs/{owner}/hooks/{hook_id}/deliveries/{delivery_id} <https://docs.github.com/en/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook>`_
|
|
:param hook_id: integer
|
|
:param delivery_id: integer
|
|
:rtype: :class:`github.HookDelivery.HookDelivery`
|
|
"""
|
|
assert isinstance(hook_id, int), hook_id
|
|
assert isinstance(delivery_id, int), delivery_id
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"GET", f"{self.url}/hooks/{hook_id}/deliveries/{delivery_id}"
|
|
)
|
|
return github.HookDelivery.HookDelivery(self._requester, headers, data, completed=True)
|
|
|
|
def get_hook_deliveries(
|
|
self, hook_id: int
|
|
) -> github.PaginatedList.PaginatedList[github.HookDelivery.HookDeliverySummary]:
|
|
"""
|
|
:calls: `GET /orgs/{owner}/hooks/{hook_id}/deliveries <https://docs.github.com/en/rest/reference/orgs#list-deliveries-for-an-organization-webhook>`_
|
|
:param hook_id: integer
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.HookDelivery.HookDeliverySummary`
|
|
"""
|
|
assert isinstance(hook_id, int), hook_id
|
|
return github.PaginatedList.PaginatedList(
|
|
github.HookDelivery.HookDeliverySummary,
|
|
self._requester,
|
|
f"{self.url}/hooks/{hook_id}/deliveries",
|
|
None,
|
|
)
|
|
|
|
def get_issues(
|
|
self,
|
|
filter=github.GithubObject.NotSet,
|
|
state=github.GithubObject.NotSet,
|
|
labels=github.GithubObject.NotSet,
|
|
sort=github.GithubObject.NotSet,
|
|
direction=github.GithubObject.NotSet,
|
|
since=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `GET /orgs/{org}/issues <https://docs.github.com/en/rest/reference/issues>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Issue.Issue`
|
|
:param filter: string
|
|
:param state: string
|
|
:param labels: list of :class:`github.Label.Label`
|
|
:param sort: string
|
|
:param direction: string
|
|
:param since: datetime
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Issue.Issue`
|
|
"""
|
|
assert filter is github.GithubObject.NotSet or isinstance(filter, str), filter
|
|
assert state is github.GithubObject.NotSet or isinstance(state, str), state
|
|
assert labels is github.GithubObject.NotSet or all(
|
|
isinstance(element, github.Label.Label) for element in labels
|
|
), labels
|
|
assert sort is github.GithubObject.NotSet or isinstance(sort, str), sort
|
|
assert direction is github.GithubObject.NotSet or isinstance(direction, str), direction
|
|
assert since is github.GithubObject.NotSet or isinstance(since, datetime), since
|
|
url_parameters = dict()
|
|
if filter is not github.GithubObject.NotSet:
|
|
url_parameters["filter"] = filter
|
|
if state is not github.GithubObject.NotSet:
|
|
url_parameters["state"] = state
|
|
if labels is not github.GithubObject.NotSet:
|
|
url_parameters["labels"] = ",".join(label.name for label in labels)
|
|
if sort is not github.GithubObject.NotSet:
|
|
url_parameters["sort"] = sort
|
|
if direction is not github.GithubObject.NotSet:
|
|
url_parameters["direction"] = direction
|
|
if since is not github.GithubObject.NotSet:
|
|
url_parameters["since"] = since.strftime("%Y-%m-%dT%H:%M:%SZ")
|
|
return github.PaginatedList.PaginatedList(
|
|
github.Issue.Issue, self._requester, f"{self.url}/issues", url_parameters
|
|
)
|
|
|
|
def get_members(self, filter_=github.GithubObject.NotSet, role=github.GithubObject.NotSet):
|
|
"""
|
|
:calls: `GET /orgs/{org}/members <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:param filter_: string
|
|
:param role: string
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
|
"""
|
|
assert filter_ is github.GithubObject.NotSet or isinstance(filter_, str), filter_
|
|
assert role is github.GithubObject.NotSet or isinstance(role, str), role
|
|
|
|
url_parameters = {}
|
|
if filter_ is not github.GithubObject.NotSet:
|
|
url_parameters["filter"] = filter_
|
|
if role is not github.GithubObject.NotSet:
|
|
url_parameters["role"] = role
|
|
return github.PaginatedList.PaginatedList(
|
|
github.NamedUser.NamedUser,
|
|
self._requester,
|
|
f"{self.url}/members",
|
|
url_parameters,
|
|
)
|
|
|
|
def get_projects(self, state=github.GithubObject.NotSet):
|
|
"""
|
|
:calls: `GET /orgs/{org}/projects <https://docs.github.com/en/rest/reference/projects#list-organization-projects>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Project.Project`
|
|
:param state: string
|
|
"""
|
|
|
|
url_parameters = dict()
|
|
if state is not github.GithubObject.NotSet:
|
|
url_parameters["state"] = state
|
|
|
|
return github.PaginatedList.PaginatedList(
|
|
github.Project.Project,
|
|
self._requester,
|
|
f"{self.url}/projects",
|
|
url_parameters,
|
|
{"Accept": Consts.mediaTypeProjectsPreview},
|
|
)
|
|
|
|
def get_public_members(self):
|
|
"""
|
|
:calls: `GET /orgs/{org}/public_members <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(
|
|
github.NamedUser.NamedUser,
|
|
self._requester,
|
|
f"{self.url}/public_members",
|
|
None,
|
|
)
|
|
|
|
def get_outside_collaborators(self, filter_=github.GithubObject.NotSet):
|
|
"""
|
|
:calls: `GET /orgs/{org}/outside_collaborators <https://docs.github.com/en/rest/reference/orgs#outside-collaborators>`_
|
|
:param filter_: string
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
|
"""
|
|
assert filter_ is github.GithubObject.NotSet or isinstance(filter_, str), filter_
|
|
|
|
url_parameters = {}
|
|
if filter_ is not github.GithubObject.NotSet:
|
|
url_parameters["filter"] = filter_
|
|
return github.PaginatedList.PaginatedList(
|
|
github.NamedUser.NamedUser,
|
|
self._requester,
|
|
f"{self.url}/outside_collaborators",
|
|
url_parameters,
|
|
)
|
|
|
|
def remove_outside_collaborator(self, collaborator):
|
|
"""
|
|
:calls: `DELETE /orgs/{org}/outside_collaborators/{username} <https://docs.github.com/en/rest/reference/orgs#outside-collaborators>`_
|
|
:param collaborator: :class:`github.NamedUser.NamedUser`
|
|
:rtype: None
|
|
"""
|
|
assert isinstance(collaborator, github.NamedUser.NamedUser), collaborator
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"DELETE", f"{self.url}/outside_collaborators/{collaborator._identity}"
|
|
)
|
|
|
|
def convert_to_outside_collaborator(self, member):
|
|
"""
|
|
:calls: `PUT /orgs/{org}/outside_collaborators/{username} <https://docs.github.com/en/rest/reference/orgs#outside-collaborators>`_
|
|
:param member: :class:`github.NamedUser.NamedUser`
|
|
:rtype: None
|
|
"""
|
|
assert isinstance(member, github.NamedUser.NamedUser), member
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"PUT", f"{self.url}/outside_collaborators/{member._identity}"
|
|
)
|
|
|
|
def get_public_key(self):
|
|
"""
|
|
:calls: `GET /orgs/{org}/actions/secrets/public-key <https://docs.github.com/en/rest/reference/actions#get-an-organization-public-key>`_
|
|
:rtype: :class:`github.PublicKey.PublicKey`
|
|
"""
|
|
headers, data = self._requester.requestJsonAndCheck("GET", f"{self.url}/actions/secrets/public-key")
|
|
return github.PublicKey.PublicKey(self._requester, headers, data, completed=True)
|
|
|
|
def get_repo(self, name):
|
|
"""
|
|
:calls: `GET /repos/{owner}/{repo} <https://docs.github.com/en/rest/reference/repos>`_
|
|
:param name: string
|
|
:rtype: :class:`github.Repository.Repository`
|
|
"""
|
|
assert isinstance(name, str), name
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"GET",
|
|
f"/repos/{self.login}/{name}",
|
|
headers={"Accept": Consts.repoVisibilityPreview},
|
|
)
|
|
return github.Repository.Repository(self._requester, headers, data, completed=True)
|
|
|
|
def get_repos(
|
|
self,
|
|
type=github.GithubObject.NotSet,
|
|
sort=github.GithubObject.NotSet,
|
|
direction=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `GET /orgs/{org}/repos <https://docs.github.com/en/rest/reference/repos>`_
|
|
:param type: string ('all', 'public', 'private', 'forks', 'sources', 'member')
|
|
:param sort: string ('created', 'updated', 'pushed', 'full_name')
|
|
:param direction: string ('asc', desc')
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`
|
|
"""
|
|
assert type is github.GithubObject.NotSet or isinstance(type, str), type
|
|
assert sort is github.GithubObject.NotSet or isinstance(sort, str), sort
|
|
assert direction is github.GithubObject.NotSet or isinstance(direction, str), direction
|
|
|
|
url_parameters = dict()
|
|
if type is not github.GithubObject.NotSet:
|
|
url_parameters["type"] = type
|
|
if sort is not github.GithubObject.NotSet:
|
|
url_parameters["sort"] = sort
|
|
if direction is not github.GithubObject.NotSet:
|
|
url_parameters["direction"] = direction
|
|
return github.PaginatedList.PaginatedList(
|
|
github.Repository.Repository,
|
|
self._requester,
|
|
f"{self.url}/repos",
|
|
url_parameters,
|
|
headers={"Accept": Consts.repoVisibilityPreview},
|
|
)
|
|
|
|
def get_team(self, id):
|
|
"""
|
|
:calls: `GET /teams/{id} <https://docs.github.com/en/rest/reference/teams>`_
|
|
:param id: integer
|
|
:rtype: :class:`github.Team.Team`
|
|
"""
|
|
assert isinstance(id, int), id
|
|
headers, data = self._requester.requestJsonAndCheck("GET", f"/teams/{id}")
|
|
return github.Team.Team(self._requester, headers, data, completed=True)
|
|
|
|
def get_team_by_slug(self, slug):
|
|
"""
|
|
:calls: `GET /orgs/{org}/teams/{team_slug} <https://docs.github.com/en/rest/reference/teams#get-a-team-by-name>`_
|
|
:param slug: string
|
|
:rtype: :class:`github.Team.Team`
|
|
"""
|
|
assert isinstance(slug, str), slug
|
|
headers, data = self._requester.requestJsonAndCheck("GET", f"{self.url}/teams/{slug}")
|
|
return github.Team.Team(self._requester, headers, data, completed=True)
|
|
|
|
def get_teams(self):
|
|
"""
|
|
:calls: `GET /orgs/{org}/teams <https://docs.github.com/en/rest/reference/teams#list-teams>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Team.Team`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(github.Team.Team, self._requester, f"{self.url}/teams", None)
|
|
|
|
def invitations(self):
|
|
"""
|
|
:calls: `GET /orgs/{org}/invitations <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(
|
|
github.NamedUser.NamedUser,
|
|
self._requester,
|
|
f"{self.url}/invitations",
|
|
None,
|
|
headers={"Accept": Consts.mediaTypeOrganizationInvitationPreview},
|
|
)
|
|
|
|
def invite_user(
|
|
self,
|
|
user=github.GithubObject.NotSet,
|
|
email=github.GithubObject.NotSet,
|
|
role=github.GithubObject.NotSet,
|
|
teams=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `POST /orgs/{org}/invitations <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:param user: :class:`github.NamedUser.NamedUser`
|
|
:param email: string
|
|
:param role: string
|
|
:param teams: array of :class:`github.Team.Team`
|
|
:rtype: None
|
|
"""
|
|
assert user is github.GithubObject.NotSet or isinstance(user, github.NamedUser.NamedUser), user
|
|
assert email is github.GithubObject.NotSet or isinstance(email, str), email
|
|
assert (email is github.GithubObject.NotSet) ^ (
|
|
user is github.GithubObject.NotSet
|
|
), "specify only one of email or user"
|
|
parameters = {}
|
|
if user is not github.GithubObject.NotSet:
|
|
parameters["invitee_id"] = user.id
|
|
elif email is not github.GithubObject.NotSet:
|
|
parameters["email"] = email
|
|
if role is not github.GithubObject.NotSet:
|
|
assert isinstance(role, str), role
|
|
assert role in ["admin", "direct_member", "billing_manager"]
|
|
parameters["role"] = role
|
|
if teams is not github.GithubObject.NotSet:
|
|
assert all(isinstance(team, github.Team.Team) for team in teams)
|
|
parameters["team_ids"] = [t.id for t in teams]
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"POST",
|
|
f"{self.url}/invitations",
|
|
headers={"Accept": Consts.mediaTypeOrganizationInvitationPreview},
|
|
input=parameters,
|
|
)
|
|
|
|
def cancel_invitation(self, invitee):
|
|
"""
|
|
:calls: `DELETE /orgs/{org}/invitations/{invitation_id} <https://docs.github.com/en/rest/reference/orgs#cancel-an-organization-invitation>`_
|
|
:param invitee: :class:`github.NamedUser.NamedUser`
|
|
:rtype: None
|
|
"""
|
|
assert isinstance(invitee, github.NamedUser.NamedUser), invitee
|
|
status, headers, data = self._requester.requestJson("DELETE", f"{self.url}/invitations/{invitee.id}")
|
|
return status == 204
|
|
|
|
def has_in_members(self, member):
|
|
"""
|
|
:calls: `GET /orgs/{org}/members/{user} <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:param member: :class:`github.NamedUser.NamedUser`
|
|
:rtype: bool
|
|
"""
|
|
assert isinstance(member, github.NamedUser.NamedUser), member
|
|
status, headers, data = self._requester.requestJson("GET", f"{self.url}/members/{member._identity}")
|
|
if status == 302:
|
|
status, headers, data = self._requester.requestJson("GET", headers["location"])
|
|
return status == 204
|
|
|
|
def has_in_public_members(self, public_member):
|
|
"""
|
|
:calls: `GET /orgs/{org}/public_members/{user} <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:param public_member: :class:`github.NamedUser.NamedUser`
|
|
:rtype: bool
|
|
"""
|
|
assert isinstance(public_member, github.NamedUser.NamedUser), public_member
|
|
status, headers, data = self._requester.requestJson(
|
|
"GET", f"{self.url}/public_members/{public_member._identity}"
|
|
)
|
|
return status == 204
|
|
|
|
def remove_from_membership(self, member):
|
|
"""
|
|
:calls: `DELETE /orgs/{org}/memberships/{user} <https://docs.github.com/en/rest/reference/orgs#remove-an-organization-member>`_
|
|
:param member: :class:`github.NamedUser.NamedUser`
|
|
:rtype: None
|
|
"""
|
|
assert isinstance(member, github.NamedUser.NamedUser), member
|
|
headers, data = self._requester.requestJsonAndCheck("DELETE", f"{self.url}/memberships/{member._identity}")
|
|
|
|
def remove_from_members(self, member):
|
|
"""
|
|
:calls: `DELETE /orgs/{org}/members/{user} <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:param member: :class:`github.NamedUser.NamedUser`
|
|
:rtype: None
|
|
"""
|
|
assert isinstance(member, github.NamedUser.NamedUser), member
|
|
headers, data = self._requester.requestJsonAndCheck("DELETE", f"{self.url}/members/{member._identity}")
|
|
|
|
def remove_from_public_members(self, public_member):
|
|
"""
|
|
:calls: `DELETE /orgs/{org}/public_members/{user} <https://docs.github.com/en/rest/reference/orgs#members>`_
|
|
:param public_member: :class:`github.NamedUser.NamedUser`
|
|
:rtype: None
|
|
"""
|
|
assert isinstance(public_member, github.NamedUser.NamedUser), public_member
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"DELETE", f"{self.url}/public_members/{public_member._identity}"
|
|
)
|
|
|
|
def create_migration(
|
|
self,
|
|
repos,
|
|
lock_repositories=github.GithubObject.NotSet,
|
|
exclude_attachments=github.GithubObject.NotSet,
|
|
):
|
|
"""
|
|
:calls: `POST /orgs/{org}/migrations <https://docs.github.com/en/rest/reference/migrations#list-organization-migrations>`_
|
|
:param repos: list or tuple of str
|
|
:param lock_repositories: bool
|
|
:param exclude_attachments: bool
|
|
:rtype: :class:`github.Migration.Migration`
|
|
"""
|
|
assert isinstance(repos, (list, tuple)), repos
|
|
assert all(isinstance(repo, str) for repo in repos), repos
|
|
assert lock_repositories is github.GithubObject.NotSet or isinstance(lock_repositories, bool), lock_repositories
|
|
assert exclude_attachments is github.GithubObject.NotSet or isinstance(
|
|
exclude_attachments, bool
|
|
), exclude_attachments
|
|
post_parameters = {"repositories": repos}
|
|
if lock_repositories is not github.GithubObject.NotSet:
|
|
post_parameters["lock_repositories"] = lock_repositories
|
|
if exclude_attachments is not github.GithubObject.NotSet:
|
|
post_parameters["exclude_attachments"] = exclude_attachments
|
|
headers, data = self._requester.requestJsonAndCheck(
|
|
"POST",
|
|
f"/orgs/{self.login}/migrations",
|
|
input=post_parameters,
|
|
headers={"Accept": Consts.mediaTypeMigrationPreview},
|
|
)
|
|
return github.Migration.Migration(self._requester, headers, data, completed=True)
|
|
|
|
def get_migrations(self):
|
|
"""
|
|
:calls: `GET /orgs/{org}/migrations <https://docs.github.com/en/rest/reference/migrations#list-organization-migrations>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Migration.Migration`
|
|
"""
|
|
return github.PaginatedList.PaginatedList(
|
|
github.Migration.Migration,
|
|
self._requester,
|
|
f"/orgs/{self.login}/migrations",
|
|
None,
|
|
headers={"Accept": Consts.mediaTypeMigrationPreview},
|
|
)
|
|
|
|
def get_installations(self):
|
|
"""
|
|
:calls: `GET /orgs/{org}/installations <https://docs.github.com/en/rest/reference/orgs#list-app-installations-for-an-organization>`_
|
|
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Installation.Installation`
|
|
"""
|
|
|
|
return github.PaginatedList.PaginatedList(
|
|
github.Installation.Installation,
|
|
self._requester,
|
|
f"{self.url}/installations",
|
|
None,
|
|
None,
|
|
list_item="installations",
|
|
)
|
|
|
|
def _initAttributes(self) -> None:
|
|
self._default_repository_permission = github.GithubObject.NotSet
|
|
self._has_organization_projects = github.GithubObject.NotSet
|
|
self._has_repository_projects = github.GithubObject.NotSet
|
|
self._hooks_url = github.GithubObject.NotSet
|
|
self._issues_url = github.GithubObject.NotSet
|
|
self._members_can_create_repositories = github.GithubObject.NotSet
|
|
self._two_factor_requirement_enabled = github.GithubObject.NotSet
|
|
self._avatar_url = github.GithubObject.NotSet
|
|
self._billing_email = github.GithubObject.NotSet
|
|
self._blog = github.GithubObject.NotSet
|
|
self._collaborators = github.GithubObject.NotSet
|
|
self._company = github.GithubObject.NotSet
|
|
self._created_at = github.GithubObject.NotSet
|
|
self._description = github.GithubObject.NotSet
|
|
self._disk_usage = github.GithubObject.NotSet
|
|
self._email = github.GithubObject.NotSet
|
|
self._events_url = github.GithubObject.NotSet
|
|
self._followers = github.GithubObject.NotSet
|
|
self._following = github.GithubObject.NotSet
|
|
self._gravatar_id = github.GithubObject.NotSet
|
|
self._html_url = github.GithubObject.NotSet
|
|
self._id = github.GithubObject.NotSet
|
|
self._location = github.GithubObject.NotSet
|
|
self._login = github.GithubObject.NotSet
|
|
self._members_url = github.GithubObject.NotSet
|
|
self._name = github.GithubObject.NotSet
|
|
self._owned_private_repos = github.GithubObject.NotSet
|
|
self._plan = github.GithubObject.NotSet
|
|
self._private_gists = github.GithubObject.NotSet
|
|
self._public_gists = github.GithubObject.NotSet
|
|
self._public_members_url = github.GithubObject.NotSet
|
|
self._public_repos = github.GithubObject.NotSet
|
|
self._repos_url = github.GithubObject.NotSet
|
|
self._total_private_repos = github.GithubObject.NotSet
|
|
self._type = github.GithubObject.NotSet
|
|
self._updated_at = github.GithubObject.NotSet
|
|
self._url = github.GithubObject.NotSet
|
|
|
|
def _useAttributes(self, attributes: dict[str, Any]) -> None:
|
|
if "avatar_url" in attributes: # pragma no branch
|
|
self._avatar_url = self._makeStringAttribute(attributes["avatar_url"])
|
|
if "billing_email" in attributes: # pragma no branch
|
|
self._billing_email = self._makeStringAttribute(attributes["billing_email"])
|
|
if "blog" in attributes: # pragma no branch
|
|
self._blog = self._makeStringAttribute(attributes["blog"])
|
|
if "collaborators" in attributes: # pragma no branch
|
|
self._collaborators = self._makeIntAttribute(attributes["collaborators"])
|
|
if "company" in attributes: # pragma no branch
|
|
self._company = self._makeStringAttribute(attributes["company"])
|
|
if "created_at" in attributes: # pragma no branch
|
|
self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
|
|
if "default_repository_permission" in attributes: # pragma no branch
|
|
self._default_repository_permission = self._makeStringAttribute(attributes["default_repository_permission"])
|
|
if "description" in attributes: # pragma no branch
|
|
self._description = self._makeStringAttribute(attributes["description"])
|
|
if "disk_usage" in attributes: # pragma no branch
|
|
self._disk_usage = self._makeIntAttribute(attributes["disk_usage"])
|
|
if "email" in attributes: # pragma no branch
|
|
self._email = self._makeStringAttribute(attributes["email"])
|
|
if "events_url" in attributes: # pragma no branch
|
|
self._events_url = self._makeStringAttribute(attributes["events_url"])
|
|
if "followers" in attributes: # pragma no branch
|
|
self._followers = self._makeIntAttribute(attributes["followers"])
|
|
if "following" in attributes: # pragma no branch
|
|
self._following = self._makeIntAttribute(attributes["following"])
|
|
if "gravatar_id" in attributes: # pragma no branch
|
|
self._gravatar_id = self._makeStringAttribute(attributes["gravatar_id"])
|
|
if "has_organization_projects" in attributes: # pragma no branch
|
|
self._has_organization_projects = self._makeBoolAttribute(attributes["has_organization_projects"])
|
|
if "has_repository_projects" in attributes: # pragma no branch
|
|
self._has_repository_projects = self._makeBoolAttribute(attributes["has_repository_projects"])
|
|
if "hooks_url" in attributes: # pragma no branch
|
|
self._hooks_url = self._makeStringAttribute(attributes["hooks_url"])
|
|
if "html_url" in attributes: # pragma no branch
|
|
self._html_url = self._makeStringAttribute(attributes["html_url"])
|
|
if "id" in attributes: # pragma no branch
|
|
self._id = self._makeIntAttribute(attributes["id"])
|
|
if "issues_url" in attributes: # pragma no branch
|
|
self._issues_url = self._makeStringAttribute(attributes["issues_url"])
|
|
if "location" in attributes: # pragma no branch
|
|
self._location = self._makeStringAttribute(attributes["location"])
|
|
if "login" in attributes: # pragma no branch
|
|
self._login = self._makeStringAttribute(attributes["login"])
|
|
if "members_can_create_repositories" in attributes: # pragma no branch
|
|
self._members_can_create_repositories = self._makeBoolAttribute(
|
|
attributes["members_can_create_repositories"]
|
|
)
|
|
if "members_url" in attributes: # pragma no branch
|
|
self._members_url = self._makeStringAttribute(attributes["members_url"])
|
|
if "name" in attributes: # pragma no branch
|
|
self._name = self._makeStringAttribute(attributes["name"])
|
|
if "owned_private_repos" in attributes: # pragma no branch
|
|
self._owned_private_repos = self._makeIntAttribute(attributes["owned_private_repos"])
|
|
if "plan" in attributes: # pragma no branch
|
|
self._plan = self._makeClassAttribute(github.Plan.Plan, attributes["plan"])
|
|
if "private_gists" in attributes: # pragma no branch
|
|
self._private_gists = self._makeIntAttribute(attributes["private_gists"])
|
|
if "public_gists" in attributes: # pragma no branch
|
|
self._public_gists = self._makeIntAttribute(attributes["public_gists"])
|
|
if "public_members_url" in attributes: # pragma no branch
|
|
self._public_members_url = self._makeStringAttribute(attributes["public_members_url"])
|
|
if "public_repos" in attributes: # pragma no branch
|
|
self._public_repos = self._makeIntAttribute(attributes["public_repos"])
|
|
if "repos_url" in attributes: # pragma no branch
|
|
self._repos_url = self._makeStringAttribute(attributes["repos_url"])
|
|
if "total_private_repos" in attributes: # pragma no branch
|
|
self._total_private_repos = self._makeIntAttribute(attributes["total_private_repos"])
|
|
if "two_factor_requirement_enabled" in attributes: # pragma no branch
|
|
self._two_factor_requirement_enabled = self._makeBoolAttribute(attributes["two_factor_requirement_enabled"])
|
|
if "type" in attributes: # pragma no branch
|
|
self._type = self._makeStringAttribute(attributes["type"])
|
|
if "updated_at" in attributes: # pragma no branch
|
|
self._updated_at = self._makeDatetimeAttribute(attributes["updated_at"])
|
|
if "url" in attributes: # pragma no branch
|
|
self._url = self._makeStringAttribute(attributes["url"])
|