Skip to content

Commit 7e614e8

Browse files
Praneet460rysteboe
authored andcommitted
Update Readme
1 parent bd75dbf commit 7e614e8

File tree

1 file changed

+35
-17
lines changed

1 file changed

+35
-17
lines changed

README.md

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -78,21 +78,26 @@ commands:
7878
##### List competitions
7979

8080
```
81-
usage: kaggle competitions list [-h] [-p PAGE] [-s SEARCH] [-v]
81+
usage: kaggle competitions list [-h] [--group GROUP] [--category CATEGORY] [--sort-by SORT_BY] [-p PAGE] [-s SEARCH] [-v]
8282
8383
optional arguments:
8484
-h, --help show this help message and exit
85-
-p PAGE, --page PAGE page number
85+
--group GROUP Search for competitions in a specific group. Default is 'general'. Valid options are 'general', 'entered', and 'inClass'
86+
--category CATEGORY Search for competitions of a specific category. Default is 'all'. Valid options are 'all', 'featured', 'research', 'recruitment', 'gettingStarted', 'masters', and 'playground'
87+
--sort-by SORT_BY Sort list results. Default is 'latestDeadline'. Valid options are 'grouped', 'prize', 'earliestDeadline', 'latestDeadline', 'numberOfTeams', and 'recentlyCreated'
88+
-p PAGE, --page PAGE Page number for results paging. Page size is 20 by default
8689
-s SEARCH, --search SEARCH
87-
term(s) to search for
88-
-v, --csv print in CSV format
90+
Term(s) to search for
91+
-v, --csv Print results in CSV format
8992
(if not set print in table format)
9093
```
9194

9295
Example:
9396

9497
`kaggle competitions list -s health`
9598

99+
`kaggle competitions list --category gettingStarted`
100+
96101
##### List competition files
97102

98103
```
@@ -210,38 +215,48 @@ The API supports the following commands for Kaggle Datasets.
210215

211216
```
212217
usage: kaggle datasets [-h]
213-
{list,files,download,create,version,init,metadata} ...
218+
{list,files,download,create,version,init,metadata, status} ...
214219
215220
optional arguments:
216221
-h, --help show this help message and exit
217222
218223
commands:
219-
{list,files,download,create,version,init,metadata}
224+
{list,files,download,create,version,init,metadata, status}
220225
list List available datasets
221226
files List dataset files
222227
download Download dataset files
223228
create Create a new dataset
224229
version Create a new dataset version
225230
init Initialize metadata file for dataset creation
226231
metadata Download metadata about a dataset
232+
status Get the creation status for a dataset
227233
```
228234

229235
##### List datasets
230236

231237
```
232-
usage: kaggle datasets list [-h] [-p PAGE] [-s SEARCH] [-v]
238+
usage: kaggle datasets list [-h] [--sort-by SORT_BY] [--size SIZE] [--file-type FILE_TYPE] [--license LICENSE_NAME] [--tags TaG_IDS] [-s SEARCH] [-m] [--user USER] [-p PAGE] [-v]
233239
234240
optional arguments:
235241
-h, --help show this help message and exit
236-
-p PAGE, --page PAGE Page number for results paging
242+
--sort-by SORT_BY Sort list results. Default is 'hottest'. Valid options are 'hottest', 'votes', 'updated', and 'active'
243+
--size SIZE Search for datasets of a specific size. Default is 'all'. Valid options are 'all', 'small', 'medium', and 'large'
244+
--file-type FILE_TYPE Search for datasets with a specific file type. Default is 'all'. Valid options are 'all', 'csv', 'sqlite', 'json', and 'bigQuery'. Please note that bigQuery datasets cannot be downloaded
245+
--license LICENSE_NAME
246+
Search for datasets with a specific license. Default is 'all'. Valid options are 'all', 'cc', 'gpl', 'odb', and 'other'
247+
--tags TAG_IDS Search for datasets that have specific tags. Tag list should be comma separated
237248
-s SEARCH, --search SEARCH
238249
Term(s) to search for
250+
-m, --mine Display only my items
251+
--user USER Find public datasets owned by a specific user or organization
252+
-p PAGE, --page PAGE Page number for results paging. Page size is 20 by default
239253
-v, --csv Print results in CSV format (if not set print in table format)
240254
```
241255

242256
Example:
243257

244258
`kaggle datasets list -s demographics`
259+
`kaggle datasets list --sort-by votes`
245260

246261
##### List files for a dataset
247262

@@ -307,7 +322,7 @@ Example:
307322
If you want to create a new dataset, you need to initiate metadata file at first. You could fulfill this by running `kaggle datasets init` as describe above.
308323

309324
```
310-
usage: kaggle datasets create [-h] [-p FOLDER] [-u] [-q] [-t]
325+
usage: kaggle datasets create [-h] [-p FOLDER] [-u] [-q] [-t] [-r {skip,zip,tar}]
311326
312327
optional arguments:
313328
-h, --help show this help message and exit
@@ -328,7 +343,7 @@ Example:
328343

