kaggle 1.7.3b1__py3-none-any.whl

kagglesdk/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 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.

kagglesdk/__init__.py

@@ -0,0 +1,2 @@
+from kagglesdk.kaggle_client import KaggleClient
+from kagglesdk.kaggle_env import KaggleEnv

kagglesdk/admin/services/inbox_file_service.py

@@ -0,0 +1,22 @@
+from kagglesdk.admin.types.inbox_file_service import CreateInboxFileRequest, CreateInboxFileResponse
+from kagglesdk.kaggle_http_client import KaggleHttpClient
+
+class InboxFileClient(object):
+  """File drop/pickup functionality."""
+
+  def __init__(self, client: KaggleHttpClient):
+    self._client = client
+
+  def create_inbox_file(self, request: CreateInboxFileRequest = None) -> CreateInboxFileResponse:
+    r"""
+    Creates (aka 'drops') a new file into the inbox.
+
+    Args:
+      request (CreateInboxFileRequest):
+        The request object; initialized to empty instance if not specified.
+    """
+
+    if request is None:
+      request = CreateInboxFileRequest()
+
+    return self._client.call("admin.InboxFileService", "CreateInboxFile", request, CreateInboxFileResponse)

kagglesdk/admin/types/inbox_file_service.py

@@ -0,0 +1,74 @@
+from kagglesdk.kaggle_object import *
+
+class CreateInboxFileRequest(KaggleObject):
+  r"""
+  Attributes:
+    virtual_directory (str)
+      Directory name used for tagging the uploaded file.
+    blob_file_token (str)
+      Token representing the uploaded file.
+  """
+
+  def __init__(self):
+    self._virtual_directory = ""
+    self._blob_file_token = ""
+    self._freeze()
+
+  @property
+  def virtual_directory(self) -> str:
+    """Directory name used for tagging the uploaded file."""
+    return self._virtual_directory
+
+  @virtual_directory.setter
+  def virtual_directory(self, virtual_directory: str):
+    if virtual_directory is None:
+      del self.virtual_directory
+      return
+    if not isinstance(virtual_directory, str):
+      raise TypeError('virtual_directory must be of type str')
+    self._virtual_directory = virtual_directory
+
+  @property
+  def blob_file_token(self) -> str:
+    """Token representing the uploaded file."""
+    return self._blob_file_token
+
+  @blob_file_token.setter
+  def blob_file_token(self, blob_file_token: str):
+    if blob_file_token is None:
+      del self.blob_file_token
+      return
+    if not isinstance(blob_file_token, str):
+      raise TypeError('blob_file_token must be of type str')
+    self._blob_file_token = blob_file_token
+
+  def endpoint(self):
+    path = '/api/v1/inbox/files/create'
+    return path.format_map(self.to_field_map(self))
+
+
+  @staticmethod
+  def method():
+    return 'POST'
+
+  @staticmethod
+  def body_fields():
+    return '*'
+
+
+class CreateInboxFileResponse(KaggleObject):
+  r"""
+  NOTE: This is sent to non-admins, so we're intentionally *NOT* sending back
+  the full InboxFile (with its URL for a direct download).
+
+  """
+
+  pass
+
+CreateInboxFileRequest._fields = [
+  FieldMetadata("virtualDirectory", "virtual_directory", "_virtual_directory", str, "", PredefinedSerializer()),
+  FieldMetadata("blobFileToken", "blob_file_token", "_blob_file_token", str, "", PredefinedSerializer()),
+]
+
+CreateInboxFileResponse._fields = []
+

kagglesdk/blobs/services/blob_api_service.py

@@ -0,0 +1,25 @@
+from kagglesdk.blobs.types.blob_api_service import ApiStartBlobUploadRequest, ApiStartBlobUploadResponse
+from kagglesdk.kaggle_http_client import KaggleHttpClient
+
+class BlobApiClient(object):
+  r"""
+  Binary Large OBject (BLOB) service used for uploading files to Google Cloud
+  Storage (GCS).
+  """
+
+  def __init__(self, client: KaggleHttpClient):
+    self._client = client
+
+  def start_blob_upload(self, request: ApiStartBlobUploadRequest = None) -> ApiStartBlobUploadResponse:
+    r"""
+    Starts a blob upload (i.e. reserves a spot for the upload on GCS).
+
+    Args:
+      request (ApiStartBlobUploadRequest):
+        The request object; initialized to empty instance if not specified.
+    """
+
+    if request is None:
+      request = ApiStartBlobUploadRequest()
+
+    return self._client.call("blobs.BlobApiService", "ApiStartBlobUpload", request, ApiStartBlobUploadResponse)

