Skip to content
Navigation Menu
{{ message }}
forked from sigmavirus24/github3.py
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathorgs.py
More file actions
1672 lines (1365 loc) · 53.3 KB
/
Copy pathorgs.py
File metadata and controls
1672 lines (1365 loc) · 53.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""This module contains all of the classes related to organizations."""
import typing as t
from json import dumps
from uritemplate import URITemplate
from . import models
from . import users
from .decorators import requires_auth
from .events import Event
from .projects import Project
from .repos import Repository
from .repos import ShortRepository
if t.TYPE_CHECKING:
from . import users as _users
class ShortRepositoryWithPermissions(ShortRepository):
class_name = "ShortRepositoryWithPermissions"
def _update_attributes(self, repo) -> None:
super()._update_attributes(repo)
self.permissions = repo["permissions"]
class _Team(models.GitHubCore):
"""Base class for Team representations."""
class_name = "_Team"
# Roles available to members on a team.
member_roles = frozenset(["member", "maintainer"])
filterable_member_roles = member_roles.union(["all"])
def _update_attributes(self, team):
self._api = team["url"]
self.id = team["id"]
self.members_urlt = URITemplate(team["members_url"])
self.name = team["name"]
self.permission = team["permission"]
self.privacy = team.get(
"privacy"
) # TODO: Re-record cassettes to ensure this exists
self.repositories_url = team["repositories_url"]
self.slug = team["slug"]
self.parent = None
parent = team.get("parent")
if parent:
self.parent = ShortTeam(parent, self)
def _repr(self):
return "<{s.class_name} [{s.name}]>".format(s=self)
@requires_auth
def add_or_update_membership(self, username, role="member"):
"""Add or update the user's membership in this team.
This returns a dictionary like so::
{
'state': 'pending',
'url': 'https://api.github.com/teams/...',
'role': 'member',
}
:param str username:
(required), login of user whose membership is being modified
:param str role:
(optional), the role the user should have once their membership
has been modified. Options: 'member', 'maintainer'. Default:
'member'
:returns:
dictionary of the invitation response
:rtype:
dict
"""
if role not in self.member_roles:
raise ValueError(
"'role' must be one of {}".format(
", ".join(sorted(self.member_roles))
)
)
data = {"role": role}
url = self._build_url("memberships", username, base_url=self._api)
return self._json(self._put(url, json=data), 200)
@requires_auth
def add_repository(self, repository, permission=""):
"""Add ``repository`` to this team.
If a permission is not provided, the team's default permission
will be assigned, by GitHub.
:param str repository:
(required), form: 'user/repo'
:param str permission:
(optional), ('pull', 'push', 'admin')
:returns:
True if successful, False otherwise
:rtype:
bool
"""
data = {}
if permission:
data = {"permission": permission}
url = self._build_url("repos", repository, base_url=self._api)
return self._boolean(self._put(url, data=dumps(data)), 204, 404)
@requires_auth
def delete(self):
"""Delete this team.
:returns:
True if successful, False otherwise
:rtype:
bool
"""
return self._boolean(self._delete(self._api), 204, 404)
@requires_auth
def edit(
self,
name: str,
permission: str = "",
parent_team_id: t.Optional[int] = None,
privacy: t.Optional[str] = None,
):
"""Edit this team.
:param str name:
(required), the new name of this team
:param str permission:
(optional), one of ('pull', 'push', 'admin')
.. deprecated:: 3.0.0
This was deprecated by the GitHub API.
:param int parent_team_id:
(optional), id of the parent team for this team
:param str privacy:
(optional), one of "closed" or "secret"
:returns:
True if successful, False otherwise
:rtype:
bool
"""
if name:
data: t.Dict[str, t.Union[str, int]] = {"name": name}
if permission:
data["permission"] = permission
if parent_team_id is not None:
data["parent_team_id"] = parent_team_id
if privacy in {"closed", "secret"}:
data["privacy"] = privacy
json = self._json(self._patch(self._api, data=dumps(data)), 200)
if json:
self._update_attributes(json)
return True
return False
@requires_auth
def has_repository(self, repository):
"""Check if this team has access to ``repository``.
:param str repository:
(required), form: 'user/repo'
:returns:
True if the team can access the repository, False otherwise
:rtype:
bool
"""
url = self._build_url("repos", repository, base_url=self._api)
return self._boolean(self._get(url), 204, 404)
@requires_auth
def members(self, role=None, number=-1, etag=None):
"""Iterate over the members of this team.
:param str role:
(optional), filter members returned by their role in the team.
Can be one of: ``"member"``, ``"maintainer"``, ``"all"``. Default:
``"all"``.
:param int number:
(optional), number of users to iterate over. Default: -1 iterates
over all values
:param str etag:
(optional), ETag from a previous request to the same endpoint
:returns:
generator of the members of this team
:rtype:
:class:`~github3.users.ShortUser`
"""
headers = {}
params = {}
if role in self.filterable_member_roles:
params["role"] = role
headers["Accept"] = "application/vnd.github.ironman-preview+json"
url = self._build_url("members", base_url=self._api)
return self._iter(
int(number),
url,
users.ShortUser,
params=params,
etag=etag,
headers=headers,
)
@requires_auth
def permissions_for(
self, repository: str
) -> ShortRepositoryWithPermissions:
headers = {"Accept": "application/vnd.github.v3.repository+json"}
url = self._build_url("repos", repository, base_url=self._api)
json = self._json(self._get(url, headers=headers), 200)
return ShortRepositoryWithPermissions(json, self)
@requires_auth
def repositories(self, number=-1, etag=None):
"""Iterate over the repositories this team has access to.
:param int number:
(optional), number of repos to iterate over. Default: -1 iterates
over all values
:param str etag:
(optional), ETag from a previous request to the same endpoint
:returns:
generator of repositories this team has access to
:rtype:
:class:`~github3.orgs.ShortRepositoryWithPermissions`
"""
url = self._build_url("repos", base_url=self._api)
return self._iter(
int(number),
url,
ShortRepositoryWithPermissions,
etag=etag,
)
@requires_auth
def membership_for(self, username):
"""Retrieve the membership information for the user.
:param str username:
(required), name of the user
:returns:
dictionary with the membership
:rtype:
dict
"""
url = self._build_url("memberships", username, base_url=self._api)
json = self._json(self._get(url), 200)
return json or {}
@requires_auth
def revoke_membership(self, username):
"""Revoke this user's team membership.
:param str username:
(required), name of the team member
:returns:
True if successful, False otherwise
:rtype:
bool
"""
url = self._build_url("memberships", username, base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
@requires_auth
def remove_repository(self, repository):
"""Remove ``repository`` from this team.
:param str repository:
(required), form: 'user/repo'
:returns:
True if successful, False otherwise
:rtype:
bool
"""
url = self._build_url("repos", repository, base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
class Team(_Team):
"""Object representing a team in the GitHub API.
In addition to the attributes on a :class:`~github3.orgs.ShortTeam` a Team
has the following attribute:
.. attribute:: created_at
A :class:`~datetime.datetime` instance representing the time and date
when this team was created.
.. attribute:: members_count
The number of members in this team.
.. attribute:: organization
A :class:`~github3.orgs.ShortOrganization` representing the
organization this team belongs to.
.. attribute:: repos_count
The number of repositories this team can access.
.. attribute:: updated_at
A :class:`~datetime.datetime` instance representing the time and date
when this team was updated.
Please see GitHub's `Team Documentation`_ for more information.
.. _Team Documentation:
http://developer.github.com/v3/orgs/teams/
"""
class_name = "Team"
def _update_attributes(self, team):
super()._update_attributes(team)
self.created_at = self._strptime(team["created_at"])
self.members_count = team["members_count"]
self.organization = ShortOrganization(team["organization"], self)
self.repos_count = team["repos_count"]
self.updated_at = self._strptime(team["updated_at"])
class ShortTeam(_Team):
"""Object representing a team in the GitHub API.
.. attribute:: id
Unique identifier for this team across all of GitHub.
.. attribute:: members_count
The number of members in this team.
.. attribute:: members_urlt
A :class:`~uritemplate.URITemplate` instance to either retrieve all
members in this team or to test if a user is a member.
.. attribute:: name
The human-readable name provided to this team.
.. attribute:: permission
The level of permissions this team has, e.g., ``push``, ``pull``,
or ``admin``.
.. attribute:: privacy
The privacy level of this team inside the organization.
.. attribute:: repos_count
The number of repositories this team can access.
.. attribute:: repositories_url
The URL of the resource to enumerate all repositories this team can
access.
.. attribute:: slug
The handle for this team or the portion you would use in an
at-mention after the ``/``, e.g., in ``@myorg/myteam`` the
slug is ``myteam``.
Please see GitHub's `Team Documentation`_ for more information.
.. _Team Documentation:
http://developer.github.com/v3/orgs/teams/
"""
class_name = "ShortTeam"
_refresh_to = Team
class _Organization(models.GitHubCore):
"""The :class:`Organization <Organization>` object.
Please see GitHub's `Organization Documentation`_ for more information.
.. _Organization Documentation:
http://developer.github.com/v3/orgs/
"""
class_name = "_Organization"
# Filters available when listing members. Note: ``"2fa_disabled"``
# is only available for organization owners.
members_filters = frozenset(["2fa_disabled", "all"])
# Roles available to members in an organization.
member_roles = frozenset(["admin", "member"])
filterable_member_roles = member_roles.union(["all"])
# Roles for invitations, see also:
# https://developer.github.com/v3/orgs/members/#create-organization-invitation
invitation_roles = frozenset(
["admin", "direct_member", "billing_manager"]
)
def _update_attributes(self, org):
self.avatar_url = org["avatar_url"]
self.description = org["description"]
self.events_url = org["events_url"]
self.hooks_url = org["hooks_url"]
self.id = org["id"]
self.issues_url = org["issues_url"]
self.login = org["login"]
self.members_url = org["members_url"]
self.public_members_urlt = URITemplate(org["public_members_url"])
self.repos_url = org["repos_url"]
self.url = self._api = org["url"]
self.type = "Organization"
def _repr(self):
display_name = ""
name = getattr(self, "name", None)
if name is not None:
display_name = f":{name}"
return "<{s.class_name} [{s.login}{display}]>".format(
s=self, display=display_name
)
@requires_auth
def add_or_update_membership(self, username, role="member"):
"""Add a member or update their role.
:param str username:
(required), user to add or update.
:param str role:
(optional), role to give to the user. Options are ``member``,
``admin``. Defaults to ``member``.
:returns:
the created or updated membership
:rtype:
:class:`~github3.orgs.Membership`
:raises:
ValueError if role is not a valid choice
"""
if role not in self.member_roles:
raise ValueError(
"'role' must be one of {}".format(
", ".join(sorted(self.member_roles))
)
)
data = {"role": role}
url = self._build_url(
"memberships", str(username), base_url=self._api
)
json = self._json(self._put(url, json=data), 200)
return self._instance_or_null(Membership, json)
@requires_auth
def add_repository(self, repository, team_id): # FIXME(jlk): add perms
"""Add ``repository`` to ``team``.
.. versionchanged:: 1.0
The second parameter used to be ``team`` but has been changed to
``team_id``. This parameter is now required to be an integer to
improve performance of this method.
:param str repository:
(required), form: 'user/repo'
:param int team_id:
(required), team id
:returns:
True if successful, False otherwise
:rtype:
bool
"""
if int(team_id) < 0:
return False
url = self._build_url(
"organizations",
str(self.id),
"team",
str(team_id),
"repos",
str(repository),
)
return self._boolean(self._put(url), 204, 404)
@requires_auth
def blocked_users(
self, number: int = -1, etag: t.Optional[str] = None
) -> t.Generator[users.ShortUser, None, None]:
"""Iterate over the users blocked by this organization.
.. versionadded:: 2.1.0
:param int number:
(optional), number of users to iterate over. Default: -1 iterates
over all values
:param str etag:
(optional), ETag from a previous request to the same endpoint
:returns:
generator of the members of this team
:rtype:
:class:`~github3.users.ShortUser`
"""
url = self._build_url("blocks", base_url=self._api)
return self._iter(int(number), url, users.ShortUser, etag=etag)
@requires_auth
def block(self, username: users.UserLike) -> bool:
"""Block a specific user from an organization.
.. versionadded:: 2.1.0
:parameter str username:
Name (or user-like instance) of the user to block.
:returns:
True if successful, Fales otherwise
:rtype:
bool
"""
url = self._build_url("blocks", str(username), base_url=self._api)
return self._boolean(self._put(url), 204, 404)
@requires_auth
def unblock(self, username: users.UserLike) -> bool:
"""Unblock a specific user from an organization.
.. versionadded:: 2.1.0
:parameter str username:
Name (or user-like instance) of the user to unblock.
:returns:
True if successful, Fales otherwise
:rtype:
bool
"""
url = self._build_url("blocks", str(username), base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
@requires_auth
def is_blocking(self, username: users.UserLike) -> bool:
"""Check if this organization is blocking a specific user.
.. versionadded:: 2.1.0
:parameter str username:
Name (or user-like instance) of the user to unblock.
:returns:
True if successful, Fales otherwise
:rtype:
bool
"""
url = self._build_url("blocks", str(username), base_url=self._api)
return self._boolean(self._get(url), 204, 404)
@requires_auth
def create_hook(self, name, config, events=["push"], active=True):
"""Create a hook on this organization.
:param str name:
(required), name of the hook
:param dict config:
(required), key-value pairs which act as settings for this hook
:param list events:
(optional), events the hook is triggered for
:param bool active:
(optional), whether the hook is actually triggered
:returns:
the created hook
:rtype:
:class:`~github3.orgs.OrganizationHook`
"""
json = None
if name and config and isinstance(config, dict):
url = self._build_url("hooks", base_url=self._api)
data = {
"name": name,
"config": config,
"events": events,
"active": active,
}
json = self._json(self._post(url, data=data), 201)
return OrganizationHook(json, self) if json else None
@requires_auth
def create_project(self, name, body=""):
"""Create a project for this organization.
If the client is authenticated and a member of the organization, this
will create a new project in the organization.
:param str name:
(required), name of the project
:param str body:
(optional), the body of the project
:returns:
the new project
:rtype:
:class:`~github3.projects.Project`
"""
url = self._build_url("projects", base_url=self._api)
data = {"name": name, "body": body}
json = self._json(
self._post(url, data, headers=Project.CUSTOM_HEADERS), 201
)
return self._instance_or_null(Project, json)
@requires_auth
def create_repository(
self,
name,
description="",
homepage="",
private=False,
has_issues=True,
has_wiki=True,
team_id=0,
auto_init=False,
gitignore_template="",
license_template="",
has_projects=True,
):
"""Create a repository for this organization.
If the client is authenticated and a member of the organization, this
will create a new repository in the organization.
``name`` should be no longer than 100 characters
:param str name:
(required), name of the repository
.. warning:: this should be no longer than 100 characters
:param str description:
(optional)
:param str homepage:
(optional)
:param bool private:
(optional), If ``True``, create a private repository. API default:
``False``
:param bool has_issues:
(optional), If ``True``, enable issues for this repository. API
default: ``True``
:param bool has_wiki:
(optional), If ``True``, enable the wiki for this repository. API
default: ``True``
:param int team_id:
(optional), id of the team that will be granted access to this
repository
:param bool auto_init:
(optional), auto initialize the repository.
:param str gitignore_template:
(optional), name of the template; this is ignored if auto_int is
False.
:param str license_template:
(optional), name of the license; this is ignored if auto_int is
False.
:param bool has_projects:
(optional), If ``True``, enable projects for this repository. API
default: ``True``
:returns:
the created repository
:rtype:
:class:`~github3.repos.Repository`
"""
url = self._build_url("repos", base_url=self._api)
data = {
"name": name,
"description": description,
"homepage": homepage,
"private": private,
"has_issues": has_issues,
"has_wiki": has_wiki,
"license_template": license_template,
"auto_init": auto_init,
"gitignore_template": gitignore_template,
"has_projects": has_projects,
}
if int(team_id) > 0:
data.update({"team_id": team_id})
json = self._json(self._post(url, data), 201)
return self._instance_or_null(Repository, json)
@requires_auth
def conceal_member(self, username):
"""Conceal ``username``'s membership in this organization.
:param str username:
username of the organization member to conceal
:returns:
True if successful, False otherwise
:rtype:
bool
"""
url = self._build_url("public_members", username, base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
@requires_auth
def create_team(
self,
name: str,
repo_names: t.Optional[t.Sequence[str]] = [],
maintainers: t.Optional[
t.Union[t.Sequence[str], t.Sequence["_users._User"]]
] = [],
permission: str = "pull",
parent_team_id: t.Optional[int] = None,
privacy: str = "secret",
):
"""Create a new team and return it.
This only works if the authenticated user owns this organization.
:param str name:
(required), name to be given to the team
:param list repo_names:
(optional) repositories, e.g. ['github/dotfiles']
:param list maintainers:
(optional) list of usernames who will be maintainers
:param str permission:
(optional), options:
- ``pull`` -- (default) members can not push or administer
repositories accessible by this team
- ``push`` -- members can push and pull but not administer
repositories accessible by this team
- ``admin`` -- members can push, pull and administer
repositories accessible by this team
:param int parent_team_id:
(optional), the ID of a team to set as the parent team.
:param str privacy:
(optional), options:
- ``secret`` -- (default) only visible to organization
owners and members of this team
- ``closed`` -- visible to all members of this organization
:returns:
the created team
:rtype:
:class:`~github3.orgs.Team`
"""
data: t.Dict[str, t.Union[t.List[str], str, int]] = {
"name": name,
"repo_names": [
getattr(r, "full_name", r) for r in (repo_names or [])
],
"maintainers": [
getattr(m, "login", m) for m in (maintainers or [])
],
"permission": permission,
"privacy": privacy,
}
if parent_team_id:
data.update({"parent_team_id": parent_team_id})
url = self._build_url("teams", base_url=self._api)
json = self._json(self._post(url, data), 201)
return self._instance_or_null(Team, json)
@requires_auth
def edit(
self,
billing_email=None,
company=None,
email=None,
location=None,
name=None,
description=None,
has_organization_projects=None,
has_repository_projects=None,
default_repository_permission=None,
members_can_create_repositories=None,
):
"""Edit this organization.
:param str billing_email:
(optional) Billing email address (private)
:param str company:
(optional)
:param str email:
(optional) Public email address
:param str location:
(optional)
:param str name:
(optional)
:param str description:
(optional) The description of the company.
:param bool has_organization_projects:
(optional) Toggles whether organization projects are enabled for
the organization.
:param bool has_repository_projects:
(optional) Toggles whether repository projects are enabled for
repositories that belong to the organization.
:param string default_repository_permission:
(optional) Default permission level members have for organization
repositories:
- ``read`` -- (default) can pull, but not push to or administer
this repository.
- ``write`` -- can pull and push, but not administer this
repository.
- ``admin`` -- can pull, push, and administer this repository.
- ``none`` -- no permissions granted by default.
:param bool members_can_create_repositories:
(optional) Toggles ability of non-admin organization members to
create repositories:
- ``True`` -- (default) all organization members can create
repositories.
- ``False`` -- only admin members can create repositories.
:returns:
True if successful, False otherwise
:rtype:
bool
"""
json = None
data = {
"billing_email": billing_email,
"company": company,
"email": email,
"location": location,
"name": name,
"description": description,
"has_organization_projects": has_organization_projects,
"has_repository_projects": has_repository_projects,
"default_repository_permission": default_repository_permission,
"members_can_create_repositories": members_can_create_repositories,
}
self._remove_none(data)
if data:
json = self._json(self._patch(self._api, data=dumps(data)), 200)
if json:
self._update_attributes(json)
return True
return False
@requires_auth
def hook(self, hook_id):
"""Get a single hook.
:param int hook_id:
(required), id of the hook
:returns:
the hook
:rtype:
:class:`~github3.orgs.OrganizationHook`
"""
json = None
if int(hook_id) > 0:
url = self._build_url("hooks", str(hook_id), base_url=self._api)
json = self._json(self._get(url), 200)
return self._instance_or_null(OrganizationHook, json)
@requires_auth
def hooks(self, number=-1, etag=None):
"""Iterate over hooks registered on this organization.
:param int number:
(optional), number of hoks to return. Default: -1
returns all hooks
:param str etag:
(optional), ETag from a previous request to the same endpoint
:returns:
generator of hooks
:rtype:
:class:`~github3.orgs.OrganizationHook`
"""
url = self._build_url("hooks", base_url=self._api)
return self._iter(int(number), url, OrganizationHook, etag=etag)
@requires_auth
def invite(
self, team_ids, invitee_id=None, email=None, role="direct_member"
):
"""Invite the user to join this organization.
:param list[int] team_ids:
(required), list of team identifiers to invite the user to
:param int invitee_id:
(required if email is not specified), the identifier for the user
being invited
:param str email:
(required if invitee_id is not specified), the email address of
the user being invited
:param str role:
(optional) role to provide to the invited user. Must be one of
:returns:
the created invitation
:rtype:
:class:`~github3.orgs.Invitation`
"""
if (invitee_id is None and email is None) or (
invitee_id is not None and email is not None
):
raise ValueError(
"One of either 'invitee_id' or 'email' must be specified"
)
if not team_ids:
raise ValueError(
"'team_ids' must be a non-empty list of integers"
)
data = {"team_ids": team_ids}
if invitee_id is not None:
data["invitee_id"] = invitee_id
else:
data["email"] = email
if role not in self.invitation_roles:
raise ValueError(
"'role' must be one of {}".format(
", ".join(sorted(self.invitation_roles))
)
)
headers = {"Accept": "application/vnd.github.dazzler-preview.json"}
data["role"] = role
url = self._build_url("invitations", base_url=self._api)
json = self._json(self._post(url, data=data, headers=headers), 200)
return self._instance_or_null(Invitation, json)
@requires_auth
def cancel_invite(self, invitee_id):
"""Cancel the invitation using ``invitee_id``
of the user from the organization.
:param int invitee_id:
the identifier for the user being invited, to cancel its invitation
:returns: bool
"""
url = self._build_url("invitations", invitee_id, base_url=self._api)
return self._boolean(self._delete(url), 204, 404)
@requires_auth
def failed_invitations(self):
"""List failed organization invitations.
:returns: bool
"""
url = self._build_url("failed_invitations", base_url=self._api)
return self._json(self._get(url), 200, 404)
def is_member(self, username):
"""Check if the user named ``username`` is a member.
:param str username:
name of the user you'd like to check
:returns:
True if successful, False otherwise
:rtype:
bool
"""
url = self._build_url("members", username, base_url=self._api)
return self._boolean(self._get(url), 204, 404)
def is_public_member(self, username):
"""Check if the user named ``username`` is a public member.
:param str username:
name of the user you'd like to check
:returns:
True if the user is a public member, False otherwise
:rtype:
bool
"""
url = self._build_url("public_members", username, base_url=self._api)
return self._boolean(self._get(url), 204, 404)
def all_events(self, username, number=-1, etag=None):
"""Iterate over all org events visible to the authenticated user.
:param str username:
(required), the username of the currently authenticated user.
:param int number:
(optional), number of events to return. Default: -1 iterates over
all events available.
:param str etag:
(optional), ETag from a previous request to the same endpoint
:returns:
generator of events
:rtype:
:class:`~github3.events.Event`
"""
url = self._build_url("users", username, "events", "orgs", self.login)
return self._iter(int(number), url, Event, etag=etag)
def public_events(self, number=-1, etag=None):
"""Iterate over public events for this org.
:param int number:
(optional), number of events to return. Default: -1 iterates over
all events available.
:param str etag:
(optional), ETag from a previous request to the same
endpoint
:returns:
generator of public events
You can’t perform that action at this time.