weaviate-cli 2.1.3.dev1__tar.gz → 2.2.0__tar.gz

weaviate-cli-2.2.0/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2021, SeMI Technologies B.V.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

weaviate-cli-2.2.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: weaviate-cli
+Version: 2.2.0
+Summary: Comand line interface to interact with weaviate
+Author: SeMI Technologies
+Author-email: hello@semi.technology
+Requires-Python: >=3.6
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+
+Weaviate CLI
+============
+.. image:: https://raw.githubusercontent.com/semi-technologies/weaviate/19de0956c69b66c5552447e84d016f4fe29d12c9/docs/assets/weaviate-logo.png
+    :width: 180
+    :align: right
+    :alt: Weaviate logo
+
+.. image:: https://travis-ci.com/semi-technologies/weaviate-cli.svg?branch=master
+    :target: https://travis-ci.com/semi-technologies/weaviate-cli
+    :alt: Build Status (Travis CI)
+
+.. image:: https://badge.fury.io/py/weaviate-cli.svg
+    :target: https://badge.fury.io/py/weaviate-cli
+    :alt: PyPI version
+
+
+**Command Line Interface (CLI) tool for interacting with a Weaviate instance directly from your Terminal**
+
+Visit the official `SeMi Technology <https://weaviate.io/>`_ website for more information about the Weaviate and how to use it in production.
+
+Check out our `weaviate-client <https://pypi.org/project/weaviate-client/>`_ library for interacting with a Weaviate instance using python.
+
+Installation
+------------
+
+| Install using: ``pip install weaviate-cli``
+| Run using: ``weaviate --help``
+
+Articles
+--------
+
+Here are some articles on weaviate: 
+
+- `Semantic Search Queries Return More Informed Results <https://hackernoon.com/semantic-search-queries-return-more-informed-results-nr5335nw>`_
+- `Getting Started with Weaviate Python Library <https://towardsdatascience.com/getting-started-with-weaviate-python-client-e85d14f19e4f>`_
+- `A sub-50ms neural search with DistilBERT and Weaviate <https://towardsdatascience.com/a-sub-50ms-neural-search-with-distilbert-and-weaviate-4857ae390154>`_
+- `SeMI Technology Medium blogs <https://medium.com/semi-technologies>`_
+
+Support
+-------
+
+- Use our `Slack Channel <https://join.slack.com/t/weaviate/shared_invite/zt-goaoifjr-o8FuVz9b1HLzhlUfyfddhw>`_ for support or any other question.
+- Use the ``weaviate`` tag on `Stackoverflow <https://stackoverflow.com/questions/tagged/weaviate>`_  for questions.
+- For bugs and/or problems with the package submit a Github `issue <https://github.com/semi-technologies/weaviate-python-client/issues>`_.
+
+Contributing
+------------
+
+- Do you want to contribute to `Weaviate`, read `How to Contribute <https://github.com/semi-technologies/weaviate/blob/master/CONTRIBUTE.md>`_.

{weaviate-cli-2.1.3.dev1 → weaviate-cli-2.2.0}/README.rst

@@ -16,7 +16,7 @@ Weaviate CLI
 
 **Command Line Interface (CLI) tool for interacting with a Weaviate instance directly from your Terminal**
 
-Visit the official `SeMi Technology <https://www.semi.technology/>`_ website for more information about the Weaviate and how to use it in production.
+Visit the official `SeMi Technology <https://weaviate.io/>`_ website for more information about the Weaviate and how to use it in production.
 
 Check out our `weaviate-client <https://pypi.org/project/weaviate-client/>`_ library for interacting with a Weaviate instance using python.
 

weaviate-cli-2.2.0/cli.py

@@ -0,0 +1,29 @@
+import click
+from semi.config.commands import Configuration, config_group
+from semi.data.commands import data_group
+from semi.schema.commands import schema_group
+from semi.classification.commands import classification_group
+from semi.misc import main_init, main_ping, main_version
+
+
+@click.group()
+@click.pass_context
+@click.option('--config-file', required=False, default=None, type=str, is_flag=False,
+              help="If specified cli uses the config specified with this path.")
+def main(ctx: click.Context, config_file):
+    ctx.obj = {
+        "config": Configuration(config_file)
+    }
+
+
+main.add_command(config_group)
+main.add_command(data_group)
+main.add_command(schema_group)
+main.add_command(classification_group)
+main.add_command(main_ping)
+main.add_command(main_version)
+main.add_command(main_init)
+
+
+if __name__ == "__main__":
+    main()

weaviate-cli-2.2.0/semi/classification/commands.py