329344
```
330345
usage: kaggle datasets version [-h] -m VERSION_NOTES [-p FOLDER] [-q] [-t]
331-
[-d]
346+
[-r {skip,zip,tar}] [-d]
332347
333348
required arguments:
334349
-m VERSION_NOTES, --message VERSION_NOTES
@@ -405,17 +420,18 @@ commands:
405420
##### List kernels
406421

407422
```
408-
usage: kaggle kernels list [-h] [-m] [-p PAGE] [-s SEARCH] [-v]
423+
usage: kaggle kernels list [-h] [-m] [-p PAGE] [--page-size PAGE_SIZE] [-s SEARCH] [-v]
409424
[--parent PARENT] [--competition COMPETITION]
410-
[--dataset DATASET] [--parent-kernel PARENT_KERNEL]
425+
[--dataset DATASET]
411426
[--user USER] [--language LANGUAGE]
412427
[--kernel-type KERNEL_TYPE]
413428
[--output-type OUTPUT_TYPE] [--sort-by SORT_BY]
414429
415430
optional arguments:
416431
-h, --help show this help message and exit
417432
-m, --mine Display only my items
418-
-p PAGE, --page PAGE Page number for results paging
433+
-p PAGE, --page PAGE Page number for results paging. Page size is 20 by default
434+
--page-size PAGE_SIZE Number of items to show on a page. Default size is 20, max is 100
419435
-s SEARCH, --search SEARCH
420436
Term(s) to search for
421437
-v, --csv Print results in CSV format (if not set print in table format)
@@ -424,18 +440,20 @@ optional arguments:
424440
Find kernels for a given competition
425441
--dataset DATASET Find kernels for a given dataset
426442
--user USER Find kernels created by a given user
427-
--language LANGUAGE Specify the language the kernel is written in. Valid options are 'all', 'python', 'r', 'sqlite', and 'julia'
443+
--language LANGUAGE Specify the language the kernel is written in. Default is 'all'. Valid options are 'all', 'python', 'r', 'sqlite', and 'julia'
428444
--kernel-type KERNEL_TYPE
429-
Specify the type of kernel. Valid options are 'all', 'script', and 'notebook'
445+
Specify the type of kernel. Default is 'all'. Valid options are 'all', 'script', and 'notebook'
430446
--output-type OUTPUT_TYPE
431-
Search for specific kernel output types. Valid options are 'all', 'visualizations', and 'data'
432-
--sort-by SORT_BY Sort list results. Valid options are 'hotness', 'commentCount', 'dateCreated', 'dateRun', 'relevance', 'scoreAscending', 'scoreDescending', 'viewCount', and 'voteCount'. 'relevance' is only applicable ifa search term is specified.
447+
Search for specific kernel output types. Default is 'all'. Valid options are 'all', 'visualizations', and 'data'
448+
--sort-by SORT_BY Sort list results. Default is 'hotness'. Valid options are 'hotness', 'commentCount', 'dateCreated', 'dateRun', 'relevance', 'scoreAscending', 'scoreDescending', 'viewCount', and 'voteCount'. 'relevance' is only applicable if a search term is specified.
433449
```
434450

435451
Example:
436452

437453
`kaggle kernels list -s titanic`
438454

455+
`kaggle kernels list --language python`
456+
439457
##### Initialize metadata file for a kernel
440458

441459
```

0 commit comments

Comments
 (0)