aboutsummaryrefslogtreecommitdiffstats
path: root/docs/users.rst
blob: 139d726277694f9946783f6e4ea5aac5ac6b7a8e (plain) (blame)
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
.. _Users service:

Users services
===============

**Fast sample**::

    from pygithub3 import Github

    auth = dict(login='octocat', password='pass')
    gh = Github(**auth)

    # Get copitux user
    gh.users.get('copitux')

    # Get copitux's followers
    gh.users.followers.list('copitux')

    # Get octocat's emails
    gh.users.emails.list()

User
--------

.. autoclass:: pygithub3.services.users.User
    :members:

    .. attribute:: emails

        :ref:`Emails service`
    .. attribute:: keys

        :ref:`Keys service`
    .. attribute:: followers

        :ref:`Followers service`

.. _Emails service:

Emails
--------

.. autoclass:: pygithub3.services.users.Emails
    :members:

.. _Keys service:

Keys
------

.. autoclass:: pygithub3.services.users.Keys
    :members:

.. _Followers service:

Followers
-----------

.. autoclass:: pygithub3.services.users.Followers
    :members: