splight-cli 2.3.12__tar.gz → 2.3.14__tar.gz

{splight-cli-2.3.12 → splight-cli-2.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-cli
-Version: 2.3.12
+Version: 2.3.14
 Summary: CLI tool to build and run Splight components
 Home-page: UNKNOWN
 Author: Splight

{splight-cli-2.3.12 → splight-cli-2.3.14}/README.md

@@ -538,8 +538,35 @@ the limit is your imagination.
 
 #### Running Locally
 
-You can run the component locally before pushing it to the platform
+You can run the component locally before pushing it to the platform with the `--local` option:
 
 ```bash
-splight component run <component directory>
+splight component run <component directory> --local
 ```
+
+This way, the component will run using local clients for database and datalake. This is extremely
+useful for development since you can create instances of the different database objects in the 
+local database for running different scenearios or differents tests. The same can be applied for 
+datalake data, the local client stores the data in files. In both cases, for database and datalake,
+the files are created in the same directory as the `__init__.py` file of the component, so you 
+can modified it based on your needs.
+
+You can interact with the local databases using the library, for example
+
+```python
+from splight_models import Asset, Attribute, Number
+from splight_lib.client.database import LocalDatabaseClient
+from splight_lib.client.datalake import LocalDatalakeClient
+
+
+component_path = ...
+db_client = LocalDatabaseClient(namespace="default", path=component_path)
+dl_client = LocalDatalakeClient(namespace="default", path=component_path)
+
+all_assets = db_client.get(Asset)
+attribute = Attribute(name="SomeAttribute")
+
+db_client.save(attribute)
+
+df = client.get_dataframe(Number, asset=all_assets[0].id, attribute=attribute.id)
+```

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/cli.py

@@ -38,43 +38,3 @@ def main(
     ),
 ):
     ctx.obj = Context()
-
-
-# @cli.group()
-# @pass_context
-# @needs_credentials
-# def component(ctx):
-#     ctx.obj = Context()
-#
-#
-# @cli.group()
-# @pass_context
-# @needs_credentials
-# def datalake(ctx):
-#     ctx.obj = Context()
-#
-#
-# @cli.group()
-# @pass_context
-# @needs_credentials
-# def database(ctx):
-#     ctx.obj = Context()
-#
-#
-# @cli.group()
-# @pass_context
-# @needs_credentials
-# def deployment(ctx):
-#     ctx.obj = Context()
-#
-#
-# @cli.group()
-# @pass_context
-# def workspace(ctx):
-#     ctx.obj = Context()
-#
-#
-# @cli.group(cls=DefaultGroup, default="config", default_if_no_args=True)
-# @pass_context
-# def configure(ctx: Context, from_json: str = False) -> None:
-#     ctx.obj = Context()

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/component/__init__.py

@@ -1,14 +1,15 @@
 import json
 import logging
-from typing import List, Optional
 from pathlib import Path
+from typing import Optional
 
 import typer
 from rich.console import Console
 
-from cli.context import check_credentials
 from cli.component.component import Component
 from cli.constants import error_style, success_style
+from cli.context import check_credentials
+from cli.context.context import local_environment_context
 
 component_app = typer.Typer(
     name="Splight Component",
@@ -41,13 +42,11 @@ def create(
         abs_path = str(Path(path).resolve())
         console.print(
             f"Component {name} created successfully in {abs_path}",
-            style=success_style
+            style=success_style,
         )
 
     except Exception as e:
-        console.print(
-            f"Error creating component: {str(e)}", style=error_style
-        )
+        console.print(f"Error creating component: {str(e)}", style=error_style)
         typer.Exit(1)
 
 
@@ -59,32 +58,53 @@ def run(
     component_id: str = typer.Option(
         None, "--component-id", "-id", help="Component's ID"
     ),
+    local_dev: bool = typer.Option(
+        False,
+        "--local",
+        callback=local_environment_context,
+        is_eager=True
+    ),
 ) -> None:
     try:
         component = Component(ctx.obj)
         console.print("Running component...", style=success_style)
         input = json.loads(input) if input else None
-        component.run(path, input_parameters=input, component_id=component_id)
+        component.run(
+            path,
+            input_parameters=input,
+            component_id=component_id,
+        )
     except Exception as e:
         logger.exception(e)
         console.print(f"Error running component: {str(e)}", style=error_style)
         typer.Exit(1)
 
+
 @component_app.command()
 def upgrade(
     ctx: typer.Context,
-    from_component_id: str = typer.Option(None, "--from-component-id", "-f", help="From Component's ID"),
-    to_component_id: str = typer.Option(None, "--to-component-id", "-t", help="To Component's ID"),
+    from_component_id: str = typer.Option(
+        None, "--from-component-id", "-f", help="From Component's ID"
+    ),
+    to_component_id: str = typer.Option(
+        None, "--to-component-id", "-t", help="To Component's ID"
+    ),
 ) -> None:
     try:
         component = Component(ctx.obj)
         console.print("Upgrading component...", style=success_style)
-        component.upgrade(from_component_id=from_component_id, to_component_id=to_component_id)
+        component.upgrade(
+            from_component_id=from_component_id,
+            to_component_id=to_component_id,
+        )
     except Exception as e:
         logger.exception(e)
-        console.print(f"Error upgrading component: {str(e)}", style=error_style)
+        console.print(
+            f"Error upgrading component: {str(e)}", style=error_style
+        )
         typer.Exit(1)
 
+
 @component_app.command()
 def install_requirements(
     ctx: typer.Context,
@@ -113,7 +133,7 @@ def readme(
         "--force",
         "-f",
         help="Delete if a Readme exists",
-    )
+    ),
 ) -> None:
     try:
         component = Component(ctx.obj)
@@ -121,10 +141,6 @@ def readme(
         component.readme(path, force)
     except Exception as e:
         console.print(
-            f"Error generating component README: {str(e)}",
-            style=error_style
+            f"Error generating component README: {str(e)}", style=error_style
         )
         typer.Exit(1)
-
-
-

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/component/component.py

@@ -11,7 +11,6 @@ from splight_models import Component as ComponentModel
 from cli.component.exceptions import InvalidSplightCLIVersion, ReadmeExists
 from cli.component.loaders import ComponentLoader, InitLoader, SpecLoader
 from cli.component.spec import Spec
-from cli.component.exceptions import InvalidSplightCLIVersion, ReadmeExists
 from cli.constants import COMPONENT_FILE, README_FILE_1, SPLIGHT_IGNORE
 from cli.utils import get_template, input_single
 from cli.version import __version__
@@ -68,7 +67,7 @@ class Component:
         self,
         path: str,
         input_parameters: Optional[List[Dict]] = None,
-        component_id: str = None,
+        component_id: Optional[str] = None,
     ):
         # Load py module and validate Splight Component structure
         loader = ComponentLoader(path=path)
@@ -78,7 +77,10 @@ class Component:
 
         if component_id and not input_parameters:
             remote_input_parameters = []
-            db_client = self.context.framework.setup.DATABASE_CLIENT()
+            db_client = self.context.framework.setup.DATABASE_CLIENT(
+                namespace="default",
+                path=path
+            )
             component_input = db_client.get(
                 ComponentModel, id=component_id, first=True
             ).input
@@ -94,6 +96,8 @@ class Component:
             run_spec=run_spec.dict(),
             initial_setup=self.context.workspace.settings.dict(),
             component_id=component_id,
+            database_config={"path": path},
+            datalake_config={"path": path},
         )
         component.execution_client.start(Thread(target=component.start))
 

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/component/tests/test_run.py

@@ -1,4 +1,5 @@
 import os
+
 os.environ["SPLIGHT_ACCESS_ID"] = "access_id"
 os.environ["SPLIGHT_SECRET_KEY"] = "secret_key"
 
@@ -12,9 +13,11 @@ from cli.tests.test_generic import SplightCLITest
 
 
 class TestRun(SplightCLITest):
-
     @patch.object(Component, "_validate_cli_version", return_value=None)
-    @patch("remote_splight_lib.datalake.DatalakeClient.create_index", return_value=None)
+    @patch(
+        "splight_lib.client.datalake.RemoteDatalakeClient.create_index",
+        return_value=None,
+    )
     def test_run(self, mock, mock1):
         self.component = Component(self.context)
         self.configure()

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/context/__init__.py

@@ -1,13 +1,12 @@
-# import click
 import typer
 
-# from functools import wraps
 from rich.console import Console
 
 from cli.constants import error_style
 from cli.context.framework import FrameworkManager
 from cli.context.workspace import WorkspaceManager
 
+
 console = Console()
 
 
@@ -29,9 +28,6 @@ class Context:
         return f"<Context {self.__workspace}>"
 
 
-# pass_context = click.make_pass_decorator(Context)
-
-
 def check_credentials(ctx: typer.Context):
     settings = ctx.obj.workspace.settings
 
@@ -43,19 +39,3 @@ def check_credentials(ctx: typer.Context):
             style=error_style,
         )
         raise typer.Exit(1)
-
-
-# def needs_credentials(f):
-#     @wraps(f)
-#     def wrapper(ctx: typer.Context, *args, **kwargs):
-#         __import__('ipdb').set_trace()
-#         access_id = ctx.workspace.settings.SPLIGHT_ACCESS_ID
-#         secret_key = ctx.workspace.settings.SPLIGHT_SECRET_KEY
-#         if access_id is None or secret_key is None:
-#             click.secho(
-#                 "Please set your Splight credentials. Use \"splightcli configure\"",
-#                 fg="red"
-#             )
-#             exit(1)
-#         return f(ctx, *args, **kwargs)
-#     return wrapper

