kaggle 2.2.2__tar.gz → 2.2.4__tar.gz

{kaggle-2.2.2 → kaggle-2.2.4}/CHANGELOG.md

@@ -3,6 +3,55 @@ Changelog
 
 ### Next
 
+### 2.2.4
+
+* fix(benchmarks): support owner/task separator in benchmark commands (#1146)
+* Feat/competition submissions limits (#1144)
+* add competitions solution create/status commands (#1141)
+* fix(cli): prevent stale file corruption when resuming downloads (#1142)
+* fix(cli): fix collaborator role handling in dataset metadata update (#1138)
+* Refactor paging to use Protocols (#1137)
+* fix(cli): retry transient connection errors in with_retry (#1132)
+* Add Kaggle Secrets documentation (#1131)
+* Fix model and owner slug validation (#1134)
+* Implement ignore_patterns in uploading (combined) (#1130)
+* Refactor parser fixtures (#1118)
+* fix(auth): avoid skipping auth for programmatic imports (#1117)
+* fix(cli): resumable upload start offset when zero bytes uploaded (#1113)
+* refactor(cli): reuse _resolve_projection in dataset_status (#1116)
+* update supported model list (#1115)
+* fix(cli): handle deleted comments in topics show (#1114)
+* Add leaderboard subcommand to kaggle benchmarks (#1112)
+* feat(cli): add competitions settings update command (#1104)
+* feat(cli): add competitions hosts list command (#1107)
+* feat(cli): add competitions settings get command (#1103)
+* feat(cli): support --page-token and --page-size, preserve --page (#1098)
+* feat(cli): expose userRank in competitions list output (#1094)
+* fix(cli): read kernel metadata and source files using UTF-8 in kernels_push (#1093)
+* Fix crash when running kaggle command with invalid credentials (#1092)
+* feat(cli): add competitions data push command (#1085)
+* fix(cli): restore fallback for unknown kernel language/type in kernels_pull (#1091)
+* fix(auth): prioritize OAuth credentials over anonymous fallback (#1089)
+* feat(cli): add competitions pages update command (#1083)
+* fix(cli): stop treating subcommand -v as version flag (#1082)
+* fix(cli): honor --unzip for cached dataset downloads (#1086)
+* feat(cli): add competitions pages delete command (#1084)
+* feat(cli): add competitions init and create commands (#1080)
+* docs(competitions): add competition_creation.md for new host commands (#1081)
+* feat(cli): add competitions launch command (#1079)
+* feat(cli): add competitions pages create command (#1078)
+* fix(cli): avoid success message after canceled model deletion (#1077)
+* fix(cli): avoid success message after canceled dataset deletion (#1073)
+
+### 2.2.3
+
+* Update --format help text to reference output_format.md (#1074)
+* Update kernel pull docs with version example (#1072)
+* Reorganize tests and rename unit_tests.py to backend_tests.py (#1071)
+* Add support for formatting projections (#1068)
+* Rewrite `kaggle kernels logs --follow` to use SSE log stream (#999)
+* Add --format option to CLI commands supporting --csv (#1062)
+
 ### 2.2.2
 
 * Clarify LLMS_AVAILABLE vs. full model set in benchmarks docs (#1061)

{kaggle-2.2.2 → kaggle-2.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kaggle
-Version: 2.2.2
+Version: 2.2.4
 Summary: Access Kaggle resources anywhere
 Project-URL: Homepage, https://github.com/Kaggle/kaggle-cli
 Project-URL: Issues, https://github.com/Kaggle/kaggle-cli/issues
@@ -214,7 +214,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.11
 Requires-Dist: bleach
 Requires-Dist: jupytext
-Requires-Dist: kagglesdk<1.0,>=0.1.30
+Requires-Dist: kagglesdk<1.0,>=0.1.35
 Requires-Dist: packaging
 Requires-Dist: protobuf
 Requires-Dist: python-dateutil
@@ -265,6 +265,14 @@ kaggle --help
 
 See the [User documentation](docs/README.md) for more examples & tutorials.
 
+## Hosting a competition
+
+End-to-end host commands — scaffold a new competition, author its pages,
+tune its settings, and launch it — are documented in
+[docs/competition_creation.md](docs/competition_creation.md). Covers
+`kaggle competitions init`, `create`, `pages create`, `hosts`,
+`settings get`, `settings update`, and `launch`.
+
 ## Development
 
 ### `kagglesdk` Updates
@@ -333,6 +341,31 @@ After setting up your credentials, you can run the integration tests as follows:
 hatch run test:integration
 ```
 
+### Code Coverage
+
+We measure code coverage using `pytest-cov`.
+
+To run unit tests with coverage and generate reports:
+
+```sh
+hatch run test:cov
+```
+
+This generates:
+*   Terminal output with a coverage summary.
+*   `coverage.xml` (XML report in the root, used by IDE integrations).
+*   `htmlcov/index.html` (HTML report for browser viewing).
+
+#### Editor Integration
+
+##### VSCode
+Install the **Coverage Gutters** extension. After running the coverage command, click the **Watch** button in the status bar to see coverage indicators in the editor margins.
+
+##### JetBrains Rider
+With the **Python** plugin installed:
+*   **Run with Coverage:** Create a Pytest run configuration and click the shield icon ("Run with Coverage").
+*   **Import Report:** Go to **Tools** -> **Show Code Coverage Data**, click **Add** (+), and select `coverage.xml`.
+
 ### Running `hatch` commands inside Docker
 
 This is useful to run in a consistent environment and easily switch between Python versions.

{kaggle-2.2.2 → kaggle-2.2.4}/README.md

@@ -38,6 +38,14 @@ kaggle --help
 
 See the [User documentation](docs/README.md) for more examples & tutorials.
 
+## Hosting a competition
+
+End-to-end host commands — scaffold a new competition, author its pages,
+tune its settings, and launch it — are documented in
+[docs/competition_creation.md](docs/competition_creation.md). Covers
+`kaggle competitions init`, `create`, `pages create`, `hosts`,
+`settings get`, `settings update`, and `launch`.
+
 ## Development
 
 ### `kagglesdk` Updates
@@ -106,6 +114,31 @@ After setting up your credentials, you can run the integration tests as follows:
 hatch run test:integration
 ```
 
+### Code Coverage
+
+We measure code coverage using `pytest-cov`.
+
+To run unit tests with coverage and generate reports:
+
+```sh
+hatch run test:cov
+```
+
+This generates:
+*   Terminal output with a coverage summary.
+*   `coverage.xml` (XML report in the root, used by IDE integrations).
+*   `htmlcov/index.html` (HTML report for browser viewing).
+
+#### Editor Integration
+
+##### VSCode
+Install the **Coverage Gutters** extension. After running the coverage command, click the **Watch** button in the status bar to see coverage indicators in the editor margins.
+
+##### JetBrains Rider
+With the **Python** plugin installed:
+*   **Run with Coverage:** Create a Pytest run configuration and click the shield icon ("Run with Coverage").
+*   **Import Report:** Go to **Tools** -> **Show Code Coverage Data**, click **Add** (+), and select `coverage.xml`.
+
 ### Running `hatch` commands inside Docker
 
 This is useful to run in a consistent environment and easily switch between Python versions.

{kaggle-2.2.2 → kaggle-2.2.4}/docs/README.md

@@ -55,13 +55,17 @@ 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.
 *   [Forums](./forums.md): Browse and read Kaggle discussion forums.
-*   [Kernels](./kernels.md): Interact with Kaggle Kernels (notebooks and scripts).
+*   [Kernels](./kernels.md): Interact with Kaggle Kernels (notebooks and scripts). Includes information on using [Kaggle Secrets](./kernels.md#using-secrets-in-kernels).
 *   [Models](./models.md): Manage your Kaggle Models.
 *   [Model Variations](./model_variations.md): Manage variations of your Kaggle Models.
 *   [Model Variation Versions](./model_variations_versions.md): Manage versions of your Kaggle Model Variations.
 *   [Benchmarks](./benchmarks.md): Define evaluation tasks, run them against LLM models, and download results.
 *   [Configuration](./configuration.md): Configure the Kaggle CLI.
 
+Many commands produce output, which can be formatted for different purposes:
+
+*   [Output Format](./output_format.md): Control the format of output.
+
 ## Tutorials
 
 Explore these tutorials to learn how to perform common tasks:

{kaggle-2.2.2 → kaggle-2.2.4}/docs/benchmarks.md

@@ -2,11 +2,13 @@
 
 Commands for interacting with Kaggle Benchmarks. Benchmarks let you define evaluation tasks as Python scripts, run them against one or more LLM models via the Kaggle Model Proxy, and download the results.
 
-The top-level command is `kaggle benchmarks` (alias: `kaggle b`), which has three sub-groups:
+The top-level command is `kaggle benchmarks` (alias: `kaggle b`), which has the following subcommands and groups:
 
 *   **`auth`** — Fetch Model Proxy credentials.
 *   **`init`** — Fetch credentials and default environment variables for local development.
+*   **`leaderboard`** — Get benchmark leaderboard information.
 *   **`tasks`** (alias: `t`) — Manage benchmark tasks (push, run, list, status, download, log, models, delete, publish).
+*   **`topics`** — Browse discussion topics for a benchmark.
 
 ## `kaggle benchmarks auth`
 
@@ -88,10 +90,74 @@ If either file already exists, it is skipped without overwriting.
 
 ---
 
+## `kaggle benchmarks leaderboard`
+
+Get benchmark leaderboard information.
+
+**Usage:**
+
+```bash
+kaggle benchmarks leaderboard <BENCHMARK> [options]
+```
+
+**Arguments:**
+
+*   `<BENCHMARK>`: Benchmark slug (e.g., `owner/benchmark-slug`).
+
+**Options:**
+
+*   `--version <VERSION>`: Benchmark version (optional).
+*   `-s, --show`: Show the leaderboard in the terminal.
+*   `-d, --download`: Download the leaderboard as a CSV file.
+*   `-p, --path <DIRECTORY>`: Folder where the leaderboard will be downloaded (defaults to current working directory).
+*   `-v, --csv`: Print results in CSV format (when used with `--show`).
+*   `--format <FORMAT>`: Print results in a specific format (e.g., `json`).
+
+**Examples:**
+
+1.  Show the leaderboard for a benchmark:
+
+    ```bash
+    kaggle b leaderboard owner/my-benchmark --show
+    ```
+
+2.  Download the leaderboard as CSV:
+
+    ```bash
+    kaggle b leaderboard owner/my-benchmark --download
+    ```
+
+3.  Show a specific version of the leaderboard in JSON format:
+
+    ```bash
+    kaggle b leaderboard owner/my-benchmark --version 2 --show --format json
+    ```
+
+**Purpose:**
+
+Displays or downloads the evaluation results for all models that have run tasks in the specified benchmark. The leaderboard is represented as a table where rows are model versions and columns are benchmark tasks, showing the score achieved by each model on each task.
+
+---
+
 ## Tasks Commands
 
 All tasks commands live under `kaggle benchmarks tasks` (alias: `kaggle b t`).
 
+### Task Name Format
+
+Task arguments (`<TASK>`) support two formats:
+
+*   **Bare slug** (`my-task`): Refers to a task owned by the current user.
+*   **Owner prefix** (`owner/my-task`): Refers to a specific owner's task (e.g., another user's public task, or `your-username/my-task`).
+
+| Command Group | Supported Formats | Description |
+|---|---|---|
+| **View & Run** (`run`, `status`, `download`, `log`) | `my-task`, `owner/my-task` | Interact with your own tasks or public tasks from other users |
+| **Publish** (`publish`) | `my-task`, `your-username/my-task` | Make your own task public (must be task owner) |
+| **Create** (`push`) | `my-task` only | Must match the `@task(name="...")` decorator in your Python source file |
+
+> **Slug Normalization:** Task names are automatically converted to URL-safe slugs (`My Task` → `my-task`). For `owner/task` arguments, each segment is slugified independently (`Owner/My Task` → `owner/my-task`) so the `/` separator is preserved.
+
 ### `kaggle benchmarks tasks push`
 
 Creates or updates a benchmark task from a local Python source file. The file must contain at least one function decorated with `@task`.
@@ -167,7 +233,7 @@ kaggle benchmarks tasks run <TASK> [options]
 
 **Arguments:**
 
-*   `<TASK>`: Task name (slug, e.g. `my-task`).
+*   `<TASK>`: Task name (slug, e.g. `my-task` or `owner/my-task`).
 
 **Options:**
 
@@ -249,7 +315,7 @@ kaggle benchmarks tasks status <TASK> [options]
 
 **Arguments:**
 
-*   `<TASK>`: Task name (slug, e.g. `my-task`).
+*   `<TASK>`: Task name (slug, e.g. `my-task` or `owner/my-task`).
 
 **Options:**
 
@@ -263,7 +329,13 @@ kaggle benchmarks tasks status <TASK> [options]
     kaggle b t status my-task
     ```
 
-2.  Show status for specific models only:
+2.  Show status for another user's task:
+
+    ```bash
+    kaggle b t status someuser/their-task
+    ```
+
+3.  Show status for specific models only:
 
     ```bash
     kaggle b t status my-task -m gemini-2.5-pro
@@ -289,7 +361,7 @@ kaggle benchmarks tasks download <TASK> [options]
 
 **Arguments:**
 
-*   `<TASK>`: Task name (slug, e.g. `my-task`).
+*   `<TASK>`: Task name (slug, e.g. `my-task` or `owner/my-task`).
 
 **Options:**
 
@@ -306,19 +378,25 @@ kaggle benchmarks tasks download <TASK> [options]
     kaggle b t download my-task
     ```
 
-2.  Download outputs for a specific model into a custom directory:
+2.  Download outputs from another user's public task:
+
+    ```bash
+    kaggle b t download someuser/their-task
+    ```
+
+3.  Download outputs for a specific model into a custom directory:
 
     ```bash
     kaggle b t download my-task -m gemini-2.5-pro -o ./results
     ```
 
-3.  Download outputs with source notebooks included:
+4.  Download outputs with source notebooks included:
 
     ```bash
     kaggle b t download my-task --include-source
     ```
 
-4.  Force re-download of previously downloaded runs:
+5.  Force re-download of previously downloaded runs:
 
     ```bash
     kaggle b t download my-task --force
@@ -370,7 +448,7 @@ kaggle benchmarks tasks log <TASK> [options]
 
 **Arguments:**
 
-*   `<TASK>`: Task name (slug, e.g. `my-task`).
+*   `<TASK>`: Task name (slug, e.g. `my-task` or `owner/my-task`).
 
 **Options:**
 
@@ -386,13 +464,19 @@ kaggle benchmarks tasks log <TASK> [options]
     kaggle b t log my-task
     ```
 
-2.  Show logs for a specific model's run(s):
+2.  Show logs for another user's task:
+
+    ```bash
+    kaggle b t log someuser/their-task
+    ```
+
+3.  Show logs for a specific model's run(s):
 
     ```bash
     kaggle b t log my-task -m gemini-2.5-pro
     ```
 
-3.  Show logs for multiple models:
+4.  Show logs for multiple models:
 
     ```bash
     kaggle b t logs my-task -m gemini-2.5-pro -m claude-sonnet-4
@@ -480,7 +564,7 @@ kaggle benchmarks tasks delete <TASK> [options]
 
 **Arguments:**
 
-*   `<TASK>`: Task name (slug, e.g. `my-task`).
+*   `<TASK>`: Task name (slug, e.g. `my-task` or `owner/my-task`).
 
 **Options:**
 
@@ -510,7 +594,7 @@ kaggle benchmarks tasks publish <TASK> [options]
  
 **Arguments:**
  
-*   `<TASK>`: Task name (slug, e.g. `my-task`).
+*   `<TASK>`: Task name (slug, e.g. `my-task` or `owner/my-task`).
  
 **Options:**