Merge branch 'main' of https://github.com/koi-learning/koi-core into …

…main

CHANGELOG.md

@@ -17,3 +17,16 @@
 - fixed tests for role management
 ### 0.3.7
 - added "last_modified" field to instances and models --> This needs koi_api version to be 0.3.3+!
+### 0.3.8
+- made koi_core compatible with Python3.6
+- added tagged releases on github
+### 0.3.9
+- fixed the persistence functions
+- using UUID as id for every object as hash() is salted for strings since Py3.3
+## 0.4
+- added `is_koi_reachable(base_url: str)`
+- added `try_create_api_object_pool(...)`
+### 0.4.1
+- removed setup.py
+- added pyproject.toml
+- use of entrypoints instead of scripts

koi_core/__init__.py

@@ -28,6 +28,7 @@
 from koi_core.resources.pool import APIObjectPool, LocalOnlyObjectPool
 from koi_core.exceptions import KoiInitializationError
 import koi_core.control  # noqa: F401
+from koi_core.api import is_koi_reachable
 
 _isInitialized = False
 
@@ -70,6 +71,15 @@ def create_local_object_pool():
     return LocalOnlyObjectPool()
 
 
+def try_create_api_object_pool(
+    host: str, username: str, password: str, persistance_file: Union[IOBase, str] = None
+):
+    if is_koi_reachable(host):
+        return create_api_object_pool(host, username, password, persistance_file)
+    else:
+        return create_offline_object_pool(host, persistance_file)
+
+
 def local_instance(path, parameter) -> Instance:
     pool = create_local_object_pool()
     model = pool.new_model()

koi_core/api/__init__.py

@@ -13,13 +13,17 @@
 # GNU Lesser General Public License is distributed along with this
 # software and can be found at http://www.gnu.org/licenses/lgpl.html
 
-from koi_core.api.common import BaseAPI, RequestsAPI
-from .model import APIModels
-from .instance import APIInstances
-from .sample import APISamples
-from .user import APIUsers
-from .role import APIRoles
-from .access import APIAccess
+from koi_core.api.common import BaseAPI, RequestsAPI, is_reachable
+from koi_core.api.model import APIModels
+from koi_core.api.instance import APIInstances
+from koi_core.api.sample import APISamples
+from koi_core.api.user import APIUsers
+from koi_core.api.role import APIRoles
+from koi_core.api.access import APIAccess
+
+
+def is_koi_reachable(host: str) -> bool:
+    return is_reachable(host)
 
 
 class API(RequestsAPI):

koi_core/api/common.py

@@ -41,6 +41,14 @@
 T = TypeVar("T")
 
 
+def is_reachable(base_url: str):
+    try:
+        ret = requests.get(base_url + "/health")
+        return ret.status_code == 200
+    except requests.exceptions.ConnectionError:
+        return False
+
+
 class BearerAuth(requests.auth.AuthBase):
     def __init__(self, token):
         self.token = token

koi_core/api/instance.py

@@ -15,7 +15,7 @@
 from uuid import UUID
 from typing import Iterable, Tuple
 
-from .common import BaseAPI, _parse, _encode
+from koi_core.api.common import BaseAPI, _parse, _encode
 from koi_core.caching import CachingMeta
 from koi_core.resources.ids import ModelId, InstanceId, DescriptorId
 

koi_core/api/model.py

@@ -15,7 +15,7 @@
 from uuid import UUID
 from typing import Tuple
 
-from .common import BaseAPI, _parse, _encode
+from koi_core.api.common import BaseAPI, _parse, _encode
 from koi_core.caching import CachingMeta
 from koi_core.resources.ids import ModelId
 

koi_core/api/sample.py

@@ -16,7 +16,7 @@
 from uuid import UUID
 from typing import Tuple
 
-from .common import BaseAPI, _parse, _encode
+from koi_core.api.common import BaseAPI, _parse, _encode
 from koi_core.caching import CachingMeta
 from koi_core.resources.ids import InstanceId, SampleId, SampleDatumId, SampleLableId
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "koi-core"
-version = "0.3.10"
+version = "0.4.1"
 description = "Runtime for the KOI-System including koi-worker"
 readme = "README.md"
 requires-python = ">=3.6"