kaggle 1.6.10__tar.gz → 1.6.11__tar.gz

{kaggle-1.6.10/kaggle.egg-info → kaggle-1.6.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kaggle
-Version: 1.6.10
+Version: 1.6.11
 Summary: Kaggle API
 Home-page: https://github.com/Kaggle/kaggle-api
 Author: Kaggle

kaggle-1.6.11/README.md

@@ -0,0 +1,101 @@
+# Kaggle API
+
+Official API for https://www.kaggle.com, accessible using a command line tool implemented in Python 3.  
+
+[User documentation](docs/README.md)
+
+## Installation
+
+Ensure you have Python 3 and the package manager `pip` installed.
+
+Run the following command to access the Kaggle API using the command line:
+
+```sh
+pip install kaggle
+```
+
+## 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.
+
+### Dependencies
+
+```sh
+hatch run install-deps
+```
+
+### Compile
+
+```sh
+hatch run compile
+```
+
+The compiled files are generated in the `kaggle/` directory from the `src/` directory.
+
+All the changes must be done in the `src/` directory.
+
+### Run
+
+You can also run the code in python directly:
+
+```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 = [...]
+[...]
+
+```
+
+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()"
+```
+
+### Example
+
+Let's change the `model_list_cli` method in the source file: 
+
+```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 = [...]
+```
+
+### Integration Tests
+
+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
+
+After setting up your credentials by any of these methods, you can run the integration tests as follows:
+
+```sh
+# Run all tests
+hatch run integration-test
+```
+
+## License
+
+The Kaggle API is released under the [Apache 2.0 license](LICENSE).

kaggle-1.6.11/kaggle/__init__.py

@@ -0,0 +1,7 @@
+# coding=utf-8
+from __future__ import absolute_import
+from kaggle.api.kaggle_api_extended import KaggleApi
+from kaggle.api_client import ApiClient
+
+api = KaggleApi(ApiClient())
+api.authenticate()

kaggle-1.6.11/kaggle/api/__init__.py

@@ -0,0 +1,6 @@
+from __future__ import absolute_import
+
+# flake8: noqa
+
+# import apis into api package
+from kaggle.api.kaggle_api_extended import KaggleApi

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/api/kaggle_api.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/api/kaggle_api_extended.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 #!/usr/bin/python
 #
 # Copyright 2019 Kaggle Inc
@@ -272,7 +256,7 @@ class ResumableFileUpload(object):
 
 
 class KaggleApi(KaggleApi):
-    __version__ = '1.6.10'
+    __version__ = '1.6.11'
 
     CONFIG_NAME_PROXY = 'proxy'
     CONFIG_NAME_COMPETITION = 'competition'
@@ -335,6 +319,10 @@ class KaggleApi(KaggleApi):
         'hotness', 'downloadCount', 'voteCount', 'notebookCount', 'createTime'
     ]
 
+    # Command prefixes that are valid without authentication.
+    command_prefixes_allowing_anonymous_access = ('datasets download',
+                                                  'datasets files')
+
     # Hack for https://github.com/Kaggle/kaggle-api/issues/22 / b/78194015
     if six.PY2:
         reload(sys)
@@ -390,6 +378,8 @@ class KaggleApi(KaggleApi):
         """
 
         config_data = {}
+        # Ex: 'datasets list', 'competitions files', 'models instances get', etc.
+        api_command = ' '.join(sys.argv[1:])
 
         # Step 1: try getting username/password from environment
         config_data = self.read_config_environment(config_data)
@@ -399,6 +389,11 @@ class KaggleApi(KaggleApi):
                 or self.CONFIG_NAME_KEY not in config_data:
             if os.path.exists(self.config):
                 config_data = self.read_config_file(config_data)
+            elif self._is_help_or_version_command(api_command) or (
+                    len(sys.argv) > 2 and api_command.startswith(
+                        self.command_prefixes_allowing_anonymous_access)):
+                # Some API commands should be allowed without authentication.
+                return
             else:
                 raise IOError('Could not find {}. Make sure it\'s located in'
                               ' {}. Or use the environment method.'.format(
@@ -407,6 +402,16 @@ class KaggleApi(KaggleApi):
         # Step 3: load into configuration!
         self._load_config(config_data)
 
+    def _is_help_or_version_command(self, api_command):
+        """determines if the string command passed in is for a help or version
+           command.
+           Parameters
+           ==========
+           api_command: a string, 'datasets list', 'competitions files',
+                        'models instances get', etc.
+        """
+        return api_command.endswith(('-h', '--help', '-v', '--version'))
+
     def read_config_environment(self, config_data=None, quiet=False):
         """read_config_environment is the second effort to get a username
            and key to authenticate to the Kaggle API. The environment keys
@@ -1367,7 +1372,8 @@ class KaggleApi(KaggleApi):
                               file_name,
                               path=None,
                               force=False,
-                              quiet=True):
+                              quiet=True,
+                              licenses=[]):
         """ download a single file for a dataset
 
             Parameters
@@ -1378,15 +1384,16 @@ class KaggleApi(KaggleApi):
             path: if defined, download to this location
             force: force the download if the file already exists (default False)
             quiet: suppress verbose output (default is True)
+            licenses: a list of license names, e.g. ['CC0-1.0']
         """
         if '/' in dataset:
             self.validate_dataset_string(dataset)
-            dataset_urls = dataset.split('/')
-            owner_slug = dataset_urls[0]
-            dataset_slug = dataset_urls[1]
+            owner_slug, dataset_slug, dataset_version_number = self.split_dataset_string(
+                dataset)
         else:
             owner_slug = self.get_config_value(self.CONFIG_NAME_USER)
             dataset_slug = dataset
+            dataset_version_number = None
 
         if path is None:
             effective_path = self.get_default_download_dir(
@@ -1394,10 +1401,14 @@ class KaggleApi(KaggleApi):
         else:
             effective_path = path
 
+        self._print_dataset_url_and_license(owner_slug, dataset_slug,
+                                            dataset_version_number, licenses)
+
         response = self.process_response(
             self.datasets_download_file_with_http_info(
                 owner_slug=owner_slug,
                 dataset_slug=dataset_slug,
+                dataset_version_number=dataset_version_number,
                 file_name=file_name,
                 _preload_content=False))
         url = response.retries.history[0].redirect_location.split('?')[0]
@@ -1413,7 +1424,8 @@ class KaggleApi(KaggleApi):
                                path=None,
                                force=False,
                                quiet=True,
-                               unzip=False):
+                               unzip=False,
+                               licenses=[]):
         """ download all files for a dataset
 
             Parameters
@@ -1424,6 +1436,7 @@ class KaggleApi(KaggleApi):
             force: force the download if the file already exists (default False)
             quiet: suppress verbose output (default is True)
             unzip: if True, unzip files upon download (default is False)
+            licenses: a list of license names, e.g. ['CC0-1.0']
         """
         if dataset is None:
             raise ValueError('A dataset must be specified')
@@ -1435,6 +1448,9 @@ class KaggleApi(KaggleApi):
         else:
             effective_path = path
 
+        self._print_dataset_url_and_license(owner_slug, dataset_slug,
+                                            dataset_version_number, licenses)
+
         response = self.process_response(
             self.datasets_download_with_http_info(
                 owner_slug=owner_slug,
@@ -1465,6 +1481,19 @@ class KaggleApi(KaggleApi):
                 except OSError as e:
                     print('Could not delete zip file, got %s' % e)
 
+    def _print_dataset_url_and_license(self, owner_slug, dataset_slug,
+                                       dataset_version_number, licenses):
+        if dataset_version_number is None:
+            print('Dataset URL: https://www.kaggle.com/datasets/%s/%s' %
+                  (owner_slug, dataset_slug))
+        else:
+            print(
+                'Dataset URL: https://www.kaggle.com/datasets/%s/%s/versions/%s'
+                % (owner_slug, dataset_slug, dataset_version_number))
+
+        if len(licenses) > 0:
+            print('License(s): %s' % (','.join(licenses)))
+
     def dataset_download_cli(self,
                              dataset,
                              dataset_opt=None,
@@ -1489,18 +1518,37 @@ class KaggleApi(KaggleApi):
             unzip: if True, unzip files upon download (default is False)
         """
         dataset = dataset or dataset_opt
+
+        owner_slug, dataset_slug, _ = self.split_dataset_string(dataset)
+        metadata = self.process_response(
+            self.metadata_get_with_http_info(owner_slug, dataset_slug))
+
+        if 'info' in metadata and 'licenses' in metadata['info']:
+            # license_objs format is like: [{ 'name': 'CC0-1.0' }]
+            license_objs = metadata['info']['licenses']
+            licenses = [
+                license_obj['name'] for license_obj in license_objs
+                if 'name' in license_obj
+            ]
+        else:
+            licenses = [
+                'Error retrieving license. Please visit the Dataset URL to view license information.'
+            ]
+
         if file_name is None:
             self.dataset_download_files(dataset,
                                         path=path,
                                         unzip=unzip,
                                         force=force,
-                                        quiet=quiet)
+                                        quiet=quiet,
+                                        licenses=licenses)
         else:
             self.dataset_download_file(dataset,
                                        file_name,
                                        path=path,
                                        force=force,
-                                       quiet=quiet)
+                                       quiet=quiet,
+                                       licenses=licenses)
 
     def _upload_blob(self, path, quiet, blob_type, upload_context):
         """ upload a file

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/api_client.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 """
     Kaggle API

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/cli.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 #!/usr/bin/python
 #
 # Copyright 2019 Kaggle Inc

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/configuration.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/__init__.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 # flake8: noqa

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/api_blob_type.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/collaborator.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/create_inbox_file_request.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/dataset_column.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/dataset_new_request.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/dataset_new_version_request.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/dataset_update_settings_request.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/error.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/kaggle_models_extended.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 #!/usr/bin/python
 #
 # Copyright 2019 Kaggle Inc

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/kernel_push_request.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """

{kaggle-1.6.10 → kaggle-1.6.11}/kaggle/models/license.py

@@ -1,19 +1,3 @@
-#!/usr/bin/python
-#
-# Copyright 2024 Kaggle Inc
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 # coding: utf-8
 
 """