aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/repos/downloads.py
blob: 25114a51462a6f10040b5bcfcae24ff934a8982e (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
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
#!/usr/bin/env python
# -*- encoding: utf-8 -*-

import requests

from . import Service


class Downloads(Service):
    """ Consume `Downloads API
    <http://developer.github.com/v3/repos/downloads>`_ """

    def list(self, user=None, repo=None):
        """ Get repository's downloads

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

        .. note::
            Remember :ref:`config precedence`
        """
        request = self.make_request('repos.downloads.list',
            user=user, repo=repo)
        return self._get_result(request)

    def get(self, id, user=None, repo=None):
        """ Get a single download

        :param int id: Download id
        :param str user: Username
        :param str repo: Repository

        .. note::
            Remember :ref:`config precedence`
        """
        request = self.make_request('repos.downloads.get',
            id=id, user=user, repo=repo)
        return self._get(request)

    def create(self, data, user=None, repo=None):
        """ Create a new download

        :param dict data: Input. See `github downloads doc`_
        :param str user: Username
        :param str repo: Repository

        .. note::
            Remember :ref:`config precedence`

        It is a two step process. After you create the download, you must
        call the ``upload`` function of ``Download`` resource with
        ``file_path``

        .. warning::
            In `alpha` state

        ::

            # Step 1
            download = downloads_service.create(
                dict(name='new_download', size=1130),
                user='octocat', repo='oct_repo')

            # Step 2
            download.upload('/home/user/file.ext')
        """
        request = self.make_request('repos.downloads.create',
            body=data, user=user, repo=repo)
        download = self._post(request)

        # TODO: improve it. e.g Manage all with file desc
        def upload(file_path):
            """ """
            data = download.ball_to_upload()
            files = {'File': open(file_path, 'rb')}
            return requests.post(download.s3_url, data=data, files=files)

        download.upload = upload
        return download

    def delete(self, id, user=None, repo=None):
        """ Delete a download

        :param int id: Download id
        :param str user: Username
        :param str repo: Repository

        .. note::
            Remember :ref:`config precedence`
        """
        request = self.make_request('repos.downloads.delete',
            id=id, user=user, repo=repo)
        self._delete(request)