Skip to content

Commit 94423e3

Browse files
authored
1.5.15 release (#482)
1 parent 0f4fec0 commit 94423e3

File tree

9 files changed

+114
-198
lines changed

9 files changed

+114
-198
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Changelog
22
====
33

4+
#### 1.5.15
5+
Release date: 6/30/23
6+
* Add missing licenses for datasets
7+
* Re-add option to pass dataset with `-d`
8+
* Download / list files for a specific version of a dataset
9+
* Documentation improvements
10+
411
#### 1.5.14
512
Release date: 6/29/23
613
* Show the full error message from the API

KaggleSwagger.yaml

Lines changed: 39 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,11 @@ paths:
440440
required: true
441441
type: string
442442
description: Dataset name
443+
- in: query
444+
name: datasetVersionNumber
445+
required: false
446+
type: string
447+
description: Dataset version number
443448
responses:
444449
200:
445450
description: Result
@@ -477,34 +482,6 @@ paths:
477482
description: Error
478483
schema:
479484
$ref: '#/definitions/Error'
480-
/datasets/view/{ownerSlug}/{datasetSlug}:
481-
get:
482-
tags:
483-
- kaggle
484-
summary: Show details about a dataset
485-
operationId: DatasetsView
486-
produces:
487-
- application/json
488-
parameters:
489-
- in: path
490-
name: ownerSlug
491-
required: true
492-
type: string
493-
description: Dataset owner
494-
- in: path
495-
name: datasetSlug
496-
required: true
497-
type: string
498-
description: Dataset name
499-
responses:
500-
200:
501-
description: Result
502-
schema:
503-
$ref: '#/definitions/Result'
504-
default:
505-
description: Error
506-
schema:
507-
$ref: '#/definitions/Error'
508485
/datasets/download/{ownerSlug}/{datasetSlug}:
509486
get:
510487
tags:
@@ -1562,6 +1539,23 @@ definitions:
15621539
- other
15631540
- reddit-api
15641541
- world-bank
1542+
- CC-BY-4.0
1543+
- CC-BY-NC-4.0
1544+
- PDDL
1545+
- CC-BY-3.0
1546+
- CC-BY-3.0-IGO
1547+
- US-Government-Works
1548+
- CC-BY-NC-SA-3.0-IGO
1549+
- CDLA-Permissive-1.0
1550+
- CDLA-Sharing-1.0
1551+
- CC-BY-ND-4.0
1552+
- CC-BY-NC-ND-4.0
1553+
- ODC-BY-1.0
1554+
- LGPL-3.0
1555+
- AGPL-3.0
1556+
- FDL-1.3
1557+
- EU-ODP-Legal-Notice
1558+
- apache-2.0
15651559
subtitle:
15661560
type: string
15671561
description: The subtitle to be set on the dataset
@@ -1723,6 +1717,23 @@ definitions:
17231717
- other
17241718
- reddit-api
17251719
- world-bank
1720+
- CC-BY-4.0
1721+
- CC-BY-NC-4.0
1722+
- PDDL
1723+
- CC-BY-3.0
1724+
- CC-BY-3.0-IGO
1725+
- US-Government-Works
1726+
- CC-BY-NC-SA-3.0-IGO
1727+
- CDLA-Permissive-1.0
1728+
- CDLA-Sharing-1.0
1729+
- CC-BY-ND-4.0
1730+
- CC-BY-NC-ND-4.0
1731+
- ODC-BY-1.0
1732+
- LGPL-3.0
1733+
- AGPL-3.0
1734+
- FDL-1.3
1735+
- EU-ODP-Legal-Notice
1736+
- apache-2.0
17261737
Collaborator:
17271738
type: object
17281739
required:

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The command line tool supports the following commands:
4646

4747
```
4848
kaggle competitions {list, files, download, submit, submissions, leaderboard}
49-
kaggle datasets {list, files, download, create, version, init}
49+
kaggle datasets {list, files, download, create, version, init, metadata, status}
5050
kaggle kernels {list, init, push, pull, output, status}
5151
kaggle models {get, list, init, create, delete, update}
5252
kaggle models instances {get, init, create, delete, update}
@@ -270,7 +270,7 @@ Example:
270270
usage: kaggle datasets files [-h] [-v] [dataset]
271271
272272
required arguments:
273-
dataset Dataset URL suffix in format <owner>/<dataset-name> (use "kaggle datasets list" to show options)
273+
dataset Dataset URL suffix in format <owner>/<dataset-name> (use "kaggle datasets list" to show options), or <owner>/<dataset-name>/<version-number> for a specific version
274274
275275
optional arguments:
276276
-h, --help show this help message and exit
@@ -281,6 +281,8 @@ Example:
281281

282282
`kaggle datasets files zillow/zecon`
283283

284+
`kaggle datasets files zillow/zecon/3`
285+
284286
##### Download dataset files
285287

286288
```
@@ -289,7 +291,7 @@ usage: kaggle datasets download [-h] [-f FILE_NAME] [-p PATH] [-w] [--unzip]
289291
[dataset]
290292
291293
required arguments:
292-
dataset Dataset URL suffix in format <owner>/<dataset-name> (use "kaggle datasets list" to show options)
294+
dataset Dataset URL suffix in format <owner>/<dataset-name> (use "kaggle datasets list" to show options), or <owner>/<dataset-name>/<version-number> for a specific version
293295
294296
optional arguments:
295297
-h, --help show this help message and exit
@@ -308,6 +310,8 @@ Examples:
308310

309311
`kaggle datasets download zillow/zecon`
310312

313+
`kaggle datasets download zillow/zecon/3`
314+
311315
`kaggle datasets download zillow/zecon -f State_time_series.csv`
312316

313317
Please note that BigQuery datasets cannot be downloaded.
@@ -481,7 +485,7 @@ optional arguments:
481485

482486
Example:
483487

484-
`kaggle kernels init -p /path/to/kernel`
488+
`kaggle kernels init -p /path/to/folder`
485489

486490
##### Push a kernel
487491

@@ -496,7 +500,7 @@ optional arguments:
496500

497501
Example:
498502

499-
`kaggle kernels push -p /path/to/kernel`
503+
`kaggle kernels push -p /path/to/folder`
500504

501505
##### Pull a kernel
502506

kaggle/api/kaggle_api.py

Lines changed: 5 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1732,6 +1732,7 @@ def datasets_list_files(self, owner_slug, dataset_slug, **kwargs): # noqa: E501
17321732
:param async_req bool
17331733
:param str owner_slug: Dataset owner (required)
17341734
:param str dataset_slug: Dataset name (required)
1735+
:param str dataset_version_number: Dataset version number
17351736
:return: Result
17361737
If the method is called asynchronously,
17371738
returns the request thread.
@@ -1754,12 +1755,13 @@ def datasets_list_files_with_http_info(self, owner_slug, dataset_slug, **kwargs)
17541755
:param async_req bool
17551756
:param str owner_slug: Dataset owner (required)
17561757
:param str dataset_slug: Dataset name (required)
1758+
:param str dataset_version_number: Dataset version number
17571759
:return: Result
17581760
If the method is called asynchronously,
17591761
returns the request thread.
17601762
"""
17611763

1762-
all_params = ['owner_slug', 'dataset_slug'] # noqa: E501
1764+
all_params = ['owner_slug', 'dataset_slug', 'dataset_version_number'] # noqa: E501
17631765
all_params.append('async_req')
17641766
all_params.append('_return_http_data_only')
17651767
all_params.append('_preload_content')
@@ -1792,6 +1794,8 @@ def datasets_list_files_with_http_info(self, owner_slug, dataset_slug, **kwargs)
17921794
path_params['datasetSlug'] = params['dataset_slug'] # noqa: E501
17931795

17941796
query_params = []
1797+
if 'dataset_version_number' in params:
1798+
query_params.append(('datasetVersionNumber', params['dataset_version_number'])) # noqa: E501
17951799

17961800
header_params = {}
17971801

@@ -2036,107 +2040,6 @@ def datasets_upload_file_with_http_info(self, file_name, content_length, last_mo
20362040
_request_timeout=params.get('_request_timeout'),
20372041
collection_formats=collection_formats)
20382042

2039-
def datasets_view(self, owner_slug, dataset_slug, **kwargs): # noqa: E501
2040-
"""Show details about a dataset # noqa: E501
2041-
2042-
This method makes a synchronous HTTP request by default. To make an
2043-
asynchronous HTTP request, please pass async_req=True
2044-
>>> thread = api.datasets_view(owner_slug, dataset_slug, async_req=True)
2045-
>>> result = thread.get()
2046-
2047-
:param async_req bool
2048-
:param str owner_slug: Dataset owner (required)
2049-
:param str dataset_slug: Dataset name (required)
2050-
:return: Result
2051-
If the method is called asynchronously,
2052-
returns the request thread.
2053-
"""
2054-
kwargs['_return_http_data_only'] = True
2055-
if kwargs.get('async_req'):
2056-
return self.datasets_view_with_http_info(owner_slug, dataset_slug, **kwargs) # noqa: E501
2057-
else:
2058-
(data) = self.datasets_view_with_http_info(owner_slug, dataset_slug, **kwargs) # noqa: E501
2059-
return data
2060-
2061-
def datasets_view_with_http_info(self, owner_slug, dataset_slug, **kwargs): # noqa: E501
2062-
"""Show details about a dataset # noqa: E501
2063-
2064-
This method makes a synchronous HTTP request by default. To make an
2065-
asynchronous HTTP request, please pass async_req=True
2066-
>>> thread = api.datasets_view_with_http_info(owner_slug, dataset_slug, async_req=True)
2067-
>>> result = thread.get()
2068-
2069-
:param async_req bool
2070-
:param str owner_slug: Dataset owner (required)
2071-
:param str dataset_slug: Dataset name (required)
2072-
:return: Result
2073-
If the method is called asynchronously,
2074-
returns the request thread.
2075-
"""
2076-
2077-
all_params = ['owner_slug', 'dataset_slug'] # noqa: E501
2078-
all_params.append('async_req')
2079-
all_params.append('_return_http_data_only')
2080-
all_params.append('_preload_content')
2081-
all_params.append('_request_timeout')
2082-
2083-
params = locals()
2084-
for key, val in six.iteritems(params['kwargs']):
2085-
if key not in all_params:
2086-
raise TypeError(
2087-
"Got an unexpected keyword argument '%s'"
2088-
" to method datasets_view" % key
2089-
)
2090-
params[key] = val
2091-
del params['kwargs']
2092-
# verify the required parameter 'owner_slug' is set
2093-
if ('owner_slug' not in params or
2094-
params['owner_slug'] is None):
2095-
raise ValueError("Missing the required parameter `owner_slug` when calling `datasets_view`") # noqa: E501
2096-
# verify the required parameter 'dataset_slug' is set
2097-
if ('dataset_slug' not in params or
2098-
params['dataset_slug'] is None):
2099-
raise ValueError("Missing the required parameter `dataset_slug` when calling `datasets_view`") # noqa: E501
2100-
2101-
collection_formats = {}
2102-
2103-
path_params = {}
2104-
if 'owner_slug' in params:
2105-
path_params['ownerSlug'] = params['owner_slug'] # noqa: E501
2106-
if 'dataset_slug' in params:
2107-
path_params['datasetSlug'] = params['dataset_slug'] # noqa: E501
2108-
2109-
query_params = []
2110-
2111-
header_params = {}
2112-
2113-
form_params = []
2114-
local_var_files = {}
2115-
2116-
body_params = None
2117-
# HTTP header `Accept`
2118-
header_params['Accept'] = self.api_client.select_header_accept(
2119-
['application/json']) # noqa: E501
2120-
2121-
# Authentication setting
2122-
auth_settings = ['basicAuth'] # noqa: E501
2123-
2124-
return self.api_client.call_api(
2125-
'/datasets/view/{ownerSlug}/{datasetSlug}', 'GET',
2126-
path_params,
2127-
query_params,
2128-
header_params,
2129-
body=body_params,
2130-
post_params=form_params,
2131-
files=local_var_files,
2132-
response_type='Result', # noqa: E501
2133-
auth_settings=auth_settings,
2134-
async_req=params.get('async_req'),
2135-
_return_http_data_only=params.get('_return_http_data_only'),
2136-
_preload_content=params.get('_preload_content', True),
2137-
_request_timeout=params.get('_request_timeout'),
2138-
collection_formats=collection_formats)
2139-
21402043
def delete_model(self, owner_slug, model_slug, **kwargs): # noqa: E501
21412044
"""Delete a model # noqa: E501
21422045

0 commit comments

Comments
 (0)