kaggle api

API Kaggle

API officielle pour https://www.kaggle.com, accessible à l'aide d'un outil de ligne de commande implémenté dans Python 3.

Documentation utilisateur

Installation

Assurez-vous que Python 3 et le gestionnaire de packages pip sont installés.

Exécutez la commande suivante pour accéder à l'API Kaggle à l'aide de la ligne de commande :

pip install kaggle

Développement

Kaggle Interne

Évidemment, cela dépend des services Kaggle. Lorsque vous étendez l'API et modifiez ou ajoutez ces services, vous devez travailler dans votre environnement de développement Kaggle de niveau intermédiaire. Vous exécuterez Kaggle localement, dans le conteneur, et testerez le code Python en l'exécutant dans le conteneur afin qu'il puisse se connecter à votre environnement de test local. Cependant, n’essayez pas de créer une version à partir du conteneur. Le formateur de code ( yapf3 ) change bien plus que prévu.

Exécutez également la commande suivante pour installer 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

Conditions préalables

Nous utilisons Hatch pour gérer ce projet.

Suivez ces instructions pour l'installer.

Si vous travaillez dans un environnement géré, vous souhaiterez peut-être utiliser pipx . S'il n'est pas déjà installé, essayez sudo apt install pipx . Ensuite, vous devriez pouvoir procéder à pipx install hatch .

Dépendances

hatch run install-deps

Compiler

hatch run compile

Les fichiers compilés sont générés dans le répertoire kaggle/ à partir du répertoire src/ .

Toutes les modifications doivent être effectuées dans le répertoire src/ .

Courir

Vous pouvez également exécuter le code directement en 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 = [...]
[...]

Ou en une seule commande :

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

Exemple

Modifions la méthode model_list_cli dans le fichier source :

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

Tests d'intégration

Pour exécuter des tests d'intégration sur votre machine locale, vous devez configurer vos informations d'identification API Kaggle. Vous pouvez le faire de l'une des deux manières décrites dans ce document. Référez-vous aux rubriques :

• Utiliser des variables d'environnement
• Utilisation du fichier d'informations d'identification

Après avoir configuré vos informations d'identification par l'une de ces méthodes, vous pouvez exécuter les tests d'intégration comme suit :

 # Run all tests
hatch run integration-test

Licence

L'API Kaggle est publiée sous la licence Apache 2.0.