@@ -0,0 +1,161 @@
+"""
+Weaviate CLI classification group functions.
+"""
+import json
+import click
+
+from semi.utils import get_client_from_context
+
+
+@click.group('classify')
+@click.pass_context
+def classification_group(ctx : click.Context):
+    """
+        Classification of data.
+    """
+
+    ctx.obj["classification"] = get_classification_from_ctx(ctx)
+
+
+@classification_group.command('get')
+@click.pass_context
+@click.argument('classification_id')
+def get_classification(ctx, classification_id):
+    """
+    Get a classification info by id.
+    """
+
+    show_classification_info(ctx.obj["classification"], classification_id)
+
+
+@classification_group.command('status')
+@click.pass_context
+@click.argument('classification_id')
+def get_classification_status(ctx, classification_id):
+    """
+    Get a classification status by id.
+    """
+
+    show_classification_status(ctx.obj["classification"], classification_id)
+
+
+# TODO: Accept array input
+@classification_group.command('start')
+@click.pass_context
+@click.option('--class-name', required = True, type = str,
+                                help = "Object type to classify")
+@click.option('--based-on', required = True, type = str,
+                                help = "Properties to base classification on")
+@click.option('--property', required = True, type = str,
+                                help = "Properties to classify")
+@click.option('-k', '--k', required = False, type = int,
+                                help = "Use kNN classification with value k")
+def start_classification(ctx, class_name, based_on, property, k):
+    """
+    Start a classification.
+    """
+
+    if k:
+        start_knn_classification(ctx.obj["classification"], class_name,
+                                                            [based_on], [property], k)
+    else:
+        start_contextionary_classification(ctx.obj["classification"], class_name,
+                                                                [based_on], [property])
+
+
+####################################################################################################
+# Helper functions
+####################################################################################################
+
+
+def show_classification_status(classification, classification_id : str):
+    """
+    Get a classification status by id.
+
+    Parameters
+    ----------
+    classification : Classification
+        Classification client.
+    classification_id : str
+        Classification id.
+    """
+
+    if classification.is_running(classification_id):
+        click.echo("Classification is running.")
+    elif classification.is_failed(classification_id):
+        click.echo("Classification failed.")
+    elif classification.is_complete(classification_id):
+        click.echo("Classification is complete.")
+
+
+def show_classification_info(classification, classification_id : str):
+    """
+    Get a classification info by id.
+
+    Parameters
+    ----------
+    classification : Classification
+        Classification client.
+    classification_id : str
+        Classification id.
+    """
+
+    result = classification.get(classification_id)
+    click.echo(json.dumps(result, indent=4))
+
+
+def start_contextionary_classification(classification, class_name : str, based_on : list, properties : list):
+    """
+    Start a contextionary classification.
+
+    Parameters
+    ----------
+    classification : Classification
+        Classification client.
+    class_name : str
+        Object type to classify.
+    based_on : list
+        Properties to base classification on.
+    properties : list
+        Properties to classify.
+    """
+
+    result = classification.schedule()\
+        .with_type("text2vec-contextionary-contextual")\
+        .with_class_name(class_name)\
+        .with_based_on_properties(based_on)\
+        .with_classify_properties(properties)\
+        .do()
+    show_classification_info(classification, result['id'])
+
+
+def start_knn_classification(classification, class_name : str, based_on : list, properties : list, k : int):
+    """
+    Start a kNN classification.
+
+    Parameters
+    ----------
+    classification : Classification
+        Classification client.
+    class_name : str
+        Object type to classify.
+    based_on : list
+        Properties to base classification on.
+    properties : list
+        Properties to classify.
+    k : int
+        kNN value.
+    """
+
+    result = classification.schedule()\
+        .with_type("knn")\
+        .with_class_name(class_name)\
+        .with_based_on_properties(based_on)\
+        .with_classify_properties(properties)\
+        .with_settings({'k':k})\
+        .do()
+    show_classification_info(classification, result['id'])
+
+
+def get_classification_from_ctx(ctx : click.Context):
+    return get_client_from_context(ctx).classification

weaviate-cli-2.2.0/semi/config/commands.py

