forked from ask/python-github2
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathusers.py
More file actions
88 lines (67 loc) · 2.97 KB
/
users.py
File metadata and controls
88 lines (67 loc) · 2.97 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
from github2.core import BaseData, GithubCommand, Attribute
import urllib.request, urllib.parse, urllib.error
class User(BaseData):
id = Attribute("The user id")
login = Attribute("The login username")
name = Attribute("The users full name")
company = Attribute("Name of the company the user is associated with")
location = Attribute("Location of the user")
email = Attribute("The users e-mail address")
blog = Attribute("The users blog")
following_count = Attribute("Number of other users the user is following")
followers_count = Attribute("Number of users following this user")
public_gist_count = Attribute(
"Number of active public gists owned by the user")
public_repo_count = Attribute(
"Number of active repositories owned by the user")
total_private_repo_count = Attribute("Number of private repositories")
collaborators = Attribute("Number of collaborators")
disk_usage = Attribute("Currently used disk space")
owned_private_repo_count = Attribute("Number of privately owned repos")
private_gist_count = Attribute(
"Number of private gists owned by the user")
plan = Attribute("Current active github plan")
def is_authenticated(self):
"""Test for user auththenication
:return bool: ``True`` if user is authenticated"""
return self.plan is not None
def __repr__(self):
return "<User: %s>" % (self.login)
class Users(GithubCommand):
domain = "user"
def search(self, query):
"""Search for users
:param str query: term to search for
"""
return self.get_values("search", urllib.parse.quote_plus(query),
filter="users", datatype=User)
def search_by_email(self, query):
"""Search for users by email address
:param str query: email to search for
"""
return self.get_value("email", query, filter="user", datatype=User)
def show(self, username):
"""Get information on Github user
:param str username: Github user name
"""
return self.get_value("show", username, filter="user", datatype=User)
def followers(self, username):
"""Get list of Github user's followers
:param str username: Github user name
"""
return self.make_request("show", username, "followers", filter="users")
def following(self, username):
"""Get list of users a Github user is following
:param str username: Github user name
"""
return self.make_request("show", username, "following", filter="users")
def follow(self, other_user):
"""Follow a Github user
:param str other_user: Github user name
"""
return self.make_request("follow", other_user)
def unfollow(self, other_user):
"""Unfollow a Github user
:param str other_user: Github user name
"""
return self.make_request("unfollow", other_user)