keyapi / KaggleActionsExample

A guide of how to interact with the Kaggle API via GitHub actions.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Kaggle Actions Example

This repository provides an example using the Kaggle API within GitHub actions.
The example action can be found here.
A more in-depth description of the purpose and functionality of this code can be found here.

badge

Example Breakdown

The steps for accessing the Kaggle API via an action are follows:

  1. Setup Python.
  2. Install Kaggle Python Library via pip.
  3. Execute Kaggle Commands.

Authentication

The Kaggle API requires a username and key for authentication. To generate a token (or use an existing one), check the Kaggle Documentation. Your Kaggle username and secret must be provided to the GitHub action to authenticate with the Kaggle API. This can be done through environment variables, which can be passed to the action through the use of GitHub secrets. Simply create two secrets, KaggleUsername and KaggleKey, and populate them the details in your Kaggle token.

More information on using environment variables with GitHub can be found here.

About

A guide of how to interact with the Kaggle API via GitHub actions.

License:MIT License