kagglesdk/blobs/types/blob_api_service.py

@@ -0,0 +1,177 @@
+import enum
+from kagglesdk.kaggle_object import *
+from typing import Optional
+
+class ApiBlobType(enum.Enum):
+  API_BLOB_TYPE_UNSPECIFIED = 0
+  DATASET = 1
+  MODEL = 2
+  INBOX = 3
+
+class ApiStartBlobUploadRequest(KaggleObject):
+  r"""
+  Attributes:
+    type (ApiBlobType)
+      The type of the blob.
+    name (str)
+      Name (e.g. file name) of the blob.
+    content_type (str)
+      Content/MIME type (e.g. 'text/plain').
+    content_length (int)
+      Size in bytes of the blob.
+    last_modified_epoch_seconds (int)
+      Optional user-reported time when the blob was last updated/modified.
+  """
+
+  def __init__(self):
+    self._type = ApiBlobType.API_BLOB_TYPE_UNSPECIFIED
+    self._name = ""
+    self._content_type = None
+    self._content_length = 0
+    self._last_modified_epoch_seconds = None
+    self._freeze()
+
+  @property
+  def type(self) -> 'ApiBlobType':
+    """The type of the blob."""
+    return self._type
+
+  @type.setter
+  def type(self, type: 'ApiBlobType'):
+    if type is None:
+      del self.type
+      return
+    if not isinstance(type, ApiBlobType):
+      raise TypeError('type must be of type ApiBlobType')
+    self._type = type
+
+  @property
+  def name(self) -> str:
+    """Name (e.g. file name) of the blob."""
+    return self._name
+
+  @name.setter
+  def name(self, name: str):
+    if name is None:
+      del self.name
+      return
+    if not isinstance(name, str):
+      raise TypeError('name must be of type str')
+    self._name = name
+
+  @property
+  def content_type(self) -> str:
+    """Content/MIME type (e.g. 'text/plain')."""
+    return self._content_type or ""
+
+  @content_type.setter
+  def content_type(self, content_type: str):
+    if content_type is None:
+      del self.content_type
+      return
+    if not isinstance(content_type, str):
+      raise TypeError('content_type must be of type str')
+    self._content_type = content_type
+
+  @property
+  def content_length(self) -> int:
+    """Size in bytes of the blob."""
+    return self._content_length
+
+  @content_length.setter
+  def content_length(self, content_length: int):
+    if content_length is None:
+      del self.content_length
+      return
+    if not isinstance(content_length, int):
+      raise TypeError('content_length must be of type int')
+    self._content_length = content_length
+
+  @property
+  def last_modified_epoch_seconds(self) -> int:
+    """Optional user-reported time when the blob was last updated/modified."""
+    return self._last_modified_epoch_seconds or 0
+
+  @last_modified_epoch_seconds.setter
+  def last_modified_epoch_seconds(self, last_modified_epoch_seconds: int):
+    if last_modified_epoch_seconds is None:
+      del self.last_modified_epoch_seconds
+      return
+    if not isinstance(last_modified_epoch_seconds, int):
+      raise TypeError('last_modified_epoch_seconds must be of type int')
+    self._last_modified_epoch_seconds = last_modified_epoch_seconds
+
+  def endpoint(self):
+    path = '/api/v1/blobs/upload'
+    return path.format_map(self.to_field_map(self))
+
+
+  @staticmethod
+  def method():
+    return 'POST'
+
+  @staticmethod
+  def body_fields():
+    return '*'
+
+
+class ApiStartBlobUploadResponse(KaggleObject):
+  r"""
+  Attributes:
+    token (str)
+      Opaque string token used to reference the new blob/file.
+    create_url (str)
+      URL to use to start the upload.
+  """
+
+  def __init__(self):
+    self._token = ""
+    self._create_url = ""
+    self._freeze()
+
+  @property
+  def token(self) -> str:
+    """Opaque string token used to reference the new blob/file."""
+    return self._token
+
+  @token.setter
+  def token(self, token: str):
+    if token is None:
+      del self.token
+      return
+    if not isinstance(token, str):
+      raise TypeError('token must be of type str')
+    self._token = token
+
+  @property
+  def create_url(self) -> str:
+    """URL to use to start the upload."""
+    return self._create_url
+
+  @create_url.setter
+  def create_url(self, create_url: str):
+    if create_url is None:
+      del self.create_url
+      return
+    if not isinstance(create_url, str):
+      raise TypeError('create_url must be of type str')
+    self._create_url = create_url
+
+  @property
+  def createUrl(self):
+    return self.create_url
+
+
+ApiStartBlobUploadRequest._fields = [
+  FieldMetadata("type", "type", "_type", ApiBlobType, ApiBlobType.API_BLOB_TYPE_UNSPECIFIED, EnumSerializer()),
+  FieldMetadata("name", "name", "_name", str, "", PredefinedSerializer()),
+  FieldMetadata("contentType", "content_type", "_content_type", str, None, PredefinedSerializer(), optional=True),
+  FieldMetadata("contentLength", "content_length", "_content_length", int, 0, PredefinedSerializer()),
+  FieldMetadata("lastModifiedEpochSeconds", "last_modified_epoch_seconds", "_last_modified_epoch_seconds", int, None, PredefinedSerializer(), optional=True),
+]
+
+ApiStartBlobUploadResponse._fields = [
+  FieldMetadata("token", "token", "_token", str, "", PredefinedSerializer()),
+  FieldMetadata("createUrl", "create_url", "_create_url", str, "", PredefinedSerializer()),
+]
+