@@ -0,0 +1,214 @@
+"""
+Weaviate CLI config group functions.
+"""
+
+import os
+import sys
+import json
+from pathlib import Path
+from typing import Optional
+from getpass import getpass
+
+import click
+import requests
+import weaviate
+from semi.prompt import let_user_pick
+import semi.config.config_values as cfg_vals
+
+
+@click.group("config")
+def config_group():
+    """
+    Configuration of the CLI.
+    """
+    pass
+
+
+@config_group.command("view")
+@click.pass_context
+def config_view(ctx):
+    """
+    Print the current CLI configuration.
+    """
+
+    print(ctx.obj["config"])
+
+
+@config_group.command("set")
+@click.pass_context
+def config_set(ctx):
+    """
+    Set a new CLI configuration.
+    """
+
+    ctx.obj["config"].create_new_config()
+
+
+####################################################################################################
+# Helper class
+####################################################################################################
+
+
+class Configuration:
+    default_file_path = ".config/semi_technologies/"
+    default_file_name = "configs.json"
+
+    def __init__(self, config_file: Optional[str] = None):
+        """
+        Initialize a configuration instance.
+
+        Parameters
+        ----------
+        config_file : str or None
+            The path to the user specified configuration file.
+        """
+        if config_file:
+            assert os.path.isfile(config_file), "Config file does not exist!"
+            self.config_path = config_file
+            with open(self.config_path, 'r', encoding="utf-8") as config_data:
+                try:
+                    self.config = json.load(config_data)
+                except:
+                    click.echo("Fatal Error: Config file is not valid JSON!")
+                    sys.exit(1)
+
+        else:
+            self.config_path = Path(os.path.join(os.getenv("HOME"),
+                                            self.default_file_path,
+                                            self.default_file_name))
+            self.config_path.touch(exist_ok=True)
+            with open(self.config_path, 'r', encoding="utf-8") as configuration_file:
+                try:
+                    self.config = json.load(configuration_file)
+                except:
+                    click.echo("No existing configuration found, creating new one.")
+                    self.create_new_config()
+
+
+    def get_client(self) -> weaviate.Client:
+        """
+        Get a weaviate client from the configuration.
+
+        Returns
+        -------
+        weaviate.Client
+            A weaviate client.
+        """
+
+        try:
+            if self.config["auth"] is None:
+                return weaviate.Client(self.config["url"])
+            if self.config["auth"]["type"] == cfg_vals.config_value_auth_type_client_secret:
+                cred = weaviate.AuthClientCredentials(self.config["auth"]["secret"])
+                return weaviate.Client(self.config["url"], cred)
+            if self.config["auth"]["type"] == cfg_vals.config_value_auth_type_username_pass:
+                cred = weaviate.AuthClientPassword(self.config["auth"]["user"], self.config["auth"]["pass"])
+                return weaviate.Client(self.config["url"], cred)
+        except requests.exceptions.ConnectionError:
+            click.echo("Fatal Error: Could not connect to the weaviate instance!")
+            sys.exit(1)
+        except KeyError:
+            click.echo("Fatal Error: Unknown authentication type in config!")
+            sys.exit(1)
+
+
+    def create_new_config(self):
+        """
+        Create a new configuration (interacitve).
+        """
+
+        self.config = {
+            "url": input("Please give a weaviate url: "),
+            "auth": self.get_authentication_config()
+        }
+
+        self.write_config(self.config)
+
+        print("Config creation complete\n")
+
+
+    @classmethod
+    def write_config(cls, configuration: dict):
+        """
+        Write a configuration to the config file.
+
+        Parameters
+        ----------
+        configuration : dict
+            The configuration to write.
+        """
+
+        config_path = Path(os.path.join(os.getenv("HOME"),
+                                            cls.default_file_path,
+                                            cls.default_file_name))
+
+        with open(config_path, 'w', encoding="utf-8") as configuration_file:
+            json.dump(configuration, configuration_file)
+
+
+    @classmethod
+    def create_user_specified_config(cls, url: str, user: str, password: str, client_secret: str):
+        """
+        Create a configuration from user specified values.
+
+        Parameters
+        ----------
+        url : str
+            The weaviate url.
+        user : str
+            The user name.
+        password : str
+            The user password.
+        client_secret : str
+            The client secret.
+        """
+
+        if user and password:
+            auth = {
+                "type": cfg_vals.config_value_auth_type_username_pass,
+                "user": user,
+                "pass": password
+            }
+        elif client_secret:
+            auth = {
+                "type": cfg_vals.config_value_auth_type_client_secret,
+                "secret": client_secret
+            }
+        else:
+            auth = None
+
+        config = {
+            "url": url,
+            "auth": auth
+        }
+
+        cls.write_config(config)
+
+
+    def get_authentication_config(self) -> Optional[dict]:
+        """
+        Get the authentication configuration.
+
+        Returns
+        -------
+        dict
+            The authentication configuration.
+        """
+
+        auth_options = ["No authentication", "Client secret", "Username and password"]
+        selection_index = let_user_pick(auth_options, "Please select the authentication method:")
+        if selection_index == 1:
+            return {
+                "type": cfg_vals.config_value_auth_type_client_secret,
+                "secret": getpass("Please specify the client secret: ")
+            }
+        if selection_index == 2:
+            return {
+                "type": cfg_vals.config_value_auth_type_username_pass,
+                "user": input("Please specify the user name: "),
+                "pass": getpass("Please specify the user password: ")
+            }
+        return None
+
+    def __str__(self):
+        return str(json.dumps(self.config, indent=4))

weaviate-cli-2.1.3.dev1/semi/commands/data.py → weaviate-cli-2.2.0/semi/data/commands.py

