kaggle API
安装
确保安装了Python和软件包管理pip器。
运行以下命令以使用命令行访问Kaggle API：
pip install kaggle（您可能需要pip install –user kaggle在Mac / Linux上进行。如果在安装过程中出现问题，建议使用此方法。）通过root用户（即sudo pip install kaggle）完成的安装将无法正常工作，除非您了解自己在做什么。即便如此，他们仍然可能无法工作。强烈建议在权限错误的情况下安装用户。
您现在可以使用kaggle以下示例中所示的命令。
如果遇到kaggle: command not found错误，请确保您的python二进制文件在您的路径上。您可以kaggle通过执行pip uninstall kaggle和查看二进制文件的位置来查看安装位置。对于Linux上的本地用户安装，默认位置为~/.local/bin。在Windows上，默认位置为$PYTHON_HOME/Scripts。
API凭据
要使用Kaggle API，请在https://www.kaggle.com上注册Kaggle帐户。然后转到用户个人资料的“帐户”标签（https://www.kaggle.com//account），然后选择“创建API令牌”。这将触发下载kaggle.json包含您的API凭据的文件。将此文件放在该位置~/.kaggle/kaggle.json（在该位置的Windows上C:\Users\.kaggle\kaggle.json- 您可以检查确切的位置，没有驱动器，有echo %HOMEPATH%）。您可以定义一个shell环境变量KAGGLE_CONFIG_DIR来将此位置更改为$KAGGLE_CONFIG_DIR/kaggle.json（在Windows上它将是%KAGGLE_CONFIG_DIR%\kaggle.json）。
为了您的安全，请确保您计算机的其他用户没有您的凭据的读取权限。在基于Unix的系统上，您可以使用以下命令执行此操作：
chmod 600 ~/.kaggle/kaggle.json
您还可以选择将Kaggle用户名和令牌导出到环境中：
export KAGGLE_USER = datadinosaur
export KAGGLE_TOKEN = xxxxxxxxxxxxxx
此外，您可以导出通常以$HOME/.kaggle/kaggle.json“KAGGLE_”格式（注意大写）的任何其他配置值。
例如，如果文件具有变量“proxy”，则您将导出KAGGLE_PROXY 并由客户端发现它。
命令
命令行工具支持以下命令：
kaggle competitions {list,files,download,submit,submissions,leaderboard}
kaggle datasets {list, files, download, create, version, init}
kaggle config {view, set, unset}
有关使用其中每个命令的详细信息，请参阅
比赛
API支持Kaggle Competitions的以下命令。
usage: kaggle competitions [-h]
{list,files,download,submit,submissions,leaderboard}
…
optional arguments:
-h, –help show this help message and exit
commands:
{list,files,download,submit,submissions,leaderboard}
list List available competitions
files List competition files
download Download competition files
submit Make a new competition submission
submissions Show your competition submissions
leaderboard Get competition leaderboard information
列出比赛
usage: kaggle competitions list [-h] [-p PAGE] [-s SEARCH] [-v]
optional arguments:
-h, –help show this help message and exit
-p PAGE, –page PAGE page number
-s SEARCH, –search SEARCH
term(s) to search for
-v, –csv print in CSV format
(if not set print in table format)
例：
kaggle competitions list -s health
列出竞争文件
usage: kaggle competitions files [-h] [-v] [-q] [competition]
optional arguments:
-h, –help show this help message and exit
competition Competition URL suffix (use “kaggle competitions list” to show options)
If empty, the default competition will be used (use “kaggle config set competition”)”
-v, –csv Print results in CSV format (if not set print in table format)
-q, –quiet Suppress printing information about the upload/download progress
例：
kaggle competitions files favorita-grocery-sales-forecasting
下载竞赛文件
usage: kaggle competitions download [-h] [-f FILE_NAME] [-p PATH] [-w] [-o]
[-q]
[competition]
optional arguments:
-h, –help show this help message and exit
competition Competition URL suffix (use “kaggle competitions list” to show options)
If empty, the default competition will be used (use “kaggle config set competition”)”
-f FILE_NAME, –file FILE_NAME
File name, all files downloaded if not provided
(use “kaggle competitions files -c ” to show options)
-p PATH, –path PATH Folder where file(s) will be downloaded, defaults to current working directory
-w, –wp Download files to current working path
-o, –force Skip check whether local version of file is up to date, force file download
-q, –quiet Suppress printing information about the upload/download progress
例子：
kaggle competitions download favorita-grocery-sales-forecasting
kaggle competitions download favorita-grocery-sales-forecasting -f test.csv.7z
注意：您需要接受竞争规则https://www.kaggle.com/c//rules。
提交比赛
usage: kaggle competitions submit [-h] -f FILE_NAME -m MESSAGE [-q]
[competition]
required arguments:
-f FILE_NAME, –file FILE_NAME
File for upload (full path)
-m MESSAGE, –message MESSAGE
Message describing this submission
optional arguments:
-h, –help show this help message and exit
competition Competition URL suffix (use “kaggle competitions list” to show options)
If empty, the default competition will be used (use “kaggle config set competition”)”
-q, –quiet Suppress printing information about the upload/download progress
例：
kaggle competitions submit favorita-grocery-sales-forecasting -f sample_submission_favorita.csv.7z -m “My submission message”
注意：您需要接受竞争规则https://www.kaggle.com/c//rules。
列出竞争提交
usage: kaggle competitions submissions [-h] [-v] [-q] [competition]
optional arguments:
-h, –help show this help message and exit
competition Competition URL suffix (use “kaggle competitions list” to show options)
If empty, the default competition will be used (use “kaggle config set competition”)”
-v, –csv Print results in CSV format (if not set print in table format)
-q, –quiet Suppress printing information about the upload/download progress
例：
kaggle competitions submissions favorita-grocery-sales-forecasting
注意：您需要接受竞争规则https://www.kaggle.com/c//rules。
获得竞争排行榜
usage: kaggle competitions leaderboard [-h] [-s] [-d] [-p PATH] [-v] [-q]
[competition]
optional arguments:
-h, –help show this help message and exit
competition Competition URL suffix (use “kaggle competitions list” to show options)
If empty, the default competition will be used (use “kaggle config set competition”)”
-s, –show Show the top of the leaderboard
-d, –download Download entire leaderboard
-p PATH, –path PATH Folder where file(s) will be downloaded, defaults to current working directory
-v, –csv Print results in CSV format (if not set print in table format)
-q, –quiet Suppress printing information about the upload/download progress
例：
kaggle competitions leaderboard favorita-grocery-sales-forecasting -s
数据集
API支持以下用于Kaggle数据集的命令。
usage: kaggle datasets [-h]
{list,files,download,create,version,init,metadata} …
optional arguments:
-h, –help show this help message and exit
commands:
{list,files,download,create,version,init,metadata}
list List available datasets
files List dataset files
download Download dataset files
create Create a new dataset
version Create a new dataset version
init Initialize metadata file for dataset creation
metadata Download metadata about a dataset
列出数据集
usage: kaggle datasets list [-h] [-p PAGE] [-s SEARCH] [-v]
optional arguments:
-h, –help show this help message and exit
-p PAGE, –page PAGE Page number for results paging
-s SEARCH, –search SEARCH
Term(s) to search for
-v, –csv Print results in CSV format (if not set print in table format)
例：
kaggle datasets list -s demographics
列出数据集的文件
usage: kaggle datasets files [-h] [-v] [dataset]
optional arguments:
-h, –help show this help message and exit
dataset Dataset URL suffix in format / (use “kaggle datasets list” to show options)
-v, –csv Print results in CSV format (if not set print in table format)
例：
kaggle datasets files zillow/zecon
下载数据集文件
usage: kaggle datasets download [-h] [-f FILE_NAME] [-p PATH] [-w] [-o] [-q]
[dataset]
optional arguments:
-h, –help show this help message and exit
dataset Dataset URL suffix in format / (use “kaggle datasets list” to show options)
-f FILE_NAME, –file FILE_NAME
File name, all files downloaded if not provided
(use “kaggle datasets files -d ” to show options)
-p PATH, –path PATH Folder where file(s) will be downloaded, defaults to current working directory
-w, –wp Download files to current working path
-o, –force Skip check whether local version of file is up to date, force file download
-q, –quiet Suppress printing information about the upload/download progress
例子：
kaggle datasets download zillow/zecon
kaggle datasets download zillow/zecon -f State_time_series.csv
初始化元数据文件以创建数据集
usage: kaggle datasets init [-h] [-p FOLDER]
optional arguments:
-h, –help show this help message and exit
-p FOLDER, –path FOLDER
Folder for upload, containing data files and a special dataset-metadata.json file (https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata). Defaults to current working directory
例：
kaggle datasets init -p /path/to/dataset
创建一个新数据集
usage: kaggle datasets create [-h] [-p FOLDER] [-u] [-q] [-t]
optional arguments:
-h, –help show this help message and exit
-p FOLDER, –path FOLDER
Folder for upload, containing data files and a special dataset-metadata.json file (https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata). Defaults to current working directory
-u, –public Create publicly (default is private)
-q, –quiet Suppress printing information about the upload/download progress
-t, –keep-tabular Do not convert tabular files to CSV (default is to convert)
例：
kaggle datasets create -p /path/to/dataset
创建新的数据集版本
usage: kaggle datasets version [-h] -m VERSION_NOTES [-p FOLDER] [-q] [-t]
[-d]
required arguments:
-m VERSION_NOTES, –message VERSION_NOTES
Message describing the new version
optional arguments:
-h, –help show this help message and exit
-p FOLDER, –path FOLDER
Folder for upload, containing data files and a special dataset-metadata.json file (https://github.com/Kaggle/kaggle-api/wiki/Dataset-Metadata). Defaults to current working directory
-q, –quiet Suppress printing information about the upload/download progress
-t, –keep-tabular Do not convert tabular files to CSV (default is to convert)
-d, –delete-old-versions
Delete old versions of this dataset
例：
kaggle datasets version -p /path/to/dataset -m “Updated data”
下载现有数据集的元数据
usage: kaggle datasets metadata [-h] [-p PATH] [dataset]
optional arguments:
-h, –help show this help message and exit
dataset Dataset URL suffix in format / (use “kaggle datasets list” to show options)
-p PATH, –path PATH Location to download dataset metadata to. Defaults to current working directory
例：
kaggle datasets metadata -p /path/to/download zillow/zecon
获取数据集创建状态
usage: kaggle datasets status [-h] [dataset]
optional arguments:
-h, –help show this help message and exit
dataset Dataset URL suffix in format / (use “kaggle datasets list” to show options)
例：
kaggle datasets status zillow/zecon
仁
API支持Kaggle内核的以下命令。
usage: kaggle kernels [-h] {list,init,push,pull,output,status} …
optional arguments:
-h, –help show this help message and exit
commands:
{list,init,push,pull,output,status}
list List available kernels
init Initialize metadata file for a kernel
push Push new code to a kernel and run the kernel
pull Pull down code from a kernel
output Get data output from the latest kernel run
status Display the status of the latest kernel run
列出内核
usage: kaggle kernels list [-h] [-m] [-p PAGE] [-s SEARCH] [-v]
[–parent PARENT] [–competition COMPETITION]
[–dataset DATASET] [–parent-kernel PARENT_KERNEL]
[–user USER] [–language LANGUAGE]
[–kernel-type KERNEL_TYPE]
[–output-type OUTPUT_TYPE] [–sort-by SORT_BY]
optional arguments:
-h, –help show this help message and exit
-m, –mine Display only my items
-p PAGE, –page PAGE Page number for results paging
-s SEARCH, –search SEARCH
Term(s) to search for
-v, –csv Print results in CSV format (if not set print in table format)
–parent PARENT Find children of the specified parent kernel
–competition COMPETITION
Find kernels for a given competition
–dataset DATASET Find kernels for a given dataset
–user USER Find kernels created by a given user
–language LANGUAGE Specify the language the kernel is written in. Valid options are ‘all’, ‘python’, ‘r’, ‘sqlite’, and ‘julia’
–kernel-type KERNEL_TYPE
Specify the type of kernel. Valid options are ‘all’, ‘script’, and ‘notebook’
–output-type OUTPUT_TYPE
Search for specific kernel output types. Valid options are ‘all’, ‘visualizations’, and ‘data’
–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.
例：
kaggle kernels list -s titanic
初始化内核的元数据文件
usage: kaggle kernels init [-h] [-p FOLDER]
optional arguments:
-h, –help show this help message and exit
-p FOLDER, –path FOLDER
Folder for upload, containing data files and a special kernel-metadata.json file (https://github.com/Kaggle/kaggle-api/wiki/Kernel-Metadata). Defaults to current working directory
例：
kaggle kernels init -p /path/to/kernel
推送内核
usage: kaggle kernels push [-h] -p FOLDER
optional arguments:
-h, –help show this help message and exit
-p FOLDER, –path FOLDER
Folder for upload, containing data files and a special kernel-metadata.json file (https://github.com/Kaggle/kaggle-api/wiki/Kernel-Metadata). Defaults to current working directory
例：
kaggle kernels push -p /path/to/kernel
拉核心
usage: kaggle kernels pull [-h] [-p PATH] [-w] [-m] [kernel]
optional arguments:
-h, –help show this help message and exit
kernel Kernel URL suffix in format / (use “kaggle kernels list” to show options)
-p PATH, –path PATH Folder where file(s) will be downloaded, defaults to current working directory
-w, –wp Download files to current working path
-m, –metadata Generate metadata when pulling kernel
例：
kaggle kernels pull rtatman/list-of-5-day-challenges -p /path/to/dest
检索内核的输出
usage: kaggle kernels output [-h] [-p PATH] [-w] [-o] [-q] [kernel]
optional arguments:
-h, –help show this help message and exit
kernel Kernel URL suffix in format / (use “kaggle kernels list” to show options)
-p PATH, –path PATH Folder where file(s) will be downloaded, defaults to current working directory
-w, –wp Download files to current working path
-o, –force Skip check whether local version of file is up to date, force file download
-q, –quiet Suppress printing information about the upload/download progress
例：
kaggle kernels output mrisdal/exploring-survival-on-the-titanic -p /path/to/dest
获取最新内核运行的状态
usage: kaggle kernels status [-h] [kernel]
optional arguments:
-h, –help show this help message and exit
kernel Kernel URL suffix in format / (use “kaggle kernels list” to show options)
例：
kaggle kernels status mrisdal/exploring-survival-on-the-titanic
配置
API支持以下配置命令。
usage: kaggle config [-h] {view,set,unset} …
optional arguments:
-h, –help show this help message and exit
commands:
{view,set,unset}
view View current config values
set Set a configuration value
unset Clear a configuration value
查看当前配置值
usage: kaggle config path [-h] [-p PATH]
optional arguments:
-h, –help show this help message and exit
-p PATH, –path PATH folder where file(s) will be downloaded, defaults to ~/.kaggle
例：
kaggle config path -p C:\
查看当前配置值
usage: kaggle config view [-h]
optional arguments:
-h, –help show this help message and exit
例：
kaggle config view
设置配置值
usage: kaggle config set [-h] -n NAME -v VALUE
required arguments:
-n NAME, –name NAME Name of the configuration parameter
(one of competition, path, proxy)
-v VALUE, –value VALUE
Value of the configuration parameter, valid values depending on name
- competition: Competition URL suffix (use “kaggle competitions list” to show options)
- path: Folder where file(s) will be downloaded, defaults to ~/.kaggle
- proxy: Proxy for HTTP requests
例：
kaggle config set -n competition -v titanic
清除配置值
usage: kaggle config unset [-h] -n NAME
required arguments:
-n NAME, –name NAME Name of the configuration parameter
(one of competition, path, proxy)
例：
kaggle config unset -n competition
限制
内核支持是初步的，可能存在一些问题。
执照
Kaggle API是在Apache 2.0许可下发布的。