kaggle 1.8.2__tar.gz → 1.8.4__tar.gz

{kaggle-1.8.2 → kaggle-1.8.4}/CHANGELOG.md

@@ -1,9 +1,26 @@
 Changelog
 ====
 
+### 1.8.4
+
+* Rename `kaggle-api` to `kaggle-cli`
+* Allow auth to happen multiple times (#922)
+* Add --acc to set accelerator for: kaggle kernels push ... (#907)
+* Add automatic retry and resume to download_file (#905) Thanks katoue!
+* Restore model validation check (#902)
+* Add file pattern matching in output download (#901) Thanks piotr-ginal!
+
+### 1.8.3
+
+* Add packaging dep (#883)
+* Add version checking against server known-version (#880)
+* Fix edit error (#876)
+* Use kagglesdk from pypi (#875)
+* Fix Kaggle access token auth KeyError when KAGGLE_API_TOKEN is unset (#874)
+
 ### 1.8.2
 
-* No changes to the kaggle program. Version 1.8.1 was not usable due to an error in the build script.
+* Changes to build script
 
 ### 1.8.1
 

{kaggle-1.8.2 → kaggle-1.8.4}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: kaggle
-Version: 1.8.2
+Version: 1.8.4
 Summary: Access Kaggle resources anywhere
-Project-URL: Homepage, https://github.com/Kaggle/kaggle-api
-Project-URL: Issues, https://github.com/Kaggle/kaggle-api/issues
+Project-URL: Homepage, https://github.com/Kaggle/kaggle-cli
+Project-URL: Issues, https://github.com/Kaggle/kaggle-cli/issues
 Author-email: Kaggle <support@kaggle.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -212,46 +212,57 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.11
-Requires-Dist: black>=24.10.0
 Requires-Dist: bleach
-Requires-Dist: kagglesdk
-Requires-Dist: mypy>=1.15.0
+Requires-Dist: kagglesdk<1.0,>=0.1.15
+Requires-Dist: packaging
 Requires-Dist: protobuf
 Requires-Dist: python-dateutil
 Requires-Dist: python-slugify
 Requires-Dist: requests
-Requires-Dist: setuptools>=21.0.0
-Requires-Dist: six>=1.10
 Requires-Dist: tqdm
-Requires-Dist: types-requests
-Requires-Dist: types-tqdm
 Requires-Dist: urllib3>=1.15.1
 Description-Content-Type: text/markdown
 
-# Kaggle API
+# Kaggle CLI
 
-Official API for https://www.kaggle.com, accessible using a command line tool implemented in Python 3.  
+The official CLI to interact with [Kaggle](https://www.kaggle.com).
+
+---
 
 [User documentation](docs/README.md)
 
-## Installation
+---
 
-Ensure you have Python 3 and the package manager `pip` installed.
+## Key Features
 
-Run the following command to access the Kaggle API using the command line:
+Some of the key features are:
+
+* List competitions, download competition data, submit to a competition.
+* List, create, update, download or delete datasets.
+* List, create, update, download or delete models & model variations.
+* List, update & run, download code & output or delete kernels (notebooks).
+
+## Installation
+
+Install the `kaggle` package with [pip](https://pypi.org/project/pip/):
 
 ```sh
 pip install kaggle
 ```
 
-## Development
+Additional installation instructions can be found [here](docs/README.md#installation).
 
-### Kaggle Internal
+## Quick start
 
-Obviously, this depends on Kaggle services. When you're extending the API and modifying
-or adding to those services, you should be working in your Kaggle mid-tier development
-environment. You'll run Kaggle locally, in the container, and test the Python code by
-running it in the container so it can connect to your local testing environment.
+Explore the available commands by running:
+
+```sh
+kaggle --help
+```
+
+See the [User documentation](docs/README.md) for more examples & tutorials.
+
+## Development
 
 ### Prerequisites
 
@@ -259,87 +270,67 @@ We use [hatch](https://hatch.pypa.io) to manage this project.
 
 Follow these [instructions](https://hatch.pypa.io/latest/install/) to install it.
 
-If you are working in a managed environment, you may want to use `pipx`. If it isn't already installed
-try `sudo apt install pipx`. Then you should be able to proceed with `pipx install hatch`.
+### Run `kaggle` from source
 
-### Dependencies
+#### Option 1: Execute a one-liner of code from the command line
 
 ```sh
-hatch run install-deps
+hatch run kaggle datasets list
 ```
 
-### Compile
+#### Option 2: Run many commands in a shell
 
 ```sh
-hatch run compile
+hatch shell
+
+# Inside the shell, you can run many commands
+kaggle datasets list
+kaggle competitions list
+...
 ```
 
-The compiled files are generated in the `kaggle/` directory from the `src/` directory.
+### Lint / Format
 
-All the changes must be done in the `src/` directory.
+```sh
+# Lint check
+hatch run lint:style
+hatch run lint:typing
+hatch run lint:all     # for both
 
-### Run
+# Format
+hatch run lint:fmt
+```
 
-Use `hatch run install` to compile the program and install it in the default `hatch` environment.
-To run that version locally for testing, use hatch: `hatch run kaggle -v`. If you'd rather not
-type `hatch run` every time, launch a new shell in the hatch environment: `hatch shell`.
+### Tests
 
-You can also run the code in python directly:
+Note: These tests are not true unit tests and are calling the Kaggle web server.
 
 ```sh
-hatch run python
-```
-
-```python
-import kaggle
-from kaggle.api.kaggle_api_extended import KaggleApi
-api = KaggleApi()
-api.authenticate()
-api.model_list_cli()
-
-Next Page Token = [...]
-[...]
+# Run against kaggle.com
+hatch run test:prod
 
+# Run against a local web server (Kaggle engineers only)
+hatch run test:local
 ```
 
-Or in a single command:
-
-```sh
-hatch run python -c "import kaggle; from kaggle.api.kaggle_api_extended import KaggleApi; api = KaggleApi(); api.authenticate(); api.model_list_cli()"
-```
+### Integration Tests
 
-### Example
+To run integration tests on your local machine, you need to set up your Kaggle credentials. You can do this by following the [authentication instructions](docs/README.md#authentication).
 
-Let's change the `model_list_cli` method in the source file: 
+After setting up your credentials, you can run the integration tests as follows:
 
 ```sh
-❯ 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 = [...]
+hatch run test:integration
 ```
 
-### Integration Tests
+## Changelog
 
-To run integration tests on your local machine, you need to set up your Kaggle API credentials. You can do this in one of these two ways described [this doc](docs/README.md). Refer to the sections: 
-- Using environment variables
-- Using credentials file
+See [CHANGELOG](CHANGELOG.md).
 
-After setting up your credentials by any of these methods, you can run the integration tests as follows:
+## Contributing
 
-```sh
-# Run all tests
-hatch run integration-test
-```
+See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License
 
-The Kaggle API is released under the [Apache 2.0 license](LICENSE).
+The Kaggle CLI is released under the [Apache 2.0 license](LICENSE.txt).

kaggle-1.8.4/README.md

@@ -0,0 +1,111 @@
+# Kaggle CLI
+
+The official CLI to interact with [Kaggle](https://www.kaggle.com).
+
+---
+
+[User documentation](docs/README.md)
+
+---
+
+## Key Features
+
+Some of the key features are:
+
+* List competitions, download competition data, submit to a competition.
+* List, create, update, download or delete datasets.
+* List, create, update, download or delete models & model variations.
+* List, update & run, download code & output or delete kernels (notebooks).
+
+## Installation
+
+Install the `kaggle` package with [pip](https://pypi.org/project/pip/):
+
+```sh
+pip install kaggle
+```
+
+Additional installation instructions can be found [here](docs/README.md#installation).
+
+## Quick start
+
+Explore the available commands by running:
+
+```sh
+kaggle --help
+```
+
+See the [User documentation](docs/README.md) for more examples & tutorials.
+
+## Development
+
+### Prerequisites
+
+We use [hatch](https://hatch.pypa.io) to manage this project.
+
+Follow these [instructions](https://hatch.pypa.io/latest/install/) to install it.
+
+### Run `kaggle` from source
+
+#### Option 1: Execute a one-liner of code from the command line
+
+```sh
+hatch run kaggle datasets list
+```
+
+#### Option 2: Run many commands in a shell
+
+```sh
+hatch shell
+
+# Inside the shell, you can run many commands
+kaggle datasets list
+kaggle competitions list
+...
+```
+
+### Lint / Format
+
+```sh
+# Lint check
+hatch run lint:style
+hatch run lint:typing
+hatch run lint:all     # for both
+
+# Format
+hatch run lint:fmt
+```
+
+### Tests
+
+Note: These tests are not true unit tests and are calling the Kaggle web server.
+
+```sh
+# Run against kaggle.com
+hatch run test:prod
+
+# Run against a local web server (Kaggle engineers only)
+hatch run test:local
+```
+
+### Integration Tests
+
+To run integration tests on your local machine, you need to set up your Kaggle credentials. You can do this by following the [authentication instructions](docs/README.md#authentication).
+
+After setting up your credentials, you can run the integration tests as follows:
+
+```sh
+hatch run test:integration
+```
+
+## Changelog
+
+See [CHANGELOG](CHANGELOG.md).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+The Kaggle CLI is released under the [Apache 2.0 license](LICENSE.txt).

{kaggle-1.8.2 → kaggle-1.8.4}/SECURITY.md

@@ -8,6 +8,6 @@ Security updates are applied only to the latest release.
 
 If you have discovered a security vulnerability in this project, please report it privately. **Do not disclose it as a public issue.** This gives us time to work with you to fix the issue before public exposure, reducing the chance that the exploit will be used before a patch is released.
 
-Please disclose it at [security advisory](https://github.com/Kaggle/kaggle-api/security/advisories/new).
+Please disclose it at [security advisory](https://github.com/Kaggle/kaggle-cli/security/advisories/new).
 
 The vulnerabilities will be addressed as soon as possible, with a maximum of 90 days before a public exposure.

kaggle-1.8.4/docs/README.md

@@ -0,0 +1,66 @@
+# Kaggle CLI Documentation
+
+Welcome to the Kaggle CLI documentation. This guide provides detailed information on how to use the Kaggle command-line interface to interact with Kaggle's platform.
+
+## Installation
+
+Note: Ensure you have Python 3.11+ and the package manager `pip` installed.
+
+Install the `kaggle` package with [pip](https://pypi.org/project/pip/):
+
+```sh
+pip install kaggle
+```
+
+If you run into a `Command kaggle not found` error, ensure that your Python executable scripts are in your $PATH. For a local user install on Linux, the default location is `~/.local/bin`. On Windows, the default location is `$PYTHON_HOME/Scripts`.
+
+## Authentication
+
+First, you will need a Kaggle account. You can sign up [here](https://www.kaggle.com/account/login).
+
+After login, you can download your Kaggle API credentials at https://www.kaggle.com/settings by clicking on the "Generate New Token" button under the "API" section.
+
+### Option 1: Environment variable
+
+```sh
+export KAGGLE_API_TOKEN=xxxxxxxxxxxxxx # Copied from the settings UI
+```
+
+### Option 2: API token file
+
+Store your Kaggle API token obtained from your [Kaggle account settings page](https://www.kaggle.com/settings) in a file at `~/.kaggle/access_token`.
+
+### Option 3: Legacy API credentials file
+
+From your [Kaggle account settings page](https://www.kaggle.com/settings), under "Legacy API Credentials", click on the "Create Legacy API Key" button to generate a `kaggle.json` file and store it at `~/.kaggle/kaggle.json`.
+
+## CLI Usage
+
+Run the following command to list the available commands:
+
+```sh
+kaggle --help
+```
+
+The Kaggle CLI is organized into several command groups:
+
+*   [Competitions](./competitions.md): Manage and participate in Kaggle competitions.
+*   [Datasets](./datasets.md): Search, download, and manage Kaggle datasets.
+*   [Kernels](./kernels.md): Interact with Kaggle Kernels (notebooks and scripts).
+*   [Models](./models.md): Manage your Kaggle Models.
+*   [Model Variations](./model_instances.md): Manage variations of your Kaggle Models.
+*   [Model Variation Versions](./model_instances_versions.md): Manage versions of your Kaggle Model Variations.
+*   [Configuration](./configuration.md): Configure the Kaggle CLI.
+
+## Tutorials
+
+Explore these tutorials to learn how to perform common tasks:
+
+*   [Tutorials](./tutorials.md)
+    *   [Create a Dataset](./tutorials.md#tutorial-create-a-dataset)
+    *   [Find and Download a Dataset](./tutorials.md#tutorial-find-and-download-a-dataset)
+    *   [Create a Model](./tutorials.md#tutorial-create-a-model)
+    *   [Create a Model Variation](./tutorials.md#tutorial-create-a-model-variation)
+    *   [Create a Model Variation Version](./tutorials.md#tutorial-create-a-model-variation-version)
+    *   [How to Submit to a Competition](./tutorials.md#tutorial-how-to-submit-to-a-competition)
+    *   [How to Submit to a Code Competition](./tutorials.md#tutorial-how-to-submit-to-a-code-competition)

{kaggle-1.8.2/documentation → kaggle-1.8.4/docs}/competitions.md

@@ -129,10 +129,10 @@ kaggle competitions submit <COMPETITION> -f <FILE_NAME> -m <MESSAGE> [options]
 **Options:**
 
 *   `-k, --kernel <KERNEL>`: Name of the kernel (notebook) to submit (for code competitions).
-*   `-v, --version <VERSION>`: Version of the kernel to submit.
+*   `-v, --version <VERSION>`: Version of the kernel to submit (e.g. `2`).
 *   `-q, --quiet`: Suppress verbose output.
 
-**Example:**
+**Example: Standard (not code) competition:**
 
 Submit `sample_submission.csv` to the "house-prices-advanced-regression-techniques" competition with the message "Test message":
 
@@ -140,6 +140,14 @@ Submit `sample_submission.csv` to the "house-prices-advanced-regression-techniqu
 kaggle competitions submit house-prices-advanced-regression-techniques -f sample_submission.csv -m "Test message"
 ```
 
+**Example: Code competition:**
+
+Submit the `submission.csv` produced by version `3` of your `<YOUR_USERNAME>/rsna-submission` for the `rsna-2024-lumbar-spine-degenerative-classification` competition:
+
+```bash
+kaggle competitions submit rsna-2024-lumbar-spine-degenerative-classification -f submission.csv -k <YOUR_USERNAME>/rsna-submission -v 3 -m "Test message"
+```
+
 **Purpose:**
 
 Use this command to upload your predictions or code to a competition for scoring.

{kaggle-1.8.2/documentation → kaggle-1.8.4/docs}/conf.py

@@ -31,7 +31,7 @@ def setup(app):
     app.connect("autodoc-skip-member", autodoc_skip_member)
 
 
-project = "kaggle-api"
+project = "kaggle-cli"
 copyright = "2025, Kaggle"
 author = "Kaggle"
 

{kaggle-1.8.2/documentation → kaggle-1.8.4/docs}/datasets.md

@@ -132,7 +132,7 @@ This command allows you to retrieve dataset files for local use.
 
 ## `kaggle datasets init`
 
-Initializes a metadata file (`dataset-metadata.json`) for creating a new dataset.
+Initializes a metadata file (`dataset-metadata.json`) for creating a new dataset. See [metadata file format](./datasets_metadata.md).
 
 **Usage:**
 

{kaggle-1.8.2 → kaggle-1.8.4}/docs/datasets_metadata.md

@@ -72,7 +72,7 @@ The following metadata is currently supported:
       * `fields`: Array of fields in the dataset.  Please note that this needs to include ALL of the fields in the data in order or they will not be matched up correctly.  A later version of the API will fix this bug.
         * `name`: Field name
         * `title`: Field description
-        * `type`: Field type. A best-effort list of types will be kept at the bottom of this wiki page, but new types may be added that are not documented here.
+        * `type`: Field type. A best-effort list of types will be kept at the bottom of this page, but new types may be added that are not documented here.
   * `keywords`: Contains an array of strings that correspond to an existing tag on Kaggle.  If a specified tag doesn't exist, the upload will continue, but that specific tag won't be added.  
 * `kaggle datasets version` (create a new version for an existing Dataset):
   * `subtitle`: Subtitle of the dataset, must be between 20 and 80 characters in length.
@@ -86,7 +86,7 @@ The following metadata is currently supported:
       * `fields`: Array of fields in the dataset.  Please note that this needs to include ALL of the fields in the data in order or they will not be matched up correctly.  A later version of the API will fix this bug.
         * `name`: Field name
         * `title`: Field description
-        * `type`: Field type. A best-effort list of types will be kept at the bottom of this wiki page, but new types may be added that are not documented here.
+        * `type`: Field type. A best-effort list of types will be kept at the bottom of this page, but new types may be added that are not documented here.
   * `keywords`: Contains an array of strings that correspond to an existing tag on Kaggle.  If a specified tag doesn't exist, the upload will continue, but that specific tag won't be added.  
 
 We will add further metadata processing in upcoming versions of the API.

{kaggle-1.8.2/documentation → kaggle-1.8.4/docs}/index.rst

@@ -1,11 +1,11 @@
 .. _kaggle:
 
-.. kaggle-api documentation master file, created by
+.. kaggle-cli documentation master file, created by
    sphinx-quickstart on Thu Jun 26 22:53:21 2025.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-kaggle-api documentation
+kaggle-cli documentation
 ========================
 
 .. toctree::

{kaggle-1.8.2/documentation → kaggle-1.8.4/docs}/kernels.md

@@ -98,7 +98,7 @@ Use this command to view the files generated by a kernel run.
 
 ## `kaggle kernels init`
 
-Initializes a metadata file (`kernel-metadata.json`) for a new or existing kernel.
+Initializes a metadata file (`kernel-metadata.json`) for a new or existing kernel. See [metadata file format](./kernels_metadata.md).
 
 **Usage:**
 
@@ -134,6 +134,7 @@ kaggle kernels push -p <FOLDER_PATH> [options]
 
 **Options:**
 
+*   `--accelerator <ACCELERATOR_ID>`: ID name of the accelerator to use during the run. E.g. "NvidiaTeslaP100" (aka default GPU), "NvidiaTeslaT4", "TpuV6E8".
 *   `-p, --path <FOLDER_PATH>`: Path to the folder containing the kernel file (e.g., `.ipynb`, `.Rmd`, `.py`) and the `kernel-metadata.json` file (defaults to the current directory).
 *   `-t, --timeout <SECONDS>`: Maximum run time in seconds.
 
@@ -149,6 +150,23 @@ kaggle kernels push -p tests/kernel
 
 This command uploads your local kernel file and its metadata to Kaggle. If the kernel specified in the metadata exists under your account, it will be updated. Otherwise, a new kernel will be created. After uploading, Kaggle will attempt to run the kernel.
 
+Accelerators available as of Feb 2026:
+
+* NvidiaTeslaP100
+* TpuV38
+* NvidiaTeslaT4
+* NvidiaTeslaT4Highmem
+* Tpu1VmV38
+* NvidiaTeslaA100
+* NvidiaL4
+* TpuV5E8
+* NvidiaL4X1
+* TpuV6E8
+* NvidiaH100
+* NvidiaRtxPro6000
+
+Some of these are only available to participants of specific competitions, and some are only available to Kaggle admins.
+
 ## `kaggle kernels pull`
 
 Pulls down the code/notebook and metadata for a kernel.
@@ -207,6 +225,7 @@ kaggle kernels output <KERNEL> [options]
 *   `-w, --wp`: Download files to the current working path.
 *   `-o, --force`: Force download, overwriting existing files.
 *   `-q, --quiet`: Suppress verbose output.
+*   `--file-pattern <REGEX>`: Regex pattern to match against filenames. Only files matching the pattern will be downloaded.
 
 **Example:**
 
@@ -215,6 +234,11 @@ Download the output of the kernel `kerneler/using-google-bird-vocalization-model
 ```bash
 kaggle kernels output kerneler/sqlite-global-default -o
 ```
+Download PNG files only:
+
+```bash
+kaggle kernels output <kernel> --file-pattern ".*\.png$"  # Only PNG files
+```
 
 **Purpose:**
 

{kaggle-1.8.2/documentation → kaggle-1.8.4/docs}/model_instances.md

@@ -5,6 +5,7 @@ Commands for interacting with variations of Kaggle Models. A model variation typ
 ## `kaggle models variations init`
 
 Initializes a metadata file (`model-instance-metadata.json`) for creating a new model variation.
+Note that the name of the file reflects the old name for a variation, which was "instance".
 
 **Usage:**
 
@@ -52,7 +53,7 @@ Create a new model variation using the metadata and files in the `tmp` folder, q
 # Example: Edit model-instance-metadata.json first
 # sed -i 's/INSERT_OWNER_SLUG_HERE/your-username/' tmp/model-instance-metadata.json
 # sed -i 's/INSERT_EXISTING_MODEL_SLUG_HERE/parent-model-slug/' tmp/model-instance-metadata.json
-# sed -i 's/INSERT_INSTANCE_SLUG_HERE/my-instance-slug/' tmp/model-instance-metadata.json
+# sed -i 's/INSERT_INSTANCE_SLUG_HERE/my-variation-slug/' tmp/model-instance-metadata.json
 # sed -i 's/INSERT_FRAMEWORK_HERE/jax/' tmp/model-instance-metadata.json
 # echo "a,b,c,d" > tmp/data.csv # Example model file
 
@@ -70,12 +71,12 @@ Downloads the `model-instance-metadata.json` file for an existing model variatio
 **Usage:**
 
 ```bash
-kaggle models variations get <MODEL_INSTANCE> -p <FOLDER_PATH>
+kaggle models variations get <MODEL_VARIATION> -p <FOLDER_PATH>
 ```
 
 **Arguments:**
 
-*   `<MODEL_INSTANCE>`: Model variation URL suffix in the format `owner/model-slug/framework/instance-slug` (e.g., `$KAGGLE_DEVELOPER/test-model/jax/main`).
+*   `<MODEL_VARIATION>`: Model variation URL suffix in the format `owner/model-slug/framework/variation-slug` (e.g., `$KAGGLE_DEVELOPER/test-model/jax/main`).
 
 **Options:**
 
@@ -100,12 +101,12 @@ Lists files for the current version of a model variation.
 **Usage:**
 
 ```bash
-kaggle models variations files <MODEL_INSTANCE> [options]
+kaggle models variations files <MODEL_VARIATION> [options]
 ```
 
 **Arguments:**
 
-*   `<MODEL_INSTANCE>`: Model variation URL suffix (e.g., `$KAGGLE_DEVELOPER/test-model/jax/main`).
+*   `<MODEL_VARIATION>`: Model variation URL suffix (e.g., `$KAGGLE_DEVELOPER/test-model/jax/main`).
 
 **Options:**
 
@@ -158,12 +159,12 @@ Deletes a model variation from Kaggle.
 **Usage:**
 
 ```bash
-kaggle models variations delete <MODEL_INSTANCE> [options]
+kaggle models variations delete <MODEL_VARIATION> [options]
 ```
 
 **Arguments:**
 
-*   `<MODEL_INSTANCE>`: Model variation URL suffix in the format `owner/model-slug/framework/instance-slug` (e.g., `$KAGGLE_DEVELOPER/test-model/jax/main`).
+*   `<MODEL_VARIATION>`: Model variation URL suffix in the format `owner/model-slug/framework/variation-slug` (e.g., `$KAGGLE_DEVELOPER/test-model/jax/main`).
 
 **Options:**