kagglesdk/common/types/file_download.py

@@ -0,0 +1,102 @@
+from kagglesdk.kaggle_object import *
+from typing import Optional
+
+class FileDownload(KaggleObject):
+  r"""
+  Standard response object representing a file download.
+  See http://go/kaggle-proto-handler-file-downloads
+  Some field names/descriptions borrowed from
+  google3/gdata/rosy/proto/data.proto
+
+  Attributes:
+    content_type (str)
+      MIME type of the data
+      TODO(aip.dev/143): (-- api-linter: core::0143::standardized-codes=disabled
+      --)
+    file_name (str)
+      Original file name
+    token (str)
+      A unique fingerprint for the file/media data
+    content_length (int)
+      Size of the data, in bytes (if known)
+  """
+
+  def __init__(self):
+    self._content_type = ""
+    self._file_name = ""
+    self._token = ""
+    self._content_length = None
+    self._freeze()
+
+  @property
+  def content_type(self) -> str:
+    r"""
+    MIME type of the data
+    TODO(aip.dev/143): (-- api-linter: core::0143::standardized-codes=disabled
+    --)
+    """
+    return self._content_type
+
+  @content_type.setter
+  def content_type(self, content_type: str):
+    if content_type is None:
+      del self.content_type
+      return
+    if not isinstance(content_type, str):
+      raise TypeError('content_type must be of type str')
+    self._content_type = content_type
+
+  @property
+  def file_name(self) -> str:
+    """Original file name"""
+    return self._file_name
+
+  @file_name.setter
+  def file_name(self, file_name: str):
+    if file_name is None:
+      del self.file_name
+      return
+    if not isinstance(file_name, str):
+      raise TypeError('file_name must be of type str')
+    self._file_name = file_name
+
+  @property
+  def token(self) -> str:
+    """A unique fingerprint for the file/media data"""
+    return self._token
+
+  @token.setter
+  def token(self, token: str):
+    if token is None:
+      del self.token
+      return
+    if not isinstance(token, str):
+      raise TypeError('token must be of type str')
+    self._token = token
+
+  @property
+  def content_length(self) -> int:
+    """Size of the data, in bytes (if known)"""
+    return self._content_length or 0
+
+  @content_length.setter
+  def content_length(self, content_length: int):
+    if content_length is None:
+      del self.content_length
+      return
+    if not isinstance(content_length, int):
+      raise TypeError('content_length must be of type int')
+    self._content_length = content_length
+
+  @classmethod
+  def prepare_from(cls, http_response):
+    return http_response
+
+
+FileDownload._fields = [
+  FieldMetadata("contentType", "content_type", "_content_type", str, "", PredefinedSerializer()),
+  FieldMetadata("fileName", "file_name", "_file_name", str, "", PredefinedSerializer()),
+  FieldMetadata("token", "token", "_token", str, "", PredefinedSerializer()),
+  FieldMetadata("contentLength", "content_length", "_content_length", int, None, PredefinedSerializer(), optional=True),
+]
+