@@ -1,15 +1,42 @@
-import json
+"""
+Weaviate CLI data group functions.
+"""
+
 import sys
+import json
+import click
 import weaviate
-# import Batcher for weaviate-client version < 3.0.0
-VERSION_2 = (int(weaviate.__version__.split('.')[0]) < 3)
-if VERSION_2:
-    from weaviate.tools import Batcher
-from semi.config.configuration import Configuration
+
+from semi.utils import get_client_from_context
 from semi.prompt import is_question_answer_yes
 
 
-def delete_all_data(cfg: Configuration, force: bool) -> None:
+@click.group("data", help="Data object manipulation in weaviate.")
+def data_group():
+    pass
+
+
+@data_group.command("import", help="Import data from json file.")
+@click.pass_context
+@click.argument('file')
+@click.option('--fail-on-error', required=False, default=False, is_flag=True, help="Fail if entity loading throws an error")
+def concept_import(ctx, file, fail_on_error):
+    import_data_from_file(get_client_from_context(ctx), file, fail_on_error)
+
+
+@data_group.command("delete", help="Delete all data objects in weaviate.")
+@click.pass_context
+@click.option('--force', required=False, default=False, is_flag=True)
+def data_empty(ctx, force):
+    delete_all_data(get_client_from_context(ctx), force)
+
+
+####################################################################################################
+# Helper functions
+####################################################################################################
+
+
+def delete_all_data(client: weaviate.Client, force: bool) -> None:
     """
     Delete all weaviate objects.
 
@@ -22,11 +49,11 @@ def delete_all_data(cfg: Configuration, force: bool) -> None:
     """
 
     if force:
-        _delete_all(cfg.client)
+        _delete_all(client)
         sys.exit(0)
     if not is_question_answer_yes("Do you really want to delete all data?"):
         sys.exit(0)
-    _delete_all(cfg.client)
+    _delete_all(client)
 
 
 def _delete_all(client: weaviate.Client):
@@ -44,7 +71,7 @@ def _delete_all(client: weaviate.Client):
     client.schema.create(schema)
 
 
-def import_data_from_file(cfg: Configuration, file: str, fail_on_error: bool) -> None:
+def import_data_from_file(client: weaviate.Client, file: str, fail_on_error: bool) -> None:
     """
     Import data from a file.
 
@@ -58,10 +85,15 @@ def import_data_from_file(cfg: Configuration, file: str, fail_on_error: bool) ->
         If True exits at the first error, if False prints the error only.
     """
 
-    importer = DataFileImporter(cfg.client, file, fail_on_error)
+    importer = DataFileImporter(client, file, fail_on_error)
     importer.load()
 
 
+####################################################################################################
+# DataFileImporter
+####################################################################################################
+
+
 class DataFileImporter:
 
     def __init__(self, client: weaviate.Client, data_path: str, fail_on_error: bool):
@@ -80,17 +112,12 @@ class DataFileImporter:
 
         self.client = client
         self.fail_on_error = fail_on_error
-        if VERSION_2:
-            self.batcher = Batcher(
-                client,
-                batch_size=512,
-                return_values_callback=self._exit_on_error,
-            )
-        else:
-            self.batcher = client.batch(
-                batch_size=512,
-                callback=self._exit_on_error,
-            )
+
+        self.batcher = client.batch(
+            batch_size=512,
+            callback=self._exit_on_error,
+        )
+
         with open(data_path, 'r') as data_io:
             self.data = json.load(data_io)
 
@@ -126,10 +153,7 @@ class DataFileImporter:
             self.batcher.add_data_object(**obj)
         for ref in vasd.data_references:
             self.batcher.add_reference(**ref)
-        if VERSION_2:
-            self.batcher.close()
-        else:
-            self.batcher.flush()
+        self.batcher.flush()
 
 class ValidateAndSplitData:
 
@@ -151,9 +175,9 @@ class ValidateAndSplitData:
         self.data_references = []
 
     def validate_and_split(self) -> None:
-        """ 
+        """
         Go through the entire data and validate it against a schema
-        if not valid exit with error, if valid split it into the 
+        if not valid exit with error, if valid split it into the
         primitive object and the references.
         """
 
@@ -216,7 +240,7 @@ def dissect_reference(refs: list, from_class: str, from_id: str, from_prop: str)
     refs : list
         A list of references to be dissected.
     from_class : str
-        The object's class name. 
+        The object's class name.
     from_id : str
         The id of the object.
     from_prop : str
@@ -242,7 +266,7 @@ def dissect_reference(refs: list, from_class: str, from_id: str, from_prop: str)
 
 
 def dissect_schema(schema: dict) -> dict:
-    """ 
+    """
     Dissect the schema into a dict listing all classes with their name as key to have faster
     validation access.