kscale 0.0.1__tar.gz

kscale-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Benjamin Bolte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kscale-0.0.1/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include kscale/ *.py *.txt py.typed MANIFEST.in

kscale-0.0.1/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: kscale
+Version: 0.0.1
+Summary: The kscale project
+Home-page: https://github.com/kscalelabs/kscale
+Author: Benjamin Bolte
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: omegaconf
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: darglint; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: datamodel-code-generator; extra == "dev"
+
+# K-Scale Command Line Interface
+
+This is a command line tool for interacting with various services provided by K-Scale Labs, such as:
+
+- [K-Scale Store](https://kscale.store/)
+
+## Installation
+
+```bash
+pip install kscale
+```

kscale-0.0.1/README.md

@@ -0,0 +1,11 @@
+# K-Scale Command Line Interface
+
+This is a command line tool for interacting with various services provided by K-Scale Labs, such as:
+
+- [K-Scale Store](https://kscale.store/)
+
+## Installation
+
+```bash
+pip install kscale
+```

kscale-0.0.1/kscale/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

kscale-0.0.1/kscale/conf.py

@@ -0,0 +1,53 @@
+"""Defines the bot environment settings."""
+
+import functools
+import os
+import warnings
+from dataclasses import dataclass, field
+from pathlib import Path
+
+from omegaconf import II, OmegaConf
+
+
+def get_path() -> Path:
+    if "KSCALE_CONFIG_DIR" in os.environ:
+        return Path(os.environ["KSCALE_CONFIG_DIR"]).expanduser().resolve()
+    return Path("~/.kscale/").expanduser().resolve()
+
+
+@dataclass
+class StoreSettings:
+    api_key: str = field(default=II("oc.env:KSCALE_API_KEY"))
+
+    def get_api_key(self) -> str:
+        try:
+            return self.api_key
+        except AttributeError:
+            raise ValueError(
+                "API key not found! Get one here and set it as the `KSCALE_API_KEY` "
+                "environment variable: https://kscale.store/keys"
+            )
+
+
+@dataclass
+class Settings:
+    store: StoreSettings = StoreSettings()
+
+    def save(self) -> None:
+        (dir_path := get_path()).mkdir(parents=True, exist_ok=True)
+        with open(dir_path / "settings.yaml", "w") as f:
+            OmegaConf.save(config=self, f=f)
+
+    @functools.lru_cache
+    @staticmethod
+    def load() -> "Settings":
+        config = OmegaConf.structured(Settings)
+        if not (dir_path := get_path()).exists():
+            warnings.warn(f"Settings directory does not exist: {dir_path}. Creating it now.")
+            dir_path.mkdir(parents=True)
+            OmegaConf.save(config, dir_path / "settings.yaml")
+        else:
+            with open(dir_path / "settings.yaml", "r") as f:
+                raw_settings = OmegaConf.load(f)
+                config = OmegaConf.merge(config, raw_settings)
+        return config

kscale-0.0.1/kscale/requirements-dev.txt

@@ -0,0 +1,11 @@
+# requirements-dev.txt
+
+# For linting code.
+black
+darglint
+mypy
+pytest
+ruff
+
+# For generating API types.
+datamodel-code-generator

kscale-0.0.1/kscale/requirements.txt

@@ -0,0 +1,3 @@
+# requirements.txt
+
+omegaconf

kscale-0.0.1/kscale/store/auth.py

@@ -0,0 +1,13 @@
+"""Defines utility functions for authenticating the K-Scale Store API."""
+
+from kscale.conf import Settings
+
+
+def get_api_key() -> str:
+    try:
+        return Settings.load().store.api_key
+    except AttributeError:
+        raise ValueError(
+            "API key not found! Get one here and set it as the `KSCALE_API_KEY` "
+            "environment variable: https://kscale.store/keys"
+        )

kscale-0.0.1/kscale/store/gen/api.py

@@ -0,0 +1,267 @@
+"""Auto-generated by generate.sh script."""
+
+# generated by datamodel-codegen:
+#   filename:  openapi.json
+#   timestamp: 2024-08-19T06:07:36+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import List, Optional, Union
+
+from pydantic import BaseModel, EmailStr, Field
+
+
+class ArtifactUrls(BaseModel):
+    small: Optional[str] = Field(None, title="Small")
+    large: str = Field(..., title="Large")
+
+
+class AuthResponse(BaseModel):
+    api_key: str = Field(..., title="Api Key")
+
+
+class BodySetUrdfUrdfUploadListingIdPost(BaseModel):
+    file: bytes = Field(..., title="File")
+
+
+class BodyUploadArtifactsUploadListingIdPost(BaseModel):
+    files: List[bytes] = Field(..., title="Files")
+
+
+class ClientIdResponse(BaseModel):
+    client_id: str = Field(..., title="Client Id")
+
+
+class DeleteTokenResponse(BaseModel):
+    message: str = Field(..., title="Message")
+
+
+class EmailSignUpRequest(BaseModel):
+    email: EmailStr = Field(..., title="Email")
+
+
+class EmailSignUpResponse(BaseModel):
+    message: str = Field(..., title="Message")
+
+
+class GetListingResponse(BaseModel):
+    id: str = Field(..., title="Id")
+    name: str = Field(..., title="Name")
+    description: Optional[str] = Field(..., title="Description")
+    child_ids: List[str] = Field(..., title="Child Ids")
+    tags: List[str] = Field(..., title="Tags")
+    can_edit: bool = Field(..., title="Can Edit")
+
+
+class GetTokenResponse(BaseModel):
+    id: str = Field(..., title="Id")
+    email: str = Field(..., title="Email")
+
+
+class GithubAuthRequest(BaseModel):
+    code: str = Field(..., title="Code")
+
+
+class GithubAuthResponse(BaseModel):
+    api_key: str = Field(..., title="Api Key")
+
+
+class GoogleLogin(BaseModel):
+    token: str = Field(..., title="Token")
+
+
+class Permission(Enum):
+    read = "read"
+    write = "write"
+    admin = "admin"
+
+
+class KeysResponseItem(BaseModel):
+    token: str = Field(..., title="Token")
+    permissions: Optional[List[Permission]] = Field(..., title="Permissions")
+
+
+class ArtifactType(Enum):
+    image = "image"
+
+
+class ArtifactType1(Enum):
+    urdf = "urdf"
+    mjcf = "mjcf"
+
+
+class ArtifactType2(Enum):
+    stl = "stl"
+    obj = "obj"
+    dae = "dae"
+    ply = "ply"
+
+
+class ArtifactType3(Enum):
+    tgz = "tgz"
+    zip = "zip"
+
+
+class ListArtifactsItem(BaseModel):
+    artifact_id: str = Field(..., title="Artifact Id")
+    listing_id: str = Field(..., title="Listing Id")
+    name: str = Field(..., title="Name")
+    artifact_type: Union[ArtifactType, ArtifactType1, ArtifactType2, ArtifactType3] = Field(..., title="Artifact Type")
+    description: Optional[str] = Field(..., title="Description")
+    timestamp: int = Field(..., title="Timestamp")
+    urls: ArtifactUrls
+    is_new: Optional[bool] = Field(None, title="Is New")
+
+
+class ListArtifactsResponse(BaseModel):
+    artifacts: List[ListArtifactsItem] = Field(..., title="Artifacts")
+
+
+class ListKeysResponse(BaseModel):
+    keys: List[KeysResponseItem] = Field(..., title="Keys")
+
+
+class ListListingsResponse(BaseModel):
+    listing_ids: List[str] = Field(..., title="Listing Ids")
+    has_next: Optional[bool] = Field(False, title="Has Next")
+
+
+class Listing(BaseModel):
+    id: str = Field(..., title="Id")
+    user_id: str = Field(..., title="User Id")
+    name: str = Field(..., title="Name")
+    child_ids: List[str] = Field(..., title="Child Ids")
+    description: Optional[str] = Field(..., title="Description")
+
+
+class ListingInfoResponse(BaseModel):
+    id: str = Field(..., title="Id")
+    name: str = Field(..., title="Name")
+    description: Optional[str] = Field(..., title="Description")
+    child_ids: List[str] = Field(..., title="Child Ids")
+    image_url: Optional[str] = Field(..., title="Image Url")
+
+
+class LoginRequest(BaseModel):
+    email: EmailStr = Field(..., title="Email")
+    password: str = Field(..., title="Password")
+
+
+class LoginResponse(BaseModel):
+    user_id: str = Field(..., title="User Id")
+    token: str = Field(..., title="Token")
+
+
+class Permission1(Enum):
+    is_admin = "is_admin"
+
+
+class MyUserInfoResponse(BaseModel):
+    user_id: str = Field(..., title="User Id")
+    email: str = Field(..., title="Email")
+    github_id: Optional[str] = Field(..., title="Github Id")
+    google_id: Optional[str] = Field(..., title="Google Id")
+    permissions: Optional[List[Permission1]] = Field(..., title="Permissions")
+
+
+class NewKeyRequest(BaseModel):
+    readonly: Optional[bool] = Field(True, title="Readonly")
+
+
+class NewKeyResponse(BaseModel):
+    user_id: str = Field(..., title="User Id")
+    key: KeysResponseItem
+
+
+class NewListingRequest(BaseModel):
+    name: str = Field(..., title="Name")
+    child_ids: List[str] = Field(..., title="Child Ids")
+    description: Optional[str] = Field(..., title="Description")
+
+
+class NewListingResponse(BaseModel):
+    listing_id: str = Field(..., title="Listing Id")
+
+
+class PublicUserInfoResponseItem(BaseModel):
+    id: str = Field(..., title="Id")
+    email: str = Field(..., title="Email")
+    permissions: Optional[List[Permission1]] = Field(None, title="Permissions")
+    created_at: Optional[int] = Field(None, title="Created At")
+    updated_at: Optional[int] = Field(None, title="Updated At")
+    first_name: Optional[str] = Field(None, title="First Name")
+    last_name: Optional[str] = Field(None, title="Last Name")
+    name: Optional[str] = Field(None, title="Name")
+    bio: Optional[str] = Field(None, title="Bio")
+
+
+class PublicUsersInfoResponse(BaseModel):
+    users: List[PublicUserInfoResponseItem] = Field(..., title="Users")
+
+
+class UpdateArtifactRequest(BaseModel):
+    name: Optional[str] = Field(None, title="Name")
+    description: Optional[str] = Field(None, title="Description")
+
+
+class UpdateListingRequest(BaseModel):
+    name: Optional[str] = Field(None, title="Name")
+    child_ids: Optional[List[str]] = Field(None, title="Child Ids")
+    description: Optional[str] = Field(None, title="Description")
+    tags: Optional[List[str]] = Field(None, title="Tags")
+
+
+class UploadArtifactResponse(BaseModel):
+    artifacts: List[ListArtifactsItem] = Field(..., title="Artifacts")
+
+
+class UrdfInfo(BaseModel):
+    artifact_id: str = Field(..., title="Artifact Id")
+    url: str = Field(..., title="Url")
+
+
+class UrdfResponse(BaseModel):
+    urdf: Optional[UrdfInfo]
+    listing_id: str = Field(..., title="Listing Id")
+
+
+class UserInfoResponseItem(BaseModel):
+    id: str = Field(..., title="Id")
+    email: str = Field(..., title="Email")
+
+
+class UserPublic(BaseModel):
+    id: str = Field(..., title="Id")
+    email: str = Field(..., title="Email")
+    permissions: Optional[List[Permission1]] = Field(None, title="Permissions")
+    created_at: Optional[int] = Field(None, title="Created At")
+    updated_at: Optional[int] = Field(None, title="Updated At")
+    first_name: Optional[str] = Field(None, title="First Name")
+    last_name: Optional[str] = Field(None, title="Last Name")
+    name: Optional[str] = Field(None, title="Name")
+    bio: Optional[str] = Field(None, title="Bio")
+
+
+class UserSignup(BaseModel):
+    signup_token_id: str = Field(..., title="Signup Token Id")
+    email: str = Field(..., title="Email")
+    password: str = Field(..., title="Password")
+
+
+class ValidationError(BaseModel):
+    loc: List[Union[str, int]] = Field(..., title="Location")
+    msg: str = Field(..., title="Message")
+    type: str = Field(..., title="Error Type")
+
+
+class DumpListingsResponse(BaseModel):
+    listings: List[Listing] = Field(..., title="Listings")
+
+
+class GetBatchListingsResponse(BaseModel):
+    listings: List[ListingInfoResponse] = Field(..., title="Listings")
+
+
+class HTTPValidationError(BaseModel):
+    detail: Optional[List[ValidationError]] = Field(None, title="Detail")

kscale-0.0.1/kscale/store/urdf.py

@@ -0,0 +1 @@
+"""Utility functions for managing artifacts in the K-Scale store."""

kscale-0.0.1/kscale.egg-info/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: kscale
+Version: 0.0.1
+Summary: The kscale project
+Home-page: https://github.com/kscalelabs/kscale
+Author: Benjamin Bolte
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: omegaconf
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: darglint; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: datamodel-code-generator; extra == "dev"
+
+# K-Scale Command Line Interface
+
+This is a command line tool for interacting with various services provided by K-Scale Labs, such as:
+
+- [K-Scale Store](https://kscale.store/)
+
+## Installation
+
+```bash
+pip install kscale
+```

kscale-0.0.1/kscale.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+kscale/__init__.py
+kscale/conf.py
+kscale/py.typed
+kscale/requirements-dev.txt
+kscale/requirements.txt
+kscale.egg-info/PKG-INFO
+kscale.egg-info/SOURCES.txt
+kscale.egg-info/dependency_links.txt
+kscale.egg-info/requires.txt
+kscale.egg-info/top_level.txt
+kscale/store/__init__.py
+kscale/store/auth.py
+kscale/store/urdf.py
+kscale/store/gen/__init__.py
+kscale/store/gen/api.py
+tests/test_dummy.py

kscale-0.0.1/kscale.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

kscale-0.0.1/kscale.egg-info/requires.txt

@@ -0,0 +1,9 @@
+omegaconf
+
+[dev]
+black
+darglint
+mypy
+pytest
+ruff
+datamodel-code-generator

kscale-0.0.1/kscale.egg-info/top_level.txt

@@ -0,0 +1 @@
+kscale

kscale-0.0.1/pyproject.toml

@@ -0,0 +1,72 @@
+[tool.black]
+
+line-length = 120
+target-version = ["py311"]
+include = '\.pyi?$'
+
+[tool.pytest.ini_options]
+
+addopts = "-rx -rf -x -q --full-trace"
+testpaths = ["tests"]
+
+markers = [
+    "slow: Marks test as being slow",
+]
+
+[tool.mypy]
+
+pretty = true
+show_column_numbers = true
+show_error_context = true
+show_error_codes = true
+show_traceback = true
+disallow_untyped_defs = true
+strict_equality = true
+allow_redefinition = true
+
+warn_unused_ignores = true
+warn_redundant_casts = true
+
+incremental = true
+namespace_packages = false
+
+# Uncomment to exclude modules from Mypy.
+# [[tool.mypy.overrides]]
+# module = []
+# ignore_missing_imports = true
+
+[tool.isort]
+
+profile = "black"
+
+[tool.ruff]
+
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+
+select = ["ANN", "D", "E", "F", "I", "N", "PGH", "PLC", "PLE", "PLR", "PLW", "W"]
+
+ignore = [
+    "ANN101", "ANN102",
+    "D101", "D102", "D103", "D104", "D105", "D106", "D107",
+    "N812", "N817",
+    "PLR0911", "PLR0912", "PLR0913", "PLR0915", "PLR2004",
+    "PLW0603", "PLW2901",
+]
+
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.lint.per-file-ignores]
+
+"__init__.py" = ["E402", "F401", "F403", "F811"]
+
+[tool.ruff.lint.isort]
+
+known-first-party = ["kscale", "tests"]
+combine-as-imports = true
+
+[tool.ruff.lint.pydocstyle]
+
+convention = "google"

kscale-0.0.1/setup.cfg

@@ -0,0 +1,11 @@
+[options]
+packages = find:
+
+[options.packages.find]
+exclude = 
+	tests
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

kscale-0.0.1/setup.py

@@ -0,0 +1,39 @@
+# mypy: disable-error-code="import-untyped"
+#!/usr/bin/env python
+"""Setup script for the project."""
+
+import re
+
+from setuptools import setup
+
+with open("README.md", "r", encoding="utf-8") as f:
+    long_description: str = f.read()
+
+
+with open("kscale/requirements.txt", "r", encoding="utf-8") as f:
+    requirements: list[str] = f.read().splitlines()
+
+
+with open("kscale/requirements-dev.txt", "r", encoding="utf-8") as f:
+    requirements_dev: list[str] = f.read().splitlines()
+
+
+with open("kscale/__init__.py", "r", encoding="utf-8") as fh:
+    version_re = re.search(r"^__version__ = \"([^\"]*)\"", fh.read(), re.MULTILINE)
+assert version_re is not None, "Could not find version in kscale/__init__.py"
+version: str = version_re.group(1)
+
+
+setup(
+    name="kscale",
+    version=version,
+    description="The kscale project",
+    author="Benjamin Bolte",
+    url="https://github.com/kscalelabs/kscale",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    python_requires=">=3.11",
+    install_requires=requirements,
+    tests_require=requirements_dev,
+    extras_require={"dev": requirements_dev},
+)

kscale-0.0.1/tests/test_dummy.py

@@ -0,0 +1,12 @@
+"""Defines a dummy test."""
+
+import pytest
+
+
+def test_dummy() -> None:
+    assert True
+
+
+@pytest.mark.slow
+def test_slow() -> None:
+    assert True