qwak-sdk 0.1.0__tar.gz → 0.2.20rc0__tar.gz

qwak_sdk-0.2.20rc0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.1
+Name: qwak-sdk
+Version: 0.2.20rc0
+Summary: Qwak SDK and CLI for qwak models
+License: Apache-2.0
+Keywords: mlops,ml,deployment,serving,model
+Author: Qwak
+Author-email: info@qwak.com
+Requires-Python: >=3.7.1,<3.10
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Provides-Extra: batch
+Provides-Extra: feedback
+Requires-Dist: assertpy (>=1.1,<2.0)
+Requires-Dist: boto3 (>=1.24.89,<2.0.0) ; extra == "batch" or extra == "feedback"
+Requires-Dist: cookiecutter
+Requires-Dist: gitpython (>=2.1.0)
+Requires-Dist: joblib (>=1.1.0,<2.0.0) ; extra == "batch" or extra == "feedback"
+Requires-Dist: pandas (<1.4) ; (python_full_version >= "3.7.1" and python_version < "3.8") and (extra == "batch" or extra == "feedback")
+Requires-Dist: pandas (>=1.4.3,<2.0.0) ; (python_version >= "3.8" and python_version < "3.10") and (extra == "batch" or extra == "feedback")
+Requires-Dist: pyarrow (>=6.0.0,<11.0.0) ; extra == "batch"
+Requires-Dist: pydantic
+Requires-Dist: python-json-logger (>=2.0.2)
+Requires-Dist: qwak-core (==0.0.26)
+Requires-Dist: qwak-inference (==0.0.10.rc0)
+Requires-Dist: tabulate (>=0.8.0)
+Requires-Dist: yaspin (>=2.0.0)
+Project-URL: Home page, https://www.qwak.com/
+Description-Content-Type: text/markdown
+
+# Qwak SDK
+
+Qwak is an end-to-end production ML platform designed to allow data scientists to build, deploy, and monitor their models in production with minimal engineering friction.
+

qwak_sdk-0.2.20rc0/README.md

@@ -0,0 +1,3 @@
+# Qwak SDK
+
+Qwak is an end-to-end production ML platform designed to allow data scientists to build, deploy, and monitor their models in production with minimal engineering friction.

qwak_sdk-0.2.20rc0/pyproject.toml

@@ -0,0 +1,94 @@
+[tool.poetry]
+name = "qwak-sdk"
+version = "0.2.20.rc0"
+description = "Qwak SDK and CLI for qwak models"
+authors = ["Qwak <info@qwak.com>"]
+readme = "README.md"
+keywords = ["mlops", "ml", "deployment", "serving", "model"]
+packages = [
+    {include = "qwak_sdk"},
+]
+include = ["./qwak_sdk/**/*"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+license = "Apache-2.0"
+
+[tool.poetry.urls]
+"Home page" = "https://www.qwak.com/"
+
+[tool.poetry.scripts]
+qwak = "qwak_sdk.main:qwak_cli"
+
+[tool.poetry.dependencies]
+python = ">=3.7.1,<3.10"
+qwak-core = "==0.0.26"
+qwak-inference = "==0.0.10.rc0"
+tabulate = ">=0.8.0"
+python-json-logger = ">=2.0.2"
+pydantic = "*"
+yaspin = ">=2.0.0"
+assertpy = "^1.1"
+cookiecutter = "*"
+gitpython = ">=2.1.0"
+boto3 = { version="^1.24.89", optional=true } # Inference dependencies
+pandas = [ # Inference dependencies
+    {version="<1.4", python=">=3.7.1,<3.8", optional=true},
+    {version=">=1.4.3,<2.0.0", python=">=3.8,<3.10", optional=true}
+]
+joblib = { version="^1.1.0", optional=true } # Inference dependencies
+pyarrow = { version=">=6.0.0, <11.0.0", optional=true } # Inference dependencies
+
+[tool.poetry.group.dev.dependencies]
+pytest = "7.2.1"
+black = "23.1.0"
+flake8 = "5.0.0"
+bandit = {version = "^1.7.4", extras=["toml"]}
+coverage = "7.2.1"
+typing_extensions ="4.4.0"
+bump2version = "1.0.1"
+typeguard = "^2"
+isort = "^5"
+changelog-cli = "*"
+
+[tool.poetry.extras]
+batch = ["boto3", "pandas", "pyarrow", "joblib"]
+feedback = ["boto3", "pandas", "joblib"]
+
+[tool.black]
+extend-exclude = '''
+(
+     .*_pb2.py
+    | .*_pb2_grpc.py
+    | .qwak_sdk/commands/models/init/_logic/template/*
+)'''
+
+[tool.pytest.ini_options]
+addopts = [
+    "--strict-markers"
+]
+markers = [
+    "integration: marks tests as slow (deselect with '-m \"not integration\"')",
+]
+
+[tool.bandit]
+exclude_dirs = ["qwak_sdk/commands/models/init/_logic/template"]
+
+[tool.isort]
+profile = "black"
+src_paths = ["qwak_sdk", "tests"]
+
+[tool.poe.tasks]
+clean = { cmd="rm -rf dist ./**/__pycache__", help="Clean build artifacts" }
+install = "poetry install"
+validate = { cmd="pre-commit run  --all-files", help="Check lint on all files" }
+test = { cmd="pytest --disable-warnings tests", help="Run tests" }
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

qwak_sdk-0.2.20rc0/qwak_sdk/__init__.py

@@ -0,0 +1,9 @@
+# fmt: off
+__author__ = '''Qwak.ai'''
+__version__ = '0.2.20.rc0'
+
+from qwak.inner import wire_dependencies
+
+# fmt: on
+
+wire_dependencies()

qwak_sdk-0.2.20rc0/qwak_sdk/cli.py

@@ -0,0 +1,51 @@
+import click
+from packaging import version
+from qwak.inner.di_configuration import UserAccountConfiguration
+from qwak.inner.di_configuration.account import UserAccount
+
+from qwak_sdk.commands.admin.admin_commands_group import admin_commands_group
+from qwak_sdk.commands.automations.automations_commands_group import (
+    automations_commands_group,
+)
+from qwak_sdk.commands.feature_store.feature_store_command_group import (
+    feature_store_commands_group,
+)
+from qwak_sdk.commands.models.models_command_group import models_command_group
+from qwak_sdk.commands.projects.projects_command_group import projects_command_group
+from qwak_sdk.commands.secrets.secrets_commands_group import secrets_commands_group
+from qwak_sdk.inner.tools.logger import setup_qwak_logger
+
+version_option_kwargs = {}
+if version.parse(click.__version__) >= version.parse("8.0.0"):
+    version_option_kwargs["package_name"] = "qwak-sdk"
+
+
+def create_qwak_cli():
+    setup_qwak_logger()
+
+    @click.group()
+    @click.version_option(**version_option_kwargs)
+    def qwak_cli():
+        # This class is intentionally empty
+        pass
+
+    @qwak_cli.command("configure", short_help="Configure the Qwak environment")
+    @click.option(
+        "--api-key", metavar="PASSWORD", required=False, help="Qwak assigned API key"
+    )
+    def set_configuration(api_key, **kwargs):
+        if api_key is None:
+            api_key = click.prompt("Please enter your API key", type=str)
+
+        account_config = UserAccountConfiguration()
+        account_config.configure_user(UserAccount(api_key=api_key))
+
+        print("User successfully configured")
+
+    qwak_cli.add_command(projects_command_group)
+    qwak_cli.add_command(models_command_group)
+    qwak_cli.add_command(secrets_commands_group)
+    qwak_cli.add_command(automations_commands_group)
+    qwak_cli.add_command(admin_commands_group)
+    qwak_cli.add_command(feature_store_commands_group)
+    return qwak_cli

qwak_sdk-0.2.20rc0/qwak_sdk/commands/admin/admin_commands_group.py

@@ -0,0 +1,17 @@
+import click
+
+from qwak_sdk.commands.admin.apikeys.api_keys_commands_group import (
+    api_keys_commands_group,
+)
+
+
+@click.group(
+    name="admin",
+    help="Commands for admin operations",
+)
+def admin_commands_group():
+    # Click commands group injection
+    pass
+
+
+admin_commands_group.add_command(api_keys_commands_group)

qwak_sdk-0.2.20rc0/qwak_sdk/commands/admin/apikeys/api_keys_commands_group.py

@@ -0,0 +1,17 @@
+import click
+
+from qwak_sdk.commands.admin.apikeys.generate.ui import generate_apikey
+from qwak_sdk.commands.admin.apikeys.revoke.ui import revoke_apikey
+from qwak_sdk.inner.tools.logger.logger import get_qwak_logger
+
+logger = get_qwak_logger()
+
+
+@click.group(name="api-keys", help="api keys")
+def api_keys_commands_group():
+    # Click commands group injection
+    pass
+
+
+api_keys_commands_group.add_command(generate_apikey)
+api_keys_commands_group.add_command(revoke_apikey)

qwak_sdk-0.2.20rc0/qwak_sdk/commands/admin/apikeys/generate/_logic.py

@@ -0,0 +1,21 @@
+from qwak.clients.administration import SelfServiceUserClient
+from qwak.clients.administration.eco_system.client import EcosystemClient
+
+
+def execute_generate_apikey(
+    environment_name: str, user_id: str, force: bool = False
+) -> str:
+    ecosystem_client = EcosystemClient()
+    environment_name_to_environment_details_map = (
+        ecosystem_client.get_environments_names_to_details([environment_name])
+    )
+
+    user_service = SelfServiceUserClient()
+
+    return user_service.generate_apikey(
+        user_id=user_id,
+        environment_id=environment_name_to_environment_details_map.get(
+            environment_name
+        ).id,
+        force=force,
+    ).api_key

qwak_sdk-0.2.20rc0/qwak_sdk/commands/admin/apikeys/generate/ui.py

@@ -0,0 +1,45 @@
+import click
+from qwak.clients.administration.self_service.client import APIKEY_ALREADY_EXISTS
+
+from qwak_sdk.commands.admin.apikeys.generate._logic import execute_generate_apikey
+from qwak_sdk.inner.tools.cli_tools import QwakCommand
+from qwak_sdk.inner.tools.logger.logger import get_qwak_logger
+
+logger = get_qwak_logger()
+
+
+@click.command("generate", help="api keys", cls=QwakCommand)
+@click.option(
+    "--environment-name",
+    help="Environment name to generate api key for",
+    required=True,
+)
+@click.option(
+    "--user-id",
+    help="User id to generate api key for",
+    required=True,
+)
+@click.option(
+    "--force",
+    help="If override existing one. (default false)",
+    default=False,
+    is_flag=True,
+)
+def generate_apikey(user_id, environment_name, force, **kwargs):
+    logger.info(
+        f"Generating api key for user {user_id} on environment {environment_name}..."
+    )
+    try:
+        api_key = execute_generate_apikey(
+            user_id=user_id, environment_name=environment_name, force=force
+        )
+        logger.info("generated api key:")
+        logger.info(api_key)
+    except Exception as e:
+        if e.message == APIKEY_ALREADY_EXISTS:
+            logger.error(
+                "Failed to generate api key - "
+                "the api key already exists please add --force if you want to override it."
+            )
+        else:
+            logger.error(e)

qwak_sdk-0.2.20rc0/qwak_sdk/commands/admin/apikeys/revoke/_logic.py

@@ -0,0 +1,22 @@
+from _qwak_proto.qwak.self_service.user.v1.user_service_pb2 import RevokeApiKeyResponse
+from qwak.clients.administration import SelfServiceUserClient
+from qwak.clients.administration.eco_system.client import EcosystemClient
+
+
+def execute_revoke_apikey(environment_name: str, user_id: str) -> bool:
+    ecosystem_client = EcosystemClient()
+    environment_name_to_environment_details_map = (
+        ecosystem_client.get_environments_names_to_details([environment_name])
+    )
+
+    user_service = SelfServiceUserClient()
+
+    return (
+        user_service.revoke_apikey(
+            user_id=user_id,
+            environment_id=environment_name_to_environment_details_map.get(
+                environment_name
+            ).id,
+        ).status
+        == RevokeApiKeyResponse.Status.REVOKED
+    )

qwak_sdk-0.2.20rc0/qwak_sdk/commands/admin/apikeys/revoke/ui.py

@@ -0,0 +1,31 @@
+import click
+
+from qwak_sdk.commands.admin.apikeys.revoke._logic import execute_revoke_apikey
+from qwak_sdk.inner.tools.cli_tools import QwakCommand
+from qwak_sdk.inner.tools.logger.logger import get_qwak_logger
+
+logger = get_qwak_logger()
+
+
+@click.command("revoke", help="api keys", cls=QwakCommand)
+@click.option(
+    "--environment-name",
+    help="Environment name to generate api key for",
+    required=True,
+)
+@click.option(
+    "--user-id",
+    help="User id to generate api key for",
+    required=True,
+)
+def revoke_apikey(user_id, environment_name, **kwargs):
+    logger.info(
+        f"Revoking api key for user {user_id} on environment {environment_name}..."
+    )
+    try:
+        if execute_revoke_apikey(user_id=user_id, environment_name=environment_name):
+            logger.info("Successfully revoked api key")
+        else:
+            logger.info("Failed to revoke api key")
+    except Exception as e:
+        logger.error(e.message)

qwak_sdk-0.2.20rc0/qwak_sdk/commands/audience/_logic/config/config_base.py

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+from dataclasses import field
+from typing import Any
+
+from _qwak_proto.qwak.audience.v1.audience_pb2 import Audience
+from pydantic.dataclasses import dataclass
+
+
+@dataclass
+class ConfigBase(ABC):
+    spec: Any
+    api_version: str = field(default="v1")
+
+    @abstractmethod
+    def to_audiences_api(self) -> Audience:
+        pass

qwak_sdk-0.2.20rc0/qwak_sdk/commands/audience/_logic/config/parser.py

@@ -0,0 +1,28 @@
+from pathlib import Path
+from typing import Optional, Union
+
+import yaml
+
+from qwak_sdk.commands.audience._logic.config.config_base import ConfigBase
+from qwak_sdk.commands.audience._logic.config.v1.config_v1 import ConfigV1
+
+VERSION_CONFIG_MAPPING = {"v1": ConfigV1}
+
+
+def parse_audience_from_yaml(
+    file_path: Optional[Union[Path, str]] = None
+) -> ConfigBase:
+    if file_path:
+        file_path_obj = Path(file_path)
+        if file_path_obj.exists():
+            audience_dict = yaml.safe_load(file_path_obj.open("r"))
+            audience_config: ConfigBase = VERSION_CONFIG_MAPPING.get(
+                audience_dict.get("api_version")
+            )
+            return audience_config(**audience_dict)
+        else:
+            raise FileNotFoundError(
+                f"Audience file {file_path_obj} definition isn't found"
+            )
+    else:
+        return ConfigV1()

qwak_sdk-0.2.20rc0/qwak_sdk/commands/audience/_logic/config/v1/audience_config.py

@@ -0,0 +1,26 @@
+from dataclasses import field
+from typing import List
+
+from _qwak_proto.qwak.audience.v1.audience_pb2 import AudienceRoutesEntry
+from pydantic.dataclasses import dataclass
+
+from qwak_sdk.commands.audience._logic.config.v1.conditions_config import (
+    ConditionsConfig,
+)
+from qwak_sdk.commands.audience._logic.config.v1.route_config import RouteConfig
+
+
+@dataclass
+class AudienceConfig:
+    name: str = field(default="")
+    id: str = field(default="")
+    description: str = field(default="")
+    routes: List[RouteConfig] = field(default_factory=list)
+    conditions: ConditionsConfig = field(default_factory=ConditionsConfig)
+
+    def to_audience_route_entry(self, index: int = 0) -> AudienceRoutesEntry:
+        return AudienceRoutesEntry(
+            audience_id=self.id,
+            order=index + 1,
+            routes=[route.to_route_api() for route in self.routes],
+        )

qwak_sdk-0.2.20rc0/qwak_sdk/commands/audience/_logic/config/v1/conditions_config.py

@@ -0,0 +1,60 @@
+from dataclasses import field
+from typing import List
+
+from _qwak_proto.qwak.audience.v1.audience_pb2 import (
+    BinaryCondition,
+    BinaryOperatorType,
+    Condition,
+    UnaryCondition,
+    UnaryOperatorType,
+)
+from pydantic.dataclasses import dataclass
+
+
+@dataclass
+class UnaryConditionConfig:
+    key: str
+    operator: str
+    operand: str
+
+    def to_condition_api(self) -> Condition:
+        return Condition(
+            key=self.key,
+            unary_condition=UnaryCondition(
+                operator=UnaryOperatorType.DESCRIPTOR.values_by_name[
+                    self.operator
+                ].number,
+                operand=self.operand,
+            ),
+        )
+
+
+@dataclass
+class BinaryConditionConfig:
+    key: str
+    operator: str
+    first_operand: str
+    second_operand: str
+
+    def to_condition_api(self) -> Condition:
+        return Condition(
+            key=self.key,
+            binary_condition=BinaryCondition(
+                operator=BinaryOperatorType.DESCRIPTOR.values_by_name[
+                    self.operator
+                ].number,
+                first_operand=self.first_operand,
+                second_operand=self.second_operand,
+            ),
+        )
+
+
+@dataclass
+class ConditionsConfig:
+    unary: List[UnaryConditionConfig] = field(default_factory=list)
+    binary: List[BinaryConditionConfig] = field(default_factory=list)
+
+    def to_conditions_api(self) -> List[Condition]:
+        conditions = [condition.to_condition_api() for condition in self.unary]
+        conditions.extend([condition.to_condition_api() for condition in self.binary])
+        return conditions

qwak_sdk-0.2.20rc0/qwak_sdk/commands/audience/_logic/config/v1/config_v1.py

@@ -0,0 +1,24 @@
+from dataclasses import field
+from typing import List
+
+from _qwak_proto.qwak.audience.v1.audience_pb2 import Audience
+from pydantic.dataclasses import dataclass
+
+from qwak_sdk.commands.audience._logic.config.config_base import ConfigBase
+from qwak_sdk.commands.audience._logic.config.v1.spec import Spec
+
+
+@dataclass
+class ConfigV1(ConfigBase):
+    spec: Spec = field(default_factory=Spec)
+
+    def to_audiences_api(self) -> List[Audience]:
+        return [
+            Audience(
+                name=audience_config.name,
+                description=audience_config.description,
+                routes=[route.to_route_api() for route in audience_config.routes],
+                conditions=audience_config.conditions.to_conditions_api(),
+            )
+            for audience_config in self.spec.audiences
+        ]

qwak_sdk-0.2.20rc0/qwak_sdk/commands/audience/_logic/config/v1/route_config.py

@@ -0,0 +1,14 @@
+from _qwak_proto.qwak.audience.v1.audience_pb2 import Route
+from pydantic.dataclasses import dataclass
+
+
+@dataclass
+class RouteConfig:
+    variation_name: str
+    weight: int
+    shadow: bool
+
+    def to_route_api(self):
+        return Route(
+            variation_name=self.variation_name, weight=self.weight, shadow=self.shadow
+        )

qwak_sdk-0.2.20rc0/qwak_sdk/commands/audience/_logic/config/v1/spec.py

@@ -0,0 +1,11 @@
+from dataclasses import field
+from typing import List
+
+from pydantic.dataclasses import dataclass
+
+from qwak_sdk.commands.audience._logic.config.v1.audience_config import AudienceConfig
+
+
+@dataclass
+class Spec:
+    audiences: List[AudienceConfig] = field(default_factory=list)

qwak_sdk-0.2.20rc0/qwak_sdk/commands/auto_scalling/_logic/config/__init__.py

@@ -0,0 +1,3 @@
+from .config import Config
+
+__all__ = ["Config"]