kaggle api

Kaggle-API

Offizielle API für https://www.kaggle.com, zugänglich über ein in Python 3 implementiertes Befehlszeilentool.

Benutzerdokumentation

Installation

Stellen Sie sicher, dass Sie Python 3 und den Paketmanager pip installiert haben.

Führen Sie den folgenden Befehl aus, um über die Befehlszeile auf die Kaggle-API zuzugreifen:

pip install kaggle

Entwicklung

Kaggle Intern

Dies hängt natürlich von den Kaggle-Diensten ab. Wenn Sie die API erweitern und diese Dienste ändern oder hinzufügen, sollten Sie in Ihrer Kaggle-Mittelschicht-Entwicklungsumgebung arbeiten. Sie führen Kaggle lokal im Container aus und testen den Python-Code, indem Sie ihn im Container ausführen, damit er eine Verbindung zu Ihrer lokalen Testumgebung herstellen kann. Versuchen Sie jedoch nicht, ein Release aus dem Container heraus zu erstellen. Der Codeformatierer ( yapf3 ) ändert sich viel mehr als beabsichtigt.

Führen Sie außerdem den folgenden Befehl aus, um autogen.sh zu installieren:

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

Voraussetzungen

Wir verwenden Hatch, um dieses Projekt zu verwalten.

Befolgen Sie diese Anweisungen, um es zu installieren.

Wenn Sie in einer verwalteten Umgebung arbeiten, möchten Sie möglicherweise pipx verwenden. Wenn es noch nicht installiert ist, versuchen Sie es mit sudo apt install pipx . Dann sollten Sie in der Lage sein, mit pipx install hatch fortzufahren.

Abhängigkeiten

hatch run install-deps

Kompilieren

hatch run compile

Die kompilierten Dateien werden im Verzeichnis kaggle/ aus dem Verzeichnis src/ generiert.

Alle Änderungen müssen im Verzeichnis src/ vorgenommen werden.

Laufen

Sie können den Code auch direkt in Python ausführen:

hatch run python

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

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

Oder in einem einzigen Befehl:

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

Beispiel

Ändern wir die Methode model_list_cli in der Quelldatei:

❯ 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 = [...]

Integrationstests

Um Integrationstests auf Ihrem lokalen Computer auszuführen, müssen Sie Ihre Kaggle-API-Anmeldeinformationen einrichten. Sie können dies auf eine der beiden in diesem Dokument beschriebenen Arten tun. Weitere Informationen finden Sie in den Abschnitten:

• Verwendung von Umgebungsvariablen
• Anmeldeinformationsdatei verwenden

Nachdem Sie Ihre Anmeldeinformationen mit einer dieser Methoden eingerichtet haben, können Sie die Integrationstests wie folgt ausführen:

 # Run all tests
hatch run integration-test

Lizenz

Die Kaggle-API wird unter der Apache 2.0-Lizenz veröffentlicht.