kaggle api

API Kaggle

API oficial para https://www.kaggle.com, acessível usando uma ferramenta de linha de comando implementada em Python 3.

Documentação do usuário

Instalação

Certifique-se de ter o Python 3 e o gerenciador de pacotes pip instalados.

Execute o seguinte comando para acessar a API Kaggle usando a linha de comando:

pip install kaggle

Desenvolvimento

Kaggle Interno

Obviamente, isso depende dos serviços Kaggle. Ao estender a API e modificar ou adicionar esses serviços, você deve trabalhar em seu ambiente de desenvolvimento de nível intermediário Kaggle. Você executará o Kaggle localmente, no contêiner, e testará o código Python executando-o no contêiner para que ele possa se conectar ao seu ambiente de teste local. No entanto, não tente criar uma versão dentro do contêiner. O formatador de código ( yapf3 ) muda muito mais do que o pretendido.

Além disso, execute o seguinte 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

Pré-requisitos

Usamos o hatch para gerenciar este projeto.

Siga estas instruções para instalá-lo.

Se você estiver trabalhando em um ambiente gerenciado, talvez queira usar pipx . Se ainda não estiver instalado, tente sudo apt install pipx . Então você poderá prosseguir com pipx install hatch .

Dependências

hatch run install-deps

Compilar

hatch run compile

Os arquivos compilados são gerados no diretório kaggle/ do diretório src/ .

Todas as alterações devem ser feitas no diretório src/ .

Correr

Você também pode executar o código diretamente em 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 em um único comando:

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

Exemplo

Vamos alterar o método model_list_cli no arquivo fonte:

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

Testes de Integração

Para executar testes de integração em sua máquina local, você precisa configurar suas credenciais da API Kaggle. Você pode fazer isso de uma das duas maneiras descritas neste documento. Consulte as seções:

• Usando variáveis ​​de ambiente
• Usando arquivo de credenciais

Depois de configurar suas credenciais por qualquer um desses métodos, você poderá executar os testes de integração da seguinte maneira:

 # Run all tests
hatch run integration-test

Licença

A API Kaggle é lançada sob a licença Apache 2.0.