kaggle api

API de Kaggle

API oficial para https://www.kaggle.com, accesible mediante una herramienta de línea de comandos implementada en Python 3.

Documentación de usuario

Instalación

Asegúrese de tener instalado Python 3 y el administrador de paquetes pip .

Ejecute el siguiente comando para acceder a la API de Kaggle usando la línea de comando:

pip install kaggle

Desarrollo

Kaggle Interno

Obviamente, esto depende de los servicios de Kaggle. Cuando amplía la API y modifica o agrega esos servicios, debe trabajar en su entorno de desarrollo de nivel medio de Kaggle. Ejecutará Kaggle localmente, en el contenedor, y probará el código Python ejecutándolo en el contenedor para que pueda conectarse a su entorno de prueba local. Sin embargo, no intente crear una versión desde el contenedor. El formateador de código ( yapf3 ) cambia mucho más de lo previsto.

Además, ejecute el siguiente comando para instalar 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

Requisitos previos

Usamos hatch para gestionar este proyecto.

Siga estas instrucciones para instalarlo.

Si está trabajando en un entorno administrado, es posible que desee utilizar pipx . Si aún no está instalado, intente con sudo apt install pipx . Entonces deberías poder continuar con pipx install hatch .

Dependencias

hatch run install-deps

Compilar

hatch run compile

Los archivos compilados se generan en el directorio kaggle/ desde el directorio src/ .

Todos los cambios deben realizarse en el directorio src/ .

Correr

También puedes ejecutar el código en Python directamente:

hatch run python

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

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

O en un solo comando:

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

Ejemplo

Cambiemos el método model_list_cli en el archivo fuente:

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

Pruebas de integración

Para ejecutar pruebas de integración en su máquina local, debe configurar sus credenciales de API de Kaggle. Puede hacer esto de una de estas dos formas descritas en este documento. Consulte las secciones:

• Usando variables de entorno
• Usando el archivo de credenciales

Después de configurar sus credenciales mediante cualquiera de estos métodos, puede ejecutar las pruebas de integración de la siguiente manera:

 # Run all tests
hatch run integration-test

Licencia

La API de Kaggle se publica bajo la licencia Apache 2.0.