kaggle 2.2.2__tar.gz → 2.2.3__tar.gz

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

@@ -3,6 +3,15 @@ Changelog
 
 ### Next
 
+### 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.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kaggle
-Version: 2.2.2
+Version: 2.2.3
 Summary: Access Kaggle resources anywhere
 Project-URL: Homepage, https://github.com/Kaggle/kaggle-cli
 Project-URL: Issues, https://github.com/Kaggle/kaggle-cli/issues

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

@@ -62,6 +62,10 @@ The Kaggle CLI is organized into several command groups:
 *   [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.3}/docs/kernels.md

@@ -179,7 +179,7 @@ kaggle kernels pull <KERNEL> [options]
 
 **Arguments:**
 
-*   `<KERNEL>`: Kernel URL suffix (format: `owner/kernel-slug`, e.g., `$KAGGLE_DEVELOPER/exercise-as-with`).
+*   `<KERNEL>`: Kernel URL suffix (format: `owner/kernel-slug` or `owner/kernel-slug/version`, e.g., `$KAGGLE_DEVELOPER/exercise-as-with` or `$KAGGLE_DEVELOPER/exercise-as-with/2`).
 
 **Options:**
 
@@ -201,6 +201,12 @@ kaggle kernels pull <KERNEL> [options]
     kaggle kernels pull --wp $KAGGLE_DEVELOPER/exercise-as-with
     ```
 
+3.  Pull version 2 of the kernel `$KAGGLE_DEVELOPER/exercise-as-with` into the current working directory:
+
+    ```bash
+    kaggle kernels pull --wp $KAGGLE_DEVELOPER/exercise-as-with/2
+    ```
+
 **Purpose:**
 
 This command allows you to download the source code and optionally the metadata of a kernel from Kaggle to your local machine.

kaggle-2.2.3/docs/output_format.md

@@ -0,0 +1,140 @@
+# Kaggle CLI Output Formatting Documentation
+
+This documentation describes the output formatting options available in the Kaggle CLI.
+
+## Output Format Options
+
+The Kaggle CLI supports choosing the output format for various commands that list information.
+
+### `--csv` (or `-v`)
+
+Historically, many commands supported a `-v` or `--csv` option to display output as comma-separated values (CSV) instead of a formatted table.
+
+Example:
+```sh
+kaggle competitions list --csv
+```
+
+### `--format`
+
+We have introduced a new `--format` option to provide a unified way to specify the output format.
+It accepts the following values:
+*   `csv`: Display output as comma-separated values.
+*   `table`: Display output as a formatted table (default).
+*   `json`: Display output as JSON.
+
+Example:
+```sh
+kaggle competitions list --format csv
+kaggle competitions list --format table
+kaggle competitions list --format json
+```
+
+For most commands, the JSON output is a list of objects representing the rows, with keys corresponding to the column headers. For detailed commands like `topics show`, it returns a structured object:
+```json
+{
+  "topic": { ... },
+  "comments": [ ... ]
+}
+```
+
+### Projections (Field Selection)
+
+The `--format` option supports optional `gcloud`-style field selection (projections) by appending a comma-separated list of fields in parentheses to the format name. This allows you to limit the output to only the specified fields and control their order.
+
+Projections are supported for all formats (`csv`, `table`, `json`).
+
+Example:
+```sh
+# Only show 'ref' and 'reward' columns for competitions in a table
+kaggle competitions list --format "table(ref,reward)"
+
+# Export only 'id' and 'publicScore' to JSON for team submissions
+kaggle competitions team-submissions --format "json(id,publicScore)" <team_id>
+
+# Export only 'name' and 'size' to CSV for dataset files
+kaggle datasets files -d zillow/zecon --format "csv(name,size)"
+```
+
+You can specify fields using either their field names (e.g. `totalBytes`) or their display labels (e.g. `size`). If a field is not recognized, the CLI will display an error listing the allowed fields.
+
+#### Special Case: Topics Show
+
+For `topics show` commands, which output both a parent topic and a list of comments, the projection is applied to both types of objects. Fields matching the topic are applied to the topic output, and fields matching comments are applied to the comment output.
+
+Example:
+```sh
+kaggle forums topics show 123 --format "json(title,content)"
+```
+In this case, `title` (which is a topic field) will be preserved in the topic output, and `content` (which is a comment field) will be preserved in the comments output.
+```json
+{
+  "topic": {
+    "title": "Test Title"
+  },
+  "comments": [
+    {
+      "content": "Comment Content"
+    }
+  ]
+}
+```
+
+### Mutual Exclusion
+
+The `--csv` (or `-v`) option and the `--format` option are **mutually exclusive**. You cannot specify both at the same time.
+
+If you attempt to use both, the CLI will display an error:
+```sh
+kaggle competitions list --csv --format csv
+# Error: argument --format: not allowed with argument -v/--csv
+```
+
+## Supported Commands
+
+The following commands support both `--csv` (legacy) and `--format` options:
+
+### Competitions
+*   `kaggle competitions list`
+*   `kaggle competitions files`
+*   `kaggle competitions submissions`
+*   `kaggle competitions leaderboard`
+*   `kaggle competitions team-submissions`
+*   `kaggle competitions episodes`
+*   `kaggle competitions pages`
+*   `kaggle competitions topic-messages`
+*   `kaggle competitions topics list`
+*   `kaggle competitions topics show`
+
+### Datasets
+*   `kaggle datasets list`
+*   `kaggle datasets files`
+*   `kaggle datasets topics list`
+*   `kaggle datasets topics show`
+
+### Kernels
+*   `kaggle kernels list`
+*   `kaggle kernels files`
+*   `kaggle kernels topics list`
+*   `kaggle kernels topics show`
+
+### Models
+*   `kaggle models list`
+*   `kaggle models topics list`
+*   `kaggle models topics show`
+*   `kaggle models instances list`
+*   `kaggle models instances files`
+*   `kaggle models instances versions list`
+*   `kaggle models instances versions files`
+
+### Forums
+*   `kaggle forums list`
+*   `kaggle forums topics list`
+*   `kaggle forums topics show`
+
+### Benchmarks
+*   `kaggle benchmarks topics list`
+*   `kaggle benchmarks topics show`
+
+### Quota
+*   `kaggle quota`

{kaggle-2.2.2 → kaggle-2.2.3}/pyproject.toml

@@ -55,9 +55,9 @@ dependencies = [
 ]
 
 [tool.hatch.envs.test.scripts]
-local = "source tools/use-localhost.sh; cd tests; python unit_tests.py --failfast"
-prod = "source tools/use-prod.sh; cd tests; python unit_tests.py --failfast"
-integration = "pytest integration_tests"
+local = "source tools/use-localhost.sh; cd tests/backend; python backend_tests.py --failfast"
+prod = "source tools/use-prod.sh; cd tests/backend; python backend_tests.py --failfast"
+integration = "pytest tests/integration"
 
 [tool.hatch.envs.lint]
 detached = true
@@ -105,7 +105,6 @@ ignore_missing_imports = true
 
 [tool.pytest.ini_options]
 testpaths = [
-    "src/kaggle/test",
-    "tests",
+    "tests/unit",
 ]
 pythonpath = ["src"]

{kaggle-2.2.2 → kaggle-2.2.3}/src/kaggle/__init__.py

@@ -2,7 +2,7 @@
 from __future__ import absolute_import
 from kaggle.api.kaggle_api_extended import KaggleApi
 
-__version__ = "2.2.2"
+__version__ = "2.2.3"
 
 api = KaggleApi()
 api.authenticate()