Changed the namespace to exasol.nb_connector

README.md

@@ -20,7 +20,7 @@ By that users of such notebook applications
 
 ```python
 from pathlib import Path
-from exasol.secret_store import Secrets
+from exasol.nb_connector.secret_store import Secrets
 
 file = "password_db.sqlite"
 secrets = Secrets(Path(file), "my secret password")

doc/changes/changelog.md

@@ -1,5 +1,6 @@
 # Changes
 
+* [0.2.7](changes_0.2.7.md)
 * [0.2.6](changes_0.2.6.md)
 * [0.2.5](changes_0.2.5.md)
 * [0.2.4](changes_0.2.4.md)
@@ -15,6 +16,7 @@
 ---
 hidden:
 ---
+changes_0.2.7
 changes_0.2.6
 changes_0.2.5
 changes_0.2.4

doc/changes/changes_0.2.7.md

@@ -0,0 +1,9 @@
+# Exasol Notebook Connector 0.2.7, released T.B.C.
+
+## Summary
+
+This release moves the notebook connector into a separate namespace - exasol.nb_connector.
+
+## Changes
+
+* #77: Move notebook connector into a separate namespace.

exasol/connections.py → exasol/nb_connector/connections.py

@@ -9,9 +9,9 @@
 import sqlalchemy  # type: ignore
 
 import exasol.bucketfs as bfs  # type: ignore
-from exasol.secret_store import Secrets
-from exasol.utils import optional_str_to_bool
-from exasol.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.utils import optional_str_to_bool
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 
 
 def _optional_encryption(conf: Secrets, key: CKey = CKey.db_encryption) -> Optional[bool]:

exasol/extension_wrapper_common.py → exasol/nb_connector/extension_wrapper_common.py

@@ -1,7 +1,7 @@
-from exasol.connections import open_pyexasol_connection
-from exasol.secret_store import Secrets
-from exasol.utils import optional_str_to_bool
-from exasol.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.connections import open_pyexasol_connection
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.utils import optional_str_to_bool
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 
 
 def str_to_bool(conf: Secrets, key: CKey, default_value: bool) -> bool:

exasol/itde_manager.py → exasol/nb_connector/itde_manager.py

@@ -17,9 +17,9 @@
     remove_docker_volumes,
 )
 
-from exasol.ai_lab_config import AILabConfig
-from exasol.container_by_ip import ContainerByIp, IPRetriever
-from exasol.secret_store import Secrets
+from exasol.nb_connector.ai_lab_config import AILabConfig
+from exasol.nb_connector.container_by_ip import ContainerByIp, IPRetriever
+from exasol.nb_connector.secret_store import Secrets
 
 ENVIRONMENT_NAME = "DemoDb"
 NAME_SERVER_ADDRESS = "8.8.8.8"

exasol/language_container_activation.py → exasol/nb_connector/language_container_activation.py

@@ -1,7 +1,7 @@
 from typing import Dict
 
-from exasol.secret_store import Secrets
-from exasol.connections import open_pyexasol_connection
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.connections import open_pyexasol_connection
 
 # All secret store entries with language container activation commands
 # will have this common prefix in their keys.

exasol/sagemaker_extension_wrapper.py → exasol/nb_connector/sagemaker_extension_wrapper.py

@@ -1,20 +1,20 @@
 from exasol_sagemaker_extension.deployment.deploy_create_statements import DeployCreateStatements   # type: ignore
 from exasol_sagemaker_extension.deployment.sme_language_container_deployer import SmeLanguageContainerDeployer  # type: ignore
 
-from exasol.connections import (
+from exasol.nb_connector.connections import (
     get_external_host,
     open_pyexasol_connection,
 )
-from exasol.extension_wrapper_common import (
+from exasol.nb_connector.extension_wrapper_common import (
     encapsulate_aws_credentials,
     str_to_bool
 )
-from exasol.language_container_activation import (
+from exasol.nb_connector.language_container_activation import (
     ACTIVATION_KEY_PREFIX,
     get_activation_sql
 )
-from exasol.secret_store import Secrets
-from exasol.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 
 # Root directory in a BucketFS bucket where all stuff of the Sagemaker
 # Extension, including its language container, will be uploaded.

exasol/secret_store.py → exasol/nb_connector/secret_store.py

@@ -11,7 +11,7 @@
 
 from sqlcipher3 import dbapi2 as sqlcipher  # type: ignore
 
-from exasol.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 
 _logger = logging.getLogger(__name__)
 TABLE_NAME = "secrets"

exasol/transformers_extension_wrapper.py → exasol/nb_connector/transformers_extension_wrapper.py

@@ -7,21 +7,21 @@
 
 # TODO: Disable this mypy "missing imports" nonsense.
 
-from exasol.connections import (
+from exasol.nb_connector.connections import (
     get_external_host,
     open_pyexasol_connection
 )
-from exasol.extension_wrapper_common import (
+from exasol.nb_connector.extension_wrapper_common import (
     encapsulate_bucketfs_credentials,
     encapsulate_huggingface_token,
     str_to_bool
 )
-from exasol.language_container_activation import (
+from exasol.nb_connector.language_container_activation import (
     ACTIVATION_KEY_PREFIX,
     get_activation_sql
 )
-from exasol.secret_store import Secrets
-from exasol.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 
 # Root directory in a BucketFS bucket where all stuff of the Transformers
 # Extension, including its language container, will be uploaded.

test/conftest.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from exasol.secret_store import Secrets
+from exasol.nb_connector.secret_store import Secrets
 
 
 @pytest.fixture

test/integration/test_cloud_storage.py

@@ -1,8 +1,8 @@
-from exasol.secret_store import Secrets
-from exasol.github import retrieve_jar, Project
-from exasol.connections import open_bucketfs_connection, open_pyexasol_connection
-from exasol.bfs_utils import put_file
-from exasol.cloud_storage import setup_scripts
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.github import retrieve_jar, Project
+from exasol.nb_connector.connections import open_bucketfs_connection, open_pyexasol_connection
+from exasol.nb_connector.bfs_utils import put_file
+from exasol.nb_connector.cloud_storage import setup_scripts
 
 from test.utils.integration_test_utils import setup_itde, get_script_counts
 

test/integration/test_itde_manager.py

@@ -11,9 +11,9 @@
     remove_docker_volumes,  # type: ignore
 )
 
-from exasol.ai_lab_config import AILabConfig
-from exasol.secret_store import Secrets
-from exasol.itde_manager import (
+from exasol.nb_connector.ai_lab_config import AILabConfig
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.itde_manager import (
     bring_itde_up,
     is_itde_running,
     start_itde,

test/integration/test_itde_manager_in_docker_container.py

@@ -22,7 +22,7 @@
     DockerContainerCopy,
 )
 
-from exasol.utils import upward_file_search
+from exasol.nb_connector.utils import upward_file_search
 
 # Name of a Docker container used by the tests in this file to manage  ITDE.
 TEST_CONTAINER = "itde_manager_container"
@@ -101,11 +101,11 @@ def itde_connect_test_impl():
     def run_test():
         from pathlib import Path
 
-        from exasol.ai_lab_config import AILabConfig
-        from exasol.connections import open_pyexasol_connection
-        from exasol.itde_manager import bring_itde_up
-        from exasol.itde_manager import take_itde_down
-        from exasol.secret_store import Secrets
+        from exasol.nb_connector.ai_lab_config import AILabConfig
+        from exasol.nb_connector.connections import open_pyexasol_connection
+        from exasol.nb_connector.itde_manager import bring_itde_up
+        from exasol.nb_connector.itde_manager import take_itde_down
+        from exasol.nb_connector.secret_store import Secrets
 
         secrets = Secrets(db_file=Path("secrets.sqlcipher"), master_password="test")
         secrets.save(AILabConfig.mem_size.value, "2")
@@ -137,10 +137,10 @@ def itde_recreation_after_take_down():
     def run_test():
         from pathlib import Path
 
-        from exasol.ai_lab_config import AILabConfig
-        from exasol.itde_manager import bring_itde_up
-        from exasol.itde_manager import take_itde_down
-        from exasol.secret_store import Secrets
+        from exasol.nb_connector.ai_lab_config import AILabConfig
+        from exasol.nb_connector.itde_manager import bring_itde_up
+        from exasol.nb_connector.itde_manager import take_itde_down
+        from exasol.nb_connector.secret_store import Secrets
 
         secrets = Secrets(db_file=Path("secrets.sqlcipher"), master_password="test")
         secrets.save(AILabConfig.mem_size.value, "2")
@@ -166,10 +166,10 @@ def itde_recreation_without_take_down():
     def run_test():
         from pathlib import Path
 
-        from exasol.ai_lab_config import AILabConfig
-        from exasol.itde_manager import bring_itde_up
-        from exasol.itde_manager import take_itde_down
-        from exasol.secret_store import Secrets
+        from exasol.nb_connector.ai_lab_config import AILabConfig
+        from exasol.nb_connector.itde_manager import bring_itde_up
+        from exasol.nb_connector.itde_manager import take_itde_down
+        from exasol.nb_connector.secret_store import Secrets
 
         secrets = Secrets(db_file=Path("secrets.sqlcipher"), master_password="test")
         secrets.save(AILabConfig.mem_size.value, "2")

test/integration/test_sagemaker_extension_wrapper.py

@@ -1,7 +1,7 @@
-from exasol.sagemaker_extension_wrapper import initialize_sme_extension
-from exasol.connections import open_pyexasol_connection
-from exasol.secret_store import Secrets
-from exasol.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.sagemaker_extension_wrapper import initialize_sme_extension
+from exasol.nb_connector.connections import open_pyexasol_connection
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 from test.utils.integration_test_utils import (
     setup_itde,
     activate_languages,

test/integration/test_transformers_extension_wrapper.py

@@ -1,9 +1,9 @@
 from _pytest.fixtures import FixtureRequest
 
-from exasol.connections import open_pyexasol_connection
-from exasol.secret_store import Secrets
-from exasol.ai_lab_config import AILabConfig as CKey
-from exasol.transformers_extension_wrapper import initialize_te_extension
+from exasol.nb_connector.connections import open_pyexasol_connection
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.transformers_extension_wrapper import initialize_te_extension
 from test.utils.integration_test_utils import (
     setup_itde,
     activate_languages,

test/unit/test_bfs_utils.py

@@ -2,8 +2,7 @@
 from unittest import mock
 from typing import Generator
 import pathlib
-from exasol import bfs_utils
-
+from exasol.nb_connector import bfs_utils
 
 MOCKED_BUCKET = "bucket"
 MOCKED_FILE_NAME = "bfs.file"

test/unit/test_cloud_storage.py

@@ -1,5 +1,5 @@
 from unittest import mock
-from exasol.cloud_storage import setup_scripts
+from exasol.nb_connector.cloud_storage import setup_scripts
 
 
 def test_setup_scripts(secrets):

test/unit/test_connections.py

@@ -8,14 +8,14 @@
 
 import pytest
 
-from exasol.connections import (
+from exasol.nb_connector.connections import (
     get_external_host,
     open_bucketfs_connection,
     open_pyexasol_connection,
     open_sqlalchemy_connection,
 )
-from exasol.secret_store import Secrets
-from exasol.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.secret_store import Secrets
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 
 
 @pytest.fixture

test/unit/test_container_by_ip.py

@@ -1,6 +1,5 @@
 from typing import (
     Dict,
-    List,
     Union, Tuple,
 )
 from unittest.mock import (
@@ -11,11 +10,10 @@
 )
 
 import docker
-import ifaddr
 import pytest
 from docker.models.containers import Container
 
-from exasol.container_by_ip import (
+from exasol.nb_connector.container_by_ip import (
     ContainerByIp
 )
 from test.utils.mock_cast import mock_cast

test/unit/test_github.py

@@ -3,7 +3,7 @@
 import pathlib
 import requests
 from unittest import mock
-from exasol import github
+from exasol.nb_connector import github
 
 CSE_MOCK_URL = "https://github.com/some_path/exasol-cloud-storage-extension-2.7.8.jar"
 

test/unit/test_itde_manager.py

@@ -15,8 +15,8 @@
 )
 from exasol_integration_test_docker_environment.lib.test_environment.ports import Ports
 
-from exasol.ai_lab_config import AILabConfig as CKey
-from exasol.itde_manager import (
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.itde_manager import (
     ENVIRONMENT_NAME,
     NAME_SERVER_ADDRESS,
     bring_itde_up,

test/unit/test_language_container_activation.py

@@ -1,7 +1,7 @@
 from unittest.mock import patch, MagicMock
 import pytest
 
-from exasol.language_container_activation import (
+from exasol.nb_connector.language_container_activation import (
     ACTIVATION_KEY_PREFIX,
     get_activation_sql,
     get_requested_languages,
@@ -11,7 +11,7 @@
 
 def test_get_registered_languages(secrets):
 
-    with patch('exasol.language_container_activation.get_registered_languages_string',
+    with patch('exasol.nb_connector.language_container_activation.get_registered_languages_string',
                MagicMock(return_value='R=builtin_r JAVA=builtin_java')):
 
         lang_definitions = get_registered_languages(secrets)
@@ -42,9 +42,9 @@ def test_get_requested_languages_ambiguous(secrets):
 
 def test_get_activation_sql(secrets):
 
-    with patch('exasol.language_container_activation.get_registered_languages',
+    with patch('exasol.nb_connector.language_container_activation.get_registered_languages',
                MagicMock(return_value={'lang1': 'url1', 'lang2': 'url2'})):
-        with patch('exasol.language_container_activation.get_requested_languages',
+        with patch('exasol.nb_connector.language_container_activation.get_requested_languages',
                    MagicMock(return_value={'lang2': 'url22', 'lang3': 'url33'})):
             act_sql = get_activation_sql(secrets)
             expected_sql = "ALTER SESSION SET SCRIPT_LANGUAGES='lang1=url1 lang2=url22 lang3=url33';"

test/unit/test_secret_store.py

@@ -2,11 +2,11 @@
 
 import pytest
 
-from exasol.secret_store import (
+from exasol.nb_connector.secret_store import (
     InvalidPassword,
     Secrets,
 )
-from exasol.ai_lab_config import AILabConfig as CKey
+from exasol.nb_connector.ai_lab_config import AILabConfig as CKey
 
 
 def test_no_database_file(secrets):

test/unit/test_utils.py

@@ -3,7 +3,7 @@
 
 import pytest
 
-from exasol.utils import upward_file_search, optional_str_to_bool
+from exasol.nb_connector.utils import upward_file_search, optional_str_to_bool
 
 
 def test_upward_file_search():