aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/orgs/__init__.py
blob: 8499719052dbf43b1f39248d5fcde41b61bf036f (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
# -*- encoding: utf-8 -*-

from pygithub3.services.base import Service
from .members import Members
from .teams import Teams


class Org(Service):
    """ Consume `Orgs API <http://developer.github.com/v3/orgs>`_ """

    def __init__(self, **config):
        self.members = Members(**config)
        self.teams = Teams(**config)
        super(Org, self).__init__(**config)

    def list(self, user=None):
        """ Get user's orgs

        :param str user: Username
        :returns: A :doc:`result`

        If you call it without user and you are authenticated, get the
        authenticated user's orgs, public and private.

        If you call it with a user, get the user's public orgs.

        ::

            org_service.list('copitux')
            org_service.list()
        """
        request = self.request_builder('orgs.list', user=user)
        return self._get_result(request)

    def get(self, org):
        """ Get a single org

        :param str org: Org name
        """
        request = self.request_builder('orgs.get', org=org)
        return self._get(request)

    def update(self, org, data):
        """ Update a single org

        :param str org: Org name
        :param dict data: Input. See `github orgs doc`_

        .. warning ::
            You must be authenticated

        ::

            org_service.update(dict(company='ACME Development',
                                    location='Timbuctoo'))
        """
        request = self.request_builder('orgs.update', org=org, body=data)
        return self._patch(request)