kaggle 1.7.4.5__tar.gz → 1.8.0__tar.gz

{kaggle-1.7.4.5 → kaggle-1.8.0}/.gitignore

@@ -15,6 +15,10 @@ dist/
 downloads/
 eggs/
 .eggs/
+kaggle
+kagglesdk
+!*/kaggle/
+!*/kagglesdk/
 lib/
 lib64/
 parts/
@@ -65,3 +69,6 @@ target/
 
 # Rider/IntelliJ
 .idea/
+
+# Gemini
+.gemini

{kaggle-1.7.4.5 → kaggle-1.8.0}/CHANGELOG.md

@@ -1,21 +1,44 @@
 Changelog
 ====
 
-### 1.7.4.5
-
-A versioning error caused 1.7.4.4 to not be release.
-
-### 1.7.4.4
-
-Version 1.7.4.3 was not release because pre-release testing discovered a bug.
-The changes in this release are the same as 1.7.4.3.
-
-### 1.7.4.3
-
-* Fix a problem downloading dataset files (#751)
-* Fix competitions category 'all' (#740)
-* Clean up indentation per #754
-* Fix a problem downloading competition files (#739)
+### 1.8.0
+
+* Fix resumable download error (#865)
+* Fix dataset version spec (#862)
+* Add machine_shape to the metadata of kaggle kernels pull (#856)
+* Add pagination options to models
+* Add pagination options for submissions (#832)
+* Add pagination options to list commands (#815)
+* Add canonical aliases for push/pull (#787)
+* Add parquet as a filter option (#786)
+* Add variations as alt for instances (#784)
+* Enable (and rename) synonyms i and v (#782)
+
+### 1.7.5.0 (not released)
+
+* Require Python 3.11.
+* Add KernelExecutionType (#775)
+* Output docker_image as part of the pull metadata (#773)
+* Allow user to specify docker_image during kernel push (#774)
+* Add kernel version type to save request (#771)
+* Add tests for delete and de-flake (#769)
+* Rename "yes" params and make confirmation consistent (#765)
+* Fix bug that caused double serialization (#764)
+* Add kaggle kernels delete (#762)
+* Add test for dataset_delete() and make script more robust (#760)
+* Check dataset status before uploading (#759)
+* Add kaggle datasets delete (#755)
+* Fix calls to download_file() (#752)
+* Add type annotations for mypy (#746)
+* Use Optional[...] in cases where the proto file does (#744)
+* Improve some type hints and fix a bug (#741)
+* Reformat everything with black (#737)
+* Add more type hints (#736)
+* Add type annotations to main file (#735)
+* Bulk reformat docstrings (#732)
+* Merge envars before sending a request (#729)
+* Use PROD if no environment is specified. (#726)
+* Add a no response action to auto-close issues (#723)
 
 ### 1.7.4.2
 

kaggle-1.8.0/GEMINI.md

@@ -0,0 +1,45 @@
+# Coworker Relationship
+- We are a team. Your success is my success.
+- I'm your boss, but we're informal.
+- We both have valuable, complementary experience.
+- It's okay to admit when we don't know something.
+- Push back with evidence.
+
+# Coding Standards
+- Use simple, clean, and maintainable solutions.
+- Make the smallest reasonable changes. Ask for permission before rewriting.
+- Match the existing code style.
+- Stay on task. Create issues for unrelated fixes.
+- Don't remove comments unless they are false.
+- Use evergreen comments.
+- No mock implementations.
+- Do not rewrite code to fix a bug without permission.
+- Use evergreen naming conventions.
+
+# Documentation
+- Store documentation in the `documentation` directory.
+- Use Markdown and create an index named `intro.md` with links.
+- Document all commands, sub-commands, and options with examples.
+
+# Anlyzing Python Code
+- When analyzing Python code, use the `api` module to parse it, UNLESS instructed otherwise.
+- Use `api.get_docstring()` to locate a docstring for an item.
+- To find type hints, walk the AST using `api.walk_tree()` looking for type parameters with `ast.TypeVar()`, `ast.ParamSpec()`, and `ast.TypeVarTuple()`.
+
+# Getting Help
+- Ask for clarification.
+- Ask for help when needed.
+
+# Testing
+- Tests must cover the implemented functionality.
+- Pay attention to logs and test output.
+- Test output must be pristine.
+- Test for expected errors.
+- Practice TDD:
+    1. Write a failing test.
+    2. Write the minimum code to pass the test.
+    3. Refactor.
+    4. Repeat.
+
+# Specific Technologies
+- @~/.gemini/docs/python.md

{kaggle-1.7.4.5 → kaggle-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kaggle
-Version: 1.7.4.5
+Version: 1.8.0
 Summary: Access Kaggle resources anywhere
 Project-URL: Homepage, https://github.com/Kaggle/kaggle-api
 Project-URL: Issues, https://github.com/Kaggle/kaggle-api/issues
@@ -211,21 +211,20 @@ Keywords: API,Kaggle
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.7
+Requires-Python: >=3.11
+Requires-Dist: black>=24.10.0
 Requires-Dist: bleach
-Requires-Dist: certifi>=14.05.14
-Requires-Dist: charset-normalizer
-Requires-Dist: idna
+Requires-Dist: kagglesdk
+Requires-Dist: mypy>=1.15.0
 Requires-Dist: protobuf
-Requires-Dist: python-dateutil>=2.5.3
 Requires-Dist: python-slugify
 Requires-Dist: requests
 Requires-Dist: setuptools>=21.0.0
 Requires-Dist: six>=1.10
-Requires-Dist: text-unidecode
 Requires-Dist: tqdm
+Requires-Dist: types-requests
+Requires-Dist: types-tqdm
 Requires-Dist: urllib3>=1.15.1
-Requires-Dist: webencodings
 Description-Content-Type: text/markdown
 
 # Kaggle API
@@ -253,13 +252,6 @@ or adding to those services, you should be working in your Kaggle mid-tier devel
 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.
 
-Also, run the following command to get `autogen.sh` installed:
-```bash
-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
-```
-
 ### Prerequisites
 
 We use [hatch](https://hatch.pypa.io) to manage this project.
@@ -287,6 +279,10 @@ All the changes must be done in the `src/` directory.
 
 ### Run
 
+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`.
+
 You can also run the code in python directly:
 
 ```sh

{kaggle-1.7.4.5 → kaggle-1.8.0}/README.md

@@ -23,13 +23,6 @@ or adding to those services, you should be working in your Kaggle mid-tier devel
 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.
 
-Also, run the following command to get `autogen.sh` installed:
-```bash
-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
-```
-
 ### Prerequisites
 
 We use [hatch](https://hatch.pypa.io) to manage this project.
@@ -57,6 +50,10 @@ All the changes must be done in the `src/` directory.
 
 ### Run
 
+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`.
+
 You can also run the code in python directly:
 
 ```sh

{kaggle-1.7.4.5 → kaggle-1.8.0}/docs/README.md

@@ -25,30 +25,12 @@ IMPORTANT: We do not offer Python 2 support.  Please ensure that you are using P
 
 ## API credentials
 
-To use the Kaggle API, sign up for a Kaggle account at https://www.kaggle.com. Then go to the 'Account' tab of your user profile (`https://www.kaggle.com/<username>/account`) and select 'Create API Token'. This will trigger the download of `kaggle.json`, a file containing your API credentials.
-Place this file in the location appropriate for your operating system:
-* Linux: `$XDG_CONFIG_HOME/kaggle/kaggle.json` (defaults to `~/.config/kaggle/kaggle.json`). The path `~/.kaggle/kaggle.json` which was used by older versions of the tool is also still supported.
-* Windows: `C:\Users\<Windows-username>\.kaggle\kaggle.json` - you can check the exact location, sans drive, with `echo %HOMEPATH%`.
-* Other: `~/.kaggle/kaggle.json`
+To use the Kaggle API, sign up for a Kaggle account at https://www.kaggle.com. Then go to the 'Account' tab of your user profile (`https://www.kaggle.com/<username>/account`) and select 'Generate New Token'. Copy the generated token and save it in an environment
+variable named `KAGGLE_API_TOKEN` or place the value in a file named `~/.kaggle/access_token`. (The file may optionally have a `.txt` extension.)
 
-You can define a shell environment variable `KAGGLE_CONFIG_DIR` to change this location to `$KAGGLE_CONFIG_DIR/kaggle.json` (on Windows it will be `%KAGGLE_CONFIG_DIR%\kaggle.json`).
-
-
-For your security, ensure that other users of your computer do not have read access to your credentials. On Unix-based systems you can do this with the following command: 
-
-`chmod 600 ~/.config/kaggle/kaggle.json`
-
-You can also choose to export your Kaggle username and token to the environment:
-
-```bash
-export KAGGLE_USERNAME=datadinosaur
-export KAGGLE_KEY=xxxxxxxxxxxxxx
-```
-In addition, you can export any other configuration value that normally would be in
-the `kaggle.json` in the format 'KAGGLE_<VARIABLE>' (note uppercase).  
-For example, if the file had the variable "proxy" you would export `KAGGLE_PROXY`
-and it would be discovered by the client.
+Note: If you already have a `~/.kaggle/kaggle.json` file with legacy API credentials, it will continue to work.
 
+What's noteworthy is that now when generating new tokens you do not have to update existing token usage. The old tokens will continue to work; previously they expired when a new token was generated.
 
 ## Commands
 
@@ -260,7 +242,7 @@ optional arguments:
   --sort-by SORT_BY     Sort list results. Default is 'hottest'. Valid options are 'hottest', 'votes', 'updated', and 'active'
   --max-size MAX_SIZE   Specify the maximum size of the dataset to return (bytes)
   --min-size MIN_SIZE   Specify the minimum size of the dataset to return (bytes)
-  --file-type FILE_TYPE Search for datasets with a specific file type. Default is 'all'. Valid options are 'all', 'csv', 'sqlite', 'json', and 'bigQuery'. Please note that bigQuery datasets cannot be downloaded
+  --file-type FILE_TYPE Search for datasets with a specific file type. Default is 'all'. Valid options are 'all', 'csv', 'sqlite', 'json', 'parquet', and 'bigQuery'. Please note that bigQuery datasets cannot be downloaded
   --license LICENSE_NAME 
                         Search for datasets with a specific license. Default is 'all'. Valid options are 'all', 'cc', 'gpl', 'odb', and 'other'
   --tags TAG_IDS        Search for datasets that have specific tags. Tag list should be comma separated                      
@@ -428,6 +410,22 @@ Example:
 
 `kaggle datasets status zillow/zecon`
 
+##### Delete a dataset
+
+```
+usage: kaggle datasets delete [-y] [-h] [dataset]
+
+required arguments:
+  dataset     Dataset URL suffix in format <owner>/<dataset-name> (use "kaggle datasets list" to show options)
+
+optional arguments:
+  -h, --help  show this help message and exit
+  -ym --yes   Sets any confirmation values to "yes" automatically. Users will not be asked to confirm.
+```
+
+Example:
+
+`kaggle datasets delete -y lastplacelarry/testdataset`
 
 ### Kernels
 
@@ -440,15 +438,34 @@ optional arguments:
   -h, --help            show this help message and exit
 
 commands:
-  {list,init,push,pull,output,status}
+  {get,list,init,push,pull,output,status}
+    get                 Get the code for a kernel (formerly pull)
     list                List available kernels
     init                Initialize metadata file for a kernel
-    push                Push new code to a kernel and run the kernel
-    pull                Pull down code from a kernel
+    push                Deprecated by update: Push new code to a kernel and run the kernel
+    pull                Deprecated by get: Pull down code from a kernel
     output              Get data output from the latest kernel run
+    update              Update a kernel with new code and run it (formerly push)
     status              Display the status of the latest kernel run
 ```
 
+##### Get a kernel
+
+```
+usage: kaggle kernels get [-h] [-p PATH] [-w] [-m] [kernel]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  kernel                Kernel URL suffix in format <owner>/<kernel-name> (use "kaggle kernels list" to show options)
+  -p PATH, --path PATH  Folder where file(s) will be downloaded, defaults to current working directory
+  -w, --wp              Download files to current working path
+  -m, --metadata        Generate metadata when pulling kernel
+```
+
+Example:
+
+`kaggle kernels get rtatman/list-of-5-day-challenges -p /path/to/dest`
+
 ##### List kernels
 
 ```
@@ -500,8 +517,8 @@ optional arguments:
 Example:
 
 `kaggle kernels init -p /path/to/folder`
-  
-##### Push a kernel
+
+##### Push a kernel (deprecated, use update)
 
 ```
 usage: kaggle kernels push [-h] -p FOLDER
@@ -518,7 +535,7 @@ Example:
 
 `kaggle kernels push -p /path/to/folder`
 
-##### Pull a kernel
+##### Pull a kernel (deprecated, use get)
 
 ```
 usage: kaggle kernels pull [-h] [-p PATH] [-w] [-m] [kernel]
@@ -555,6 +572,27 @@ Example:
 
 `kaggle kernels output mrisdal/exploring-survival-on-the-titanic -p /path/to/dest`
 
+##### Update a kernel
+
+```
+usage: kaggle kernels update [-h] -p FOLDER
+
+This command should only be used after "get". Use "create" to create a new kernel.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -t N, --timeout N     Limit the run time of a kernel to the given number  of seconds.
+                        The global maximum time will not be exceeded.
+  -p FOLDER, --path FOLDER
+                        Folder for upload, containing data files and a special kernel-metadata.json file
+                        (https://github.com/Kaggle/kaggle-api/wiki/Kernel-Metadata).
+                        Defaults to current working directory
+```
+
+Example:
+
+`kaggle kernels update -p /path/to/folder`
+
 ##### Get the status of the latest kernel run
 
 ```

{kaggle-1.7.4.5 → kaggle-1.8.0}/docs/conf.py

@@ -29,37 +29,37 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("."))
 
 # -- Project information -----------------------------------------------------
 
-project = 'kaggle'
-copyright = '2024, kaggle'
-author = 'kaggle'
+project = "kaggle"
+copyright = "2024, kaggle"
+author = "kaggle"
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinxarg.ext']
+extensions = ["sphinxarg.ext"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]

kaggle-1.8.0/documentation/Makefile

@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+SPHINX_APIDOC_OPTIONS=members,show-inheritance
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+cleaner: Makefile
+	rm -rf _build source

kaggle-1.8.0/documentation/competitions.md

@@ -0,0 +1,216 @@
+# Competitions Commands
+
+Commands for interacting with Kaggle competitions.
+
+For tutorials on how to submit to competitions :
+* [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 competitions list`
+
+Lists available competitions.
+
+**Usage:**
+
+```bash
+kaggle competitions list [options]
+```
+
+**Options:**
+
+*   `--group <GROUP>`: Filter by competition group. Valid options: `general`, `entered`, `inClass`.
+*   `--category <CATEGORY>`: Filter by competition category. Valid options: `all`, `featured`, `research`, `recruitment`, `gettingStarted`, `masters`, `playground`.
+*   `--sort-by <SORT_BY>`: Sort results. Valid options: `grouped`, `prize`, `earliestDeadline`, `latestDeadline`, `numberOfTeams`, `recentlyCreated` (default: `latestDeadline`).
+*   `-p, --page <PAGE>`: Page number for results (default: 1).
+*   `-s, --search <SEARCH_TERM>`: Search term.
+*   `-v, --csv`: Print results in CSV format.
+
+**Example:**
+
+List featured competitions in the general group, sorted by prize:
+
+```bash
+kaggle competitions list --group general --category featured --sort-by prize
+```
+
+**Purpose:**
+
+This command helps you discover new competitions or find specific ones based on various criteria.
+
+## `kaggle competitions files`
+
+Lists files for a specific competition.
+
+**Usage:**
+
+```bash
+kaggle competitions files <COMPETITION> [options]
+```
+
+**Arguments:**
+
+*   `<COMPETITION>`: Competition URL suffix (e.g., `titanic`).
+
+**Options:**
+
+*   `-v, --csv`: Print results in CSV format.
+*   `-q, --quiet`: Suppress verbose output.
+*   `--page-token <PAGE_TOKEN>`: Page token for results paging.
+*   `--page-size <PAGE_SIZE>`: Number of items to show on a page (default: 20, max: 200).
+
+**Example:**
+
+List the first 3 files for the "titanic" competition in CSV format, quietly:
+
+```bash
+kaggle competitions files titanic --page-size=3 -v -q
+```
+
+**Purpose:**
+
+Use this command to see the data files available for a competition before downloading them.
+
+## `kaggle competitions download`
+
+Downloads competition files.
+
+**Usage:**
+
+```bash
+kaggle competitions download <COMPETITION> [options]
+```
+
+**Arguments:**
+
+*   `<COMPETITION>`: Competition URL suffix (e.g., `titanic`).
+
+**Options:**
+
+*   `-f, --file <FILE_NAME>`: Specific file to download (downloads all if not specified).
+*   `-p, --path <PATH>`: Folder to download files to (defaults to current directory).
+*   `-w, --wp`: Download files to the current working path (equivalent to `-p .`).
+*   `-o, --force`: Force download, overwriting existing files.
+*   `-q, --quiet`: Suppress verbose output.
+
+**Examples:**
+
+1.  Download all files for the "titanic" competition to the current directory, overwriting existing files, quietly:
+
+    ```bash
+    kaggle competitions download titanic -w -o -q
+    ```
+
+2.  Download the `test.csv` file from the "titanic" competition to a folder named `tost`:
+
+    ```bash
+    kaggle competitions download titanic -f test.csv -p tost
+    ```
+
+**Purpose:**
+
+This command allows you to get the necessary data files for a competition onto your local machine.
+
+## `kaggle competitions submit`
+
+Makes a new submission to a competition.
+
+**Usage:**
+
+```bash
+kaggle competitions submit <COMPETITION> -f <FILE_NAME> -m <MESSAGE> [options]
+```
+
+**Arguments:**
+
+*   `<COMPETITION>`: Competition URL suffix (e.g., `house-prices-advanced-regression-techniques`).
+*   `-f, --file <FILE_NAME>`: The submission file.
+*   `-m, --message <MESSAGE>`: The submission message.
+
+**Options:**
+
+*   `-k, --kernel <KERNEL>`: Name of the kernel (notebook) to submit (for code competitions).
+*   `-v, --version <VERSION>`: Version of the kernel to submit.
+*   `-q, --quiet`: Suppress verbose output.
+
+**Example:**
+
+Submit `sample_submission.csv` to the "house-prices-advanced-regression-techniques" competition with the message "Test message":
+
+```bash
+kaggle competitions submit house-prices-advanced-regression-techniques -f sample_submission.csv -m "Test message"
+```
+
+**Purpose:**
+
+Use this command to upload your predictions or code to a competition for scoring.
+
+## `kaggle competitions submissions`
+
+Shows your past submissions for a competition.
+
+**Usage:**
+
+```bash
+kaggle competitions submissions <COMPETITION> [options]
+```
+
+**Arguments:**
+
+*   `<COMPETITION>`: Competition URL suffix (e.g., `house-prices-advanced-regression-techniques`).
+
+**Options:**
+
+*   `-v, --csv`: Print results in CSV format.
+*   `-q, --quiet`: Suppress verbose output.
+
+**Example:**
+
+Show submissions for "house-prices-advanced-regression-techniques" in CSV format, quietly:
+
+```bash
+kaggle competitions submissions house-prices-advanced-regression-techniques -v -q
+```
+
+**Purpose:**
+
+This command allows you to review your previous submission attempts and their scores.
+
+## `kaggle competitions leaderboard`
+
+Gets competition leaderboard information.
+
+**Usage:**
+
+```bash
+kaggle competitions leaderboard <COMPETITION> [options]
+```
+
+**Arguments:**
+
+*   `<COMPETITION>`: Competition URL suffix (e.g., `titanic`).
+
+**Options:**
+
+*   `-s, --show`: Show the top of the leaderboard in the console.
+*   `-d, --download`: Download the entire leaderboard to a CSV file.
+*   `-p, --path <PATH>`: Folder to download the leaderboard to (if `-d` is used).
+*   `-v, --csv`: Print results in CSV format (used with `-s`).
+*   `-q, --quiet`: Suppress verbose output.
+
+**Examples:**
+
+1.  Download the "titanic" leaderboard to a folder named `leaders`, quietly:
+
+    ```bash
+    kaggle competitions leaderboard titanic -d -p leaders -q
+    ```
+
+2.  Download the leaderboard and save it to `leaderboard.txt`:
+
+    ```bash
+    kaggle competitions leaderboard titanic > leaderboard.txt
+    ```
+
+**Purpose:**
+
+This command lets you view your ranking and the scores of other participants in a competition.