rename to gs_interactive

.gitignore

@@ -137,16 +137,16 @@ flex/interactive/sdk/python/dist/
 flex/interactive/sdk/python/.travis.yml
 flex/interactive/sdk/python/tox.ini
 flex/interactive/sdk/python/pyproject.toml
-flex/interactive/sdk/python/interactive/models/
-flex/interactive/sdk/python/interactive/api/
-flex/interactive/sdk/python/interactive/__init__.py
-flex/interactive/sdk/python/interactive/api_client.py
-flex/interactive/sdk/python/interactive/api_response.py
-flex/interactive/sdk/python/interactive/configuration.py
-flex/interactive/sdk/python/interactive/exceptions.py
-flex/interactive/sdk/python/interactive/py.typed
-flex/interactive/sdk/python/interactive/rest.py
-!flex/interactive/sdk/python/interactive/client/generated/__init__.py
+flex/interactive/sdk/python/gs_interactive/models/
+flex/interactive/sdk/python/gs_interactive/api/
+flex/interactive/sdk/python/gs_interactive/__init__.py
+flex/interactive/sdk/python/gs_interactive/api_client.py
+flex/interactive/sdk/python/gs_interactive/api_response.py
+flex/interactive/sdk/python/gs_interactive/configuration.py
+flex/interactive/sdk/python/gs_interactive/exceptions.py
+flex/interactive/sdk/python/gs_interactive/py.typed
+flex/interactive/sdk/python/gs_interactive/rest.py
+!flex/interactive/sdk/python/gs_interactive/client/generated/__init__.py
 
 
 **/.cache/

flex/interactive/sdk/generate_sdk.sh

@@ -17,7 +17,7 @@
 # It uses the Swagger Codegen tool to generate the SDK
 
 PACKAGE_NAME="com.alibaba.graphscope.interactive"
-PYTHON_PACKAGE_NAME="openapi"
+PYTHON_PACKAGE_NAME="gs_interactive"
 GROUP_ID="com.alibaba.graphscope"
 ARTIFACT_ID="interactive"
 ARTIFACT_URL="https://github.com/alibaba/GraphScope/tree/main/flex/interactive"
@@ -72,8 +72,7 @@ function do_gen_python() {
     echo "Generating Python SDK"
     OUTPUT_PATH="${CUR_DIR}/python"
     cmd="openapi-generator-cli generate -i ${OPENAPI_SPEC_PATH} -g python -o ${OUTPUT_PATH}"
-    # cmd=" ${cmd} --invoker-package ${PYTHON_PACKAGE_NAME}"
-    cmd=" ${cmd} --package-name interactive"
+    cmd=" ${cmd} --package-name ${PYTHON_PACKAGE_NAME}"
     cmd=" ${cmd} --additional-properties=packageVersion=${VERSION},pythonVersion=3"
     echo "Running command: ${cmd}"
     eval $cmd

flex/interactive/sdk/python/.openapi-generator-ignore

@@ -25,8 +25,8 @@
 
 README.md
 setup.py
-interactive/__init__.py
-interactive/client
+gs_interactive/__init__.py
+gs_interactive/client
 requirements.txt
 test-requirements.txt
 test/

flex/interactive/sdk/python/README.md

@@ -27,7 +27,7 @@ python setup.py install --user
 
 Then import the package:
 ```python
-import interactive
+import gs_interactive
 ```
 
 ### Tests
@@ -46,7 +46,7 @@ Then, connect to the interactive endpoint, and try to run a simple query with fo
 
 ```python
 
-from interactive.client.driver import Driver
+from gs_interactive.client.driver import Driver
 
 # replace endpoint with the actual interactive endpoint, this is mock server just for testing.
 interactive_endpoint='https://virtserver.swaggerhub.com/GRAPHSCOPE/interactive/1.0.0/'

flex/interactive/sdk/python/gs_interactive/client/__init__.py

@@ -0,0 +1,6 @@
+# flake8: noqa
+
+from gs_interactive.client.driver import Driver
+from gs_interactive.client.result import Result
+from gs_interactive.client.session import DefaultSession, Session
+from gs_interactive.client.status import Status

flex/interactive/sdk/python/interactive/client/driver.py → flex/interactive/sdk/python/gs_interactive/client/driver.py

@@ -28,7 +28,7 @@
 from neo4j import GraphDatabase
 from neo4j import Session as Neo4jSession
 
-from interactive.client.session import DefaultSession, Session
+from gs_interactive.client.session import DefaultSession, Session
 
 
 class Driver:

flex/interactive/sdk/python/interactive/client/result.py → flex/interactive/sdk/python/gs_interactive/client/result.py

@@ -20,9 +20,9 @@
 
 from pydantic import Field
 
-from interactive.api_response import ApiResponse
-from interactive.client.status import Status
-from interactive.exceptions import ApiException
+from gs_interactive.api_response import ApiResponse
+from gs_interactive.client.status import Status
+from gs_interactive.exceptions import ApiException
 
 # Define a generic type placeholder
 T = TypeVar("T")

flex/interactive/sdk/python/interactive/client/session.py → flex/interactive/sdk/python/gs_interactive/client/session.py

@@ -21,55 +21,55 @@
 
 from pydantic import Field, StrictStr
 
-from interactive.client.status import Status
-from interactive.api.admin_service_graph_management_api import (
+from gs_interactive.client.status import Status
+from gs_interactive.api.admin_service_graph_management_api import (
     AdminServiceGraphManagementApi,
 )
-from interactive.api.admin_service_job_management_api import (
+from gs_interactive.api.admin_service_job_management_api import (
     AdminServiceJobManagementApi,
 )
-from interactive.api.admin_service_procedure_management_api import (
+from gs_interactive.api.admin_service_procedure_management_api import (
     AdminServiceProcedureManagementApi,
 )
-from interactive.api.admin_service_service_management_api import (
+from gs_interactive.api.admin_service_service_management_api import (
     AdminServiceServiceManagementApi,
 )
-from interactive.api.graph_service_edge_management_api import (
+from gs_interactive.api.graph_service_edge_management_api import (
     GraphServiceEdgeManagementApi,
 )
-from interactive.api.graph_service_vertex_management_api import (
+from gs_interactive.api.graph_service_vertex_management_api import (
     GraphServiceVertexManagementApi,
 )
-from interactive.api.query_service_api import QueryServiceApi
-from interactive.api_client import ApiClient
-from interactive.client.result import Result
-from interactive.configuration import Configuration
-from interactive.models.create_graph_request import CreateGraphRequest
-from interactive.models.create_graph_response import CreateGraphResponse
-from interactive.models.create_procedure_request import (
+from gs_interactive.api.query_service_api import QueryServiceApi
+from gs_interactive.api_client import ApiClient
+from gs_interactive.client.result import Result
+from gs_interactive.configuration import Configuration
+from gs_interactive.models.create_graph_request import CreateGraphRequest
+from gs_interactive.models.create_graph_response import CreateGraphResponse
+from gs_interactive.models.create_procedure_request import (
     CreateProcedureRequest,
 )
-from interactive.models.create_procedure_response import (
+from gs_interactive.models.create_procedure_response import (
     CreateProcedureResponse,
 )
-from interactive.models.edge_request import EdgeRequest
-from interactive.models.get_graph_response import GetGraphResponse
-from interactive.models.get_graph_schema_response import (
+from gs_interactive.models.edge_request import EdgeRequest
+from gs_interactive.models.get_graph_response import GetGraphResponse
+from gs_interactive.models.get_graph_schema_response import (
     GetGraphSchemaResponse,
 )
-from interactive.models.get_graph_statistics_response import GetGraphStatisticsResponse
-from interactive.models.get_procedure_response import GetProcedureResponse
-from interactive.models.job_response import JobResponse
-from interactive.models.job_status import JobStatus
-from interactive.models.schema_mapping import SchemaMapping
-from interactive.models.service_status import ServiceStatus
-from interactive.models.start_service_request import StartServiceRequest
-from interactive.models.update_procedure_request import (
+from gs_interactive.models.get_graph_statistics_response import GetGraphStatisticsResponse
+from gs_interactive.models.get_procedure_response import GetProcedureResponse
+from gs_interactive.models.job_response import JobResponse
+from gs_interactive.models.job_status import JobStatus
+from gs_interactive.models.schema_mapping import SchemaMapping
+from gs_interactive.models.service_status import ServiceStatus
+from gs_interactive.models.start_service_request import StartServiceRequest
+from gs_interactive.models.update_procedure_request import (
     UpdateProcedureRequest,
 )
-from interactive.models.query_request import QueryRequest
-from interactive.models.vertex_request import VertexRequest
-from interactive.client.generated.results_pb2 import CollectiveResults
+from gs_interactive.models.query_request import QueryRequest
+from gs_interactive.models.vertex_request import VertexRequest
+from gs_interactive.client.generated.results_pb2 import CollectiveResults
 
 
 class EdgeInterface(metaclass=ABCMeta):
@@ -547,11 +547,11 @@ def call_procedure(
         self, graph_id: StrictStr, params: QueryRequest
     ) -> Result[CollectiveResults]:
         try:
-            # Interactive currently support four type of inputformat, see flex/engines/graph_db/graph_db_session.h
+            # gs_interactive currently support four type of inputformat, see flex/engines/graph_db/graph_db_session.h
             # Here we add byte of value 1 to denote the input format is in json format
             response = self._query_api.proc_call_with_http_info(
                 graph_id = graph_id, 
-                x_interactive_request_format = self.JSON_FORMAT,
+                x_gs_interactive_request_format = self.JSON_FORMAT,
                 body=params.to_json()
             )
             result = CollectiveResults()
@@ -567,10 +567,10 @@ def call_procedure_current(
         self, params: QueryRequest
     ) -> Result[CollectiveResults]:
         try:
-            # Interactive currently support four type of inputformat, see flex/engines/graph_db/graph_db_session.h
+            # gs_interactive currently support four type of inputformat, see flex/engines/graph_db/graph_db_session.h
             # Here we add byte of value 1 to denote the input format is in json format
             response = self._query_api.proc_call_current_with_http_info(
-                x_interactive_request_format = self.JSON_FORMAT,
+                x_gs_interactive_request_format = self.JSON_FORMAT,
                 body = params.to_json()
             )
             result = CollectiveResults()
@@ -584,11 +584,11 @@ def call_procedure_current(
 
     def call_procedure_raw(self, graph_id: StrictStr, params: str) -> Result[str]:
         try:
-            # Interactive currently support four type of inputformat, see flex/engines/graph_db/graph_db_session.h
+            # gs_interactive currently support four type of inputformat, see flex/engines/graph_db/graph_db_session.h
             # Here we add byte of value 1 to denote the input format is in encoder/decoder format
             response = self._query_api.proc_call_with_http_info(
                 graph_id = graph_id, 
-                x_interactive_request_format = self.ENCODER_FORMAT, 
+                x_gs_interactive_request_format = self.ENCODER_FORMAT, 
                 body = params
             )
             return Result.from_response(response)
@@ -597,10 +597,10 @@ def call_procedure_raw(self, graph_id: StrictStr, params: str) -> Result[str]:
 
     def call_procedure_current_raw(self, params: str) -> Result[str]:
         try:
-            # Interactive currently support four type of inputformat, see flex/engines/graph_db/graph_db_session.h
+            # gs_interactive currently support four type of inputformat, see flex/engines/graph_db/graph_db_session.h
             # Here we add byte of value 1 to denote the input format is in encoder/decoder format
             response = self._query_api.proc_call_current_with_http_info(
-                x_interactive_request_format = self.ENCODER_FORMAT, 
+                x_gs_interactive_request_format = self.ENCODER_FORMAT, 
                 body = params
             )
             return Result.from_response(response)

flex/interactive/sdk/python/interactive/client/status.py → flex/interactive/sdk/python/gs_interactive/client/status.py

@@ -19,8 +19,8 @@
 
 from enum import Enum
 
-from interactive.api_response import ApiResponse
-from interactive.exceptions import (
+from gs_interactive.api_response import ApiResponse
+from gs_interactive.exceptions import (
     ApiException,
     BadRequestException,
     ForbiddenException,

flex/interactive/sdk/python/setup.py

@@ -21,7 +21,7 @@
 #
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
-NAME = "interactive"
+NAME = "gs_interactive"
 VERSION = "0.3"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
@@ -53,7 +53,7 @@ def finalize_options(self):
     def run(self):
         proto_path = "../../../../interactive_engine/executor/ir/proto/"
         proto_files = glob.glob(os.path.join(proto_path, '*.proto'))
-        output_dir = "./interactive/client/generated/"
+        output_dir = "./gs_interactive/client/generated/"
         os.makedirs(output_dir, exist_ok=True)
         for proto_file in proto_files:
             cmd = [
@@ -87,6 +87,6 @@ def run(self):
     long_description="""\
     This is the definition of GraphScope Interactive API, including   - AdminService API   - Vertex/Edge API   - QueryService   AdminService API (with tag AdminService) defines the API for GraphManagement, ProcedureManagement and Service Management.  Vertex/Edge API (with tag GraphService) defines the API for Vertex/Edge management, including creation/updating/delete/retrive.  QueryService API (with tag QueryService) defines the API for procedure_call, Ahodc query. 
     """,  # noqa: E501
-    package_data={"interactive": ["py.typed"]},
+    package_data={"gs_interactive": ["py.typed"]},
     cmdclass={"build_proto": BuildProto}, 
 )

flex/interactive/sdk/python/test/test_driver.py

@@ -23,48 +23,48 @@
 
 import pytest
 
-from interactive.client.driver import Driver
-from interactive.models.base_edge_type_vertex_type_pair_relations_inner import (
+from gs_interactive.client.driver import Driver
+from gs_interactive.models.base_edge_type_vertex_type_pair_relations_inner import (
     BaseEdgeTypeVertexTypePairRelationsInner,
 )
-from interactive.models.create_edge_type import CreateEdgeType
-from interactive.models.create_graph_request import CreateGraphRequest
-from interactive.models.create_graph_schema_request import (
+from gs_interactive.models.create_edge_type import CreateEdgeType
+from gs_interactive.models.create_graph_request import CreateGraphRequest
+from gs_interactive.models.create_graph_schema_request import (
     CreateGraphSchemaRequest,
 )
-from interactive.models.create_procedure_request import (
+from gs_interactive.models.create_procedure_request import (
     CreateProcedureRequest,
 )
-from interactive.models.create_property_meta import CreatePropertyMeta
-from interactive.models.create_vertex_type import CreateVertexType
-from interactive.models.edge_mapping import EdgeMapping
-from interactive.models.edge_mapping_type_triplet import (
+from gs_interactive.models.create_property_meta import CreatePropertyMeta
+from gs_interactive.models.create_vertex_type import CreateVertexType
+from gs_interactive.models.edge_mapping import EdgeMapping
+from gs_interactive.models.edge_mapping_type_triplet import (
     EdgeMappingTypeTriplet,
 )
-from interactive.models.gs_data_type import GSDataType
-from interactive.models.typed_value import TypedValue
-from interactive.models.job_status import JobStatus
-from interactive.models.long_text import LongText
-from interactive.models.primitive_type import PrimitiveType
-from interactive.models.schema_mapping import SchemaMapping
-from interactive.models.schema_mapping_loading_config import (
+from gs_interactive.models.gs_data_type import GSDataType
+from gs_interactive.models.typed_value import TypedValue
+from gs_interactive.models.job_status import JobStatus
+from gs_interactive.models.long_text import LongText
+from gs_interactive.models.primitive_type import PrimitiveType
+from gs_interactive.models.schema_mapping import SchemaMapping
+from gs_interactive.models.schema_mapping_loading_config import (
     SchemaMappingLoadingConfig,
 )
-from interactive.models.schema_mapping_loading_config_format import (
+from gs_interactive.models.schema_mapping_loading_config_format import (
     SchemaMappingLoadingConfigFormat,
 )
-from interactive.models.start_service_request import StartServiceRequest
-from interactive.models.string_type import StringType
-from interactive.models.string_type_string import StringTypeString
-from interactive.models.vertex_mapping import VertexMapping
-from interactive.models.query_request import QueryRequest
+from gs_interactive.models.start_service_request import StartServiceRequest
+from gs_interactive.models.string_type import StringType
+from gs_interactive.models.string_type_string import StringTypeString
+from gs_interactive.models.vertex_mapping import VertexMapping
+from gs_interactive.models.query_request import QueryRequest
 
 class TestDriver(unittest.TestCase):
     """Test usage of driver"""
 
     def setUp(self):
-        # get endpoint from environment variable INTERACTIVE_ENDPOINT
-        self._endpoint = os.getenv("INTERACTIVE_ENDPOINT")
+        # get endpoint from environment variable gs_interactive_ENDPOINT
+        self._endpoint = os.getenv("gs_interactive_ENDPOINT")
         if self._endpoint is None:
             self._endpoint = "http://localhost:7777"
         print("endpoint: ", self._endpoint)