splight-cli-2.3.14/cli/context/context.py

@@ -0,0 +1,9 @@
+import typer
+
+
+def local_environment_context(ctx: typer.Context, local_dev: bool):
+    if local_dev:
+        db_client_mod = "splight_lib.client.database.LocalDatabaseClient"
+        dl_client_mod = "splight_lib.client.datalake.LocalDatalakeClient"
+        ctx.obj.workspace.settings.DATABASE_CLIENT = db_client_mod
+        ctx.obj.workspace.settings.DATALAKE_CLIENT = dl_client_mod

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/engine/datalake/tests/test_list.py

@@ -1,11 +1,5 @@
-import os
-
-os.environ["SPLIGHT_ACCESS_ID"] = "access_id"
-os.environ["SPLIGHT_SECRET_KEY"] = "secret_key"
-
 from unittest.mock import patch
 
-from remote_splight_lib.database import DatabaseClient
 from splight_models import Component
 
 from cli.engine.datalake import datalake_app
@@ -27,7 +21,7 @@ class TestList(SplightCLITest):
         super().setUp()
 
     @patch(
-        "remote_splight_lib.database.DatabaseClient.get",
+        "splight_lib.client.database.RemoteDatabaseClient.get",
         return_value=remote_collections,
     )
     def test_list(self, mock):

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/hub/component/hub_manager.py

@@ -114,16 +114,16 @@ class HubComponentManager:
             readme_path = os.path.join(path, README_FILE_2)
 
         try:
-            ignore_pathpec = self._get_ignore_pathspec(path)
+            ignore_pathspec = self._get_ignore_pathspec(path)
             with py7zr.SevenZipFile(file_name, "w") as archive:
                 for root, _, files in os.walk(path):
-                    if ignore_pathpec and ignore_pathpec.match_file(root):
+                    if ignore_pathspec and ignore_pathspec.match_file(root):
                         continue
                     for file in files:
-                        if ignore_pathpec and ignore_pathpec.match_file(os.path.join(root, file)):
+                        if ignore_pathspec and ignore_pathspec.match_file(os.path.join(root, file)):
                             continue
                         filepath = os.path.join(root, file)
-                        archive.write(filepath, os.path.join(versioned_name, filepath))
+                        archive.write(filepath, os.path.join(versioned_name, file))
             data = {
                 "name": name,
                 "version": version,

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/settings.py

@@ -10,12 +10,9 @@ class SplightCLISettings(BaseSettings):
     SPLIGHT_SECRET_KEY: str = ""
     SPLIGHT_PLATFORM_API_HOST: str = "https://api.splight-ai.com"
     # FRAMEWORK
-    DATABASE_CLIENT: str = "remote_splight_lib.database.DatabaseClient"
-    DATALAKE_CLIENT: str = "remote_splight_lib.datalake.DatalakeClient"
+    DATABASE_CLIENT: str = "splight_lib.client.database.RemoteDatabaseClient"
+    DATALAKE_CLIENT: str = "splight_lib.client.datalake.RemoteDatalakeClient"
     HUB_CLIENT: str = "remote_splight_lib.hub.SplightHubClient"
-    STORAGE_CLIENT: str = "remote_splight_lib.storage.StorageClient"
-    BLOCKCHAIN_CLIENT: str = "remote_splight_lib.blockchain.BlockchainClient"
-    DEPLOYMENT_CLIENT: str = "remote_splight_lib.deployment.DeploymentClient"
     COMMUNICATION_CLIENT: str = (
         "remote_splight_lib.communication.CommunicationClient"
     )

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/tests/test_configure.py

@@ -9,6 +9,8 @@ from cli.tests.test_generic import SplightCLITest
 
 class TestConfigure(SplightCLITest):
     def test_configure_requested(self):
+        self.context.workspace.settings.SPLIGHT_ACCESS_ID = ""
+        self.context.workspace.settings.SPLIGHT_SECRET_KEY = ""
         with patch.object(
             HubComponentManager, "list_components", return_value=None
         ):

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/tests/test_generic.py

@@ -103,6 +103,7 @@ class SplightCLITest(TestCase):
         self.context = FakeContext()
         self.runner = CliRunner()
         self.custompath = self.name + self.version + self.component_id
+        self.configure()
 
     @property
     def default_configuration(self):

{splight-cli-2.3.12 → splight-cli-2.3.14}/cli/utils/__init__.py

@@ -1,8 +1,5 @@
 from cli.utils.template import *
-from cli.utils.validation import *
 from cli.utils.json import *
-from cli.utils.api_requests import *
 from cli.utils.yaml import *
 from cli.utils.input import *
 from cli.utils.pprint import *
-from cli.utils.uuid import *

splight-cli-2.3.14/cli/version.py

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

{splight-cli-2.3.12 → splight-cli-2.3.14}/setup.py

@@ -27,7 +27,7 @@ setup(
     dependency_links=dependency_links,
     entry_points={
         'console_scripts': [
-            'splight = cli:cli.app',
+            'splight = cli.cli:app',
         ],
     },
 )

{splight-cli-2.3.12 → splight-cli-2.3.14}/splight_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-cli
-Version: 2.3.12
+Version: 2.3.14
 Summary: CLI tool to build and run Splight components
 Home-page: UNKNOWN
 Author: Splight

{splight-cli-2.3.12 → splight-cli-2.3.14}/splight_cli.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ cli/component/tests/test_initialize.py
 cli/component/tests/test_run.py
 cli/config/__init__.py
 cli/context/__init__.py
+cli/context/context.py
 cli/context/framework.py
 cli/context/workspace.py
 cli/deployment/__init__.py
@@ -51,15 +52,11 @@ cli/tests/test_configure.py
 cli/tests/test_generic.py
 cli/tests/TestHub/__init__.py
 cli/utils/__init__.py
-cli/utils/api_requests.py
-cli/utils/headers.py
 cli/utils/input.py
 cli/utils/json.py
 cli/utils/loader.py
 cli/utils/pprint.py
 cli/utils/template.py
-cli/utils/uuid.py
-cli/utils/validation.py
 cli/utils/yaml.py
 cli/workspace/__init__.py
 splight_cli.egg-info/PKG-INFO

splight-cli-2.3.14/splight_cli.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+splight = cli.cli:app
+

{splight-cli-2.3.12 → splight-cli-2.3.14}/splight_cli.egg-info/requires.txt

@@ -7,5 +7,5 @@ py7zr==0.18.5
 requests==2.27.1
 rich==13.0.1
 setuptools==60.9.3
-splight-lib==2.2.3
+splight-lib==2.2.4
 typer==0.7.0

splight-cli-2.3.12/cli/__init__.py

@@ -1 +0,0 @@
-from cli.cli import app

splight-cli-2.3.12/cli/utils/api_requests.py

@@ -1,35 +0,0 @@
-import requests
-import json
-from functools import wraps
-from cli.constants import *
-from requests.exceptions import ConnectionError
-
-def http_request_validation(func):
-    @wraps(func)
-    def wrapper(*args, **kwargs):
-        try:
-            response = func(*args, **kwargs)
-            if response.status_code >= 400:
-                response = response.json()
-                detail = response.get("detail", None)
-
-                if detail in ["Invalid token.", "Authentication credentials were not provided.", "Incorrect authentication credentials."]:
-                    raise Exception(f"{detail} Please check your Splight credentials. Use 'splightcli configure'")
-
-                raise Exception(f"An unknown error ocurred while trying to reach Splight Hub API: {json.dumps(response)}")
-            return response
-        except ConnectionError:
-            raise Exception(f"Splight Hub API is unreachable: Check out your configuration for Splight Hub API host. Use 'splightcli configure'")
-    return wrapper
-
-@http_request_validation
-def api_get(*args, **kwargs):
-    return requests.get(*args, **kwargs)
-
-@http_request_validation
-def api_post(*args, **kwargs):
-    return requests.post(*args, **kwargs)
-
-@http_request_validation
-def api_delete(*args, **kwargs):
-    return requests.delete(*args, **kwargs)

splight-cli-2.3.12/cli/utils/headers.py

@@ -1,8 +0,0 @@
-from typing import Dict
-
-from cli.settings import SplightCLISettings
-
-
-def extract_headers(config: SplightCLISettings) -> Dict[str, str]:
-    header = f"Splight {config.SPLIGHT_ACCESS_ID} {config.SPLIGHT_SECRET_KEY}"
-    return {"Authorization": header}

splight-cli-2.3.12/cli/utils/uuid.py

@@ -1,8 +0,0 @@
-import uuid
-
-def is_valid_uuid(value: str):
-    try:
-        uuid.UUID(value)
-        return True
-    except ValueError:
-        return False

splight-cli-2.3.12/cli/utils/validation.py

@@ -1,6 +0,0 @@
-import os
-
-def validate_path_isdir(path: str) -> str:
-    if not os.path.isdir(path):
-        raise ValueError(f"Path provided: \"{path}\" is not a directory")
-    return path

splight-cli-2.3.12/cli/version.py

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

splight-cli-2.3.12/splight_cli.egg-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-splight = cli:cli.app
-