kaggle api

卡格尔API

https://www.kaggle.com 的官方 API，可使用 Python 3 中实现的命令行工具进行访问。

用户文档

安装

确保您已安装 Python 3 和包管理器pip 。

运行以下命令以使用命令行访问 Kaggle API：

pip install kaggle

发展

Kaggle 内部

显然，这取决于 Kaggle 服务。当您扩展 API 并修改或添加这些服务时，您应该在 Kaggle 中间层开发环境中工作。您将在容器中本地运行 Kaggle，并通过在容器中运行 Python 代码来测试它，以便它可以连接到本地测试环境。但是，不要尝试从容器内创建版本。代码格式化程序 ( yapf3 ) 的变化比预期的要大得多。

另外，运行以下命令来安装autogen.sh ：

rm -rf /tmp/autogen && mkdir -p /tmp/autogen && unzip -qo /tmp/autogen.zip -d /tmp/autogen &&
mv /tmp/autogen/autogen- * / * /tmp/autogen && rm -rf /tmp/autogen/autogen- * &&
sudo chmod a+rx /tmp/autogen/autogen.sh

先决条件

我们使用孵化来管理这个项目。

请按照以下说明进行安装。

如果您在托管环境中工作，您可能需要使用pipx 。如果尚未安装，请尝试sudo apt install pipx 。然后您应该能够继续pipx install hatch 。

依赖关系

hatch run install-deps

编译

hatch run compile

编译后的文件从src/目录生成到kaggle/目录中。

所有更改都必须在src/目录中完成。

跑步

也可以直接在python中运行代码：

hatch run python

 import kaggle
from kaggle . api . kaggle_api_extended import KaggleApi
api = KaggleApi ()
api . authenticate ()
api . model_list_cli ()

Next Page Token = [...]
[...]

或者在单个命令中：

hatch run python -c " import kaggle; from kaggle.api.kaggle_api_extended import KaggleApi; api = KaggleApi(); api.authenticate(); api.model_list_cli() "

例子

让我们更改源文件中的model_list_cli方法：

❯ git diff src/kaggle/api/kaggle_api_extended.py
[...]
+        print( ' hello Kaggle CLI update ' )^M
         models = self.model_list(sort_by, search, owner, page_size, page_token)
[...]

❯ hatch run compile
[...]

❯ hatch run python -c " import kaggle; from kaggle.api.kaggle_api_extended import KaggleApi; api = KaggleApi(); api.authenticate(); api.model_list_cli() "
hello Kaggle CLI update
Next Page Token = [...]

集成测试

要在本地计算机上运行集成测试，您需要设置 Kaggle API 凭据。您可以通过本文档描述的两种方式之一来执行此操作。请参阅以下部分：

• 使用环境变量
• 使用凭证文件

通过任何这些方法设置凭据后，您可以运行集成测试，如下所示：

 # Run all tests
hatch run integration-test

执照

Kaggle API 是根据 Apache 2.0 许可证发布的。