kaggle api

Kaggle 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 認証情報を設定する必要があります。これは、このドキュメントで説明されている 2 つの方法のいずれかで行うことができます。次のセクションを参照してください。

• 環境変数の使用
• 認証情報ファイルの使用

これらの方法のいずれかで資格情報を設定した後、次のように統合テストを実行できます。

 # Run all tests
hatch run integration-test

ライセンス

Kaggle API は、Apache 2.0 ライセンスに基づいてリリースされています。