aboutsummaryrefslogtreecommitdiffstats
path: root/docs/services.rst
blob: 8611455a0b7e4ed02ed519e562dd0e0cecb74e36 (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
Services
==========

:doc:`github` class is a glue to all of them and the recommended option to
start

Overview
..........

You can access to the API requests through the different services.

If you take a look at
`github API v3 documentation <http://developer.github.com/>`_, you'll see a
few sections in the sidebar.

**pygithub3** has one service per each section of request-related

For example: ::

    repos => services.repos.repo
        collaborators => services.repos.collaborators
        commits => services.repos.commits
        ....

Each service has the functions to throw the API requests and **is isolated
from the rest**.

.. _config each service:

Config each service
.....................................

Each service can be configurated with some variables (behind the scenes, each
service has her client which is configurated with this variables).

.. note::

    Also you can configure :doc:`github` as a service

.. autoclass:: pygithub3.services.base.Service
    :members:

List of services
..................

.. toctree::
    :maxdepth: 2

    users
    repos