Update API to 1.5.6

Author: Rebecca Ysteboe

CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 ====
 
+#### 1.5.6
+Release date: 9/19/19
+* Downloading all files for a competition downloads a zip instead of individual files
+
 #### 1.5.5
 Release date: 8/30/19
 * Add vote count and usability rating to datasets listing

KaggleSwagger.yaml

@@ -282,6 +282,27 @@ paths:
           description: Error
           schema:
             $ref: '#/definitions/Error'
+  /competitions/data/download-all/{id}:
+    get:
+      tags:
+        - kaggle
+      summary: Download all competition data files
+      operationId: CompetitionsDataDownloadFiles
+      parameters:
+        - in: path
+          name: id
+          required: true
+          type: string
+          description: Competition name
+      responses:
+        200:
+          description: Result
+          schema:
+            $ref: '#/definitions/Result'
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/Error'
   /competitions/{id}/leaderboard/download:
     get:
       tags:

kaggle/api/kaggle_api.py

@@ -324,6 +324,95 @@ def competitions_data_download_file_with_http_info(self, id, file_name, **kwargs
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def competitions_data_download_files(self, id, **kwargs):  # noqa: E501
+        """Download all competition data files  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.competitions_data_download_files(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str id: Competition name (required)
+        :return: Result
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.competitions_data_download_files_with_http_info(id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.competitions_data_download_files_with_http_info(id, **kwargs)  # noqa: E501
+            return data
+
+    def competitions_data_download_files_with_http_info(self, id, **kwargs):  # noqa: E501
+        """Download all competition data files  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.competitions_data_download_files_with_http_info(id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str id: Competition name (required)
+        :return: Result
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['id']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method competitions_data_download_files" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'id' is set
+        if ('id' not in params or
+                params['id'] is None):
+            raise ValueError("Missing the required parameter `id` when calling `competitions_data_download_files`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'id' in params:
+            path_params['id'] = params['id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # Authentication setting
+        auth_settings = ['basicAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/competitions/data/download-all/{id}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Result',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def competitions_data_list_files(self, id, **kwargs):  # noqa: E501
         """List competition data files  # noqa: E501
 

kaggle/api/kaggle_api_extended.py

@@ -66,7 +66,7 @@
 
 
 class KaggleApi(KaggleApi):
-    __version__ = '1.5.5'
+    __version__ = '1.5.6'
 
     CONFIG_NAME_PROXY = 'proxy'
     CONFIG_NAME_COMPETITION = 'competition'
@@ -682,8 +682,7 @@ def competition_download_files(self,
                                    path=None,
                                    force=False,
                                    quiet=True):
-        """ a wrapper to competition_download_file to download all competition
-            files.
+        """ downloads all competition files.
 
             Parameters
             =========
@@ -692,12 +691,21 @@ def competition_download_files(self,
             force: force the download if the file already exists (default False)
             quiet: suppress verbose output (default is True)
         """
-        files = self.competition_list_files(competition)
-        if not files:
-            print('This competition does not have any available data files')
-        for file_name in files:
-            self.competition_download_file(competition, file_name.ref, path,
-                                           force, quiet)
+        if path is None:
+            effective_path = self.get_default_download_dir(
+                'competitions', competition)
+        else:
+            effective_path = path
+
+        response = self.process_response(
+            self.competitions_data_download_files_with_http_info(
+                id=competition, _preload_content=False))
+        url = response.retries.history[0].redirect_location.split('?')[0]
+        outfile = os.path.join(effective_path,
+                               competition + '.' + url.split('.')[-1])
+
+        if force or self.download_needed(response, outfile, quiet):
+            self.download_file(response, outfile, quiet)
 
     def competition_download_cli(self,
                                  competition,

setup.py

@@ -19,7 +19,7 @@
 
 setup(
     name='kaggle',
-    version='1.5.5',
+    version='1.5.6',
     description='Kaggle API',
     long_description=
     ('Official API for https://www.kaggle.com, accessible using a command line '