isahitlab 0.0.1__tar.gz

isahitlab-0.0.1/.gitignore

@@ -0,0 +1,76 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/dist-test
+/dist-dev
+/tmp
+/out-tsc
+
+
+# dependencies
+/node_modules
+**/node_modules
+**/web_modules
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.angular/cache
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db
+
+#Credentials
+*.key
+
+#Ignore .env.*
+.env.*
+
+docker-compose.env
+tools/keycloak/deployments/*.deployed
+tools/keycloak/deployments/*.isdeploying
+/release-config
+/.angular
+
+.angular
+tools/kafka/dist/
+tools/kafka/dist
+
+shared-temp/*
+
+cerbos/policies
+**/__pycache__
+
+**/secrets/*shared-temp/
+.nx
+sdk/lab/lab-sdk-env/
+sdk/lab/tests/veolia_kili/
+lab-sdk-env/
+envs
+sdk/output/
+sdk/lab/site/
+sdk/lab/dist/

isahitlab-0.0.1/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Benjamin Piogé <benjamin@isahit.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

isahitlab-0.0.1/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.3
+Name: isahitlab
+Version: 0.0.1
+Summary: Python client for isahit lab
+Project-URL: Documentation, https://sdk-docs.lab.isahit.com/latest/
+Author-email: Isahit <dev@isahit.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: jsonschema>=4
+Requires-Dist: requests<3.0.0,>=2.0.0
+Requires-Dist: tqdm<5.0.0,>=4.0.0
+Requires-Dist: typeguard<5,>=4
+Description-Content-Type: text/markdown
+
+# isahitlab
+
+[![PyPI - Version](https://img.shields.io/pypi/v/isahitlab.svg)](https://pypi.org/project/isahitlab)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/isahitlab.svg)](https://pypi.org/project/isahitlab)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install isahitlab
+```
+
+
+## License
+
+`isahitlab` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

isahitlab-0.0.1/README.md

@@ -0,0 +1,22 @@
+# isahitlab
+
+[![PyPI - Version](https://img.shields.io/pypi/v/isahitlab.svg)](https://pypi.org/project/isahitlab)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/isahitlab.svg)](https://pypi.org/project/isahitlab)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install isahitlab
+```
+
+
+## License
+
+`isahitlab` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

isahitlab-0.0.1/docs/dataset.md

@@ -0,0 +1,3 @@
+# Dataset module
+
+::: isahitlab.actions.dataset

isahitlab-0.0.1/docs/index.md

@@ -0,0 +1,51 @@
+# Getting started
+
+This is the documentation of the Python SDK for [Isahit Lab](https://lab.isahit.com).
+
+Learn more about **isahit** [here](https://www.isahit.com).
+
+## Installation
+
+Install the client
+
+```bash { .copy }
+pip install isahitlab
+```
+
+## Basic usage
+
+* Create your credentials in your lab account
+* Add the access id and the secret key to your environment variables
+
+```bash { .copy }
+export ISAHIT_LAB_API_ACCESS_ID='<your_access_id>'
+export ISAHIT_LAB_API_SECRET_KEY='<your_secret_key>'
+```
+
+* Instanciate the client
+
+```python { .copy }
+from isahitlab.client import IsahitLab
+
+lab = IsahitLab()
+```
+
+
+!!! info
+    You can also pass the API key as an argument during `Kili` initialization:
+
+    ```python { .copy }
+    from isahitlab.client import IsahitLab
+
+    lab = IsahitLab(
+        access_id="<your_access_id>",
+        secret_key="<your_secret_key>",
+    )
+
+    ```
+
+!!! success "Try it!"
+    ```python { .copy }
+    lab.project_configuration(project_id=<your_project_id>)
+
+    ```

isahitlab-0.0.1/docs/project_configuration.md

@@ -0,0 +1,3 @@
+# Project configuration module
+
+::: isahitlab.actions.project_configuration

isahitlab-0.0.1/docs/stylesheets/extra.css

@@ -0,0 +1,20 @@
+[data-md-color-scheme="isahit"] {
+    --md-primary-fg-color:        #FF534A;
+    --md-primary-fg-color--light: #ECB7B7;
+    --md-primary-fg-color--dark:  #90030C;
+    --md-default-bg-color: #f8f5f1;
+    --md-code-bg-color: #e7e7e7;
+}
+
+.md-header__topic .md-ellipsis{
+    line-height: 2.9;
+}
+
+.md-header__topic{
+    margin-left: 50px;
+
+}
+
+.md-typeset{
+    font-size: 12pt;
+}

isahitlab-0.0.1/docs/task.md

@@ -0,0 +1,3 @@
+# Task module
+
+::: isahitlab.actions.task

isahitlab-0.0.1/mkdocs.yml

@@ -0,0 +1,42 @@
+site_name: Lab Python SDK
+site_url: 'http://localhost:8000/'
+nav:
+    - Getting started: index.md
+    # - Installation: installation.md
+    - Code Reference:
+        - Task: task.md
+        - Dataset: dataset.md
+        - Project Configuration: project_configuration.md
+
+theme:
+  name: "material"
+  logo: https://isahit-public.s3.eu-west-3.amazonaws.com/saas/isahit-logo-fond-fonce.png
+  favicon: assets/favicon.ico
+  features:
+    - content.code.copy
+  palette:
+    scheme: isahit
+
+extra_css:
+  - stylesheets/extra.css
+  
+plugins:
+  - search
+  - mkdocstrings
+  - mike:
+      version_selector: true
+
+extra:
+  version:
+    provider: mike
+  
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences

isahitlab-0.0.1/pyproject.toml

@@ -0,0 +1,87 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "isahitlab"
+dynamic = ["version"]
+description = 'Python client for isahit lab'
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Isahit", email = "dev@isahit.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "requests >= 2.0.0, < 3.0.0",
+  "tqdm >= 4.0.0, < 5.0.0",
+  "typeguard >= 4, < 5",
+  "jsonschema >= 4"
+]
+
+
+[tool.hatch.envs.docs]
+dependencies = [
+  "mkdocs",
+  "mkdocstrings[python]",
+  "mkdocs-material",
+  "mkdocstrings",
+  "mike"
+]
+[tool.hatch.envs.docs.scripts]
+build = "mkdocs build --clean --strict"
+serve = "mkdocs serve --dev-addr localhost:8000"
+
+[project.urls]
+Documentation = "https://sdk-docs.lab.isahit.com/latest/"
+
+
+[tool.hatch.version]
+path = "src/isahitlab/__about__.py"
+
+[tool.hatch.envs.types]
+dependencies = [
+  "python-dateutil >= 2.0.0"
+]
+extra-dependencies = [
+  "mypy>=1.0.0"
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/isahitlab tests}"
+
+[tool.coverage.run]
+source_pkgs = ["isahitlab", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/isahitlab/__about__.py",
+]
+
+[tool.coverage.paths]
+isahitlab = ["src/isahitlab", "*/lab/src/isahitlab"]
+tests = ["tests", "*/lab/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+  "/tests",
+  "/site",
+]

isahitlab-0.0.1/src/isahitlab/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2024-present Benjamin Piogé <benjamin@isahit.com>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.0.1"

isahitlab-0.0.1/src/isahitlab/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2024-present Benjamin Piogé <benjamin@isahit.com>
+#
+# SPDX-License-Identifier: MIT

isahitlab-0.0.1/src/isahitlab/actions/__init__.py

@@ -0,0 +1,3 @@
+"""Isahit Lab Python SDK."""
+
+__version__ = "0.0.1"

isahitlab-0.0.1/src/isahitlab/actions/base.py

@@ -0,0 +1,11 @@
+from abc import ABC
+from isahitlab.core.http.http_client import HttpClient
+
+
+class BaseAction(ABC):
+    """Base class for all actions.
+    It is used to share the HttpClient between all actions classes.
+    It is not meant to be used and instantiated directly.
+    """
+    
+    http_client: HttpClient # instantianted in the isahitlab client child class

isahitlab-0.0.1/src/isahitlab/actions/dataset.py

@@ -0,0 +1,78 @@
+import warnings
+from typing import List, Optional, Iterable, Dict, Union
+from isahitlab.actions.base import BaseAction
+from isahitlab.operations.dataset.append_to_dataset import AppendToDatasetOperation
+from isahitlab.operations.batch.get_batch import GetBatchOperation
+from isahitlab.domain.batch import BatchId
+from isahitlab.domain.project import ProjectId
+from isahitlab.domain.dataset import DatasetId, FilePayload
+
+from typeguard import typechecked
+
+class DatasetActions(BaseAction):
+    """Dataset actions"""
+
+    @typechecked
+    def append_to_dataset(
+        self,
+        project_id: str,
+        files: List[Union[Dict, str]],
+        batch_id: Optional[str] = None,
+        dataset_id: Optional[str] = None,
+        disable_progress_bar: Optional[bool] = False,
+    ) -> Iterable[Dict]:
+        """ Add files to a dataset
+        
+        Args:
+            project_id: ID of the project
+            dataset_id: ID of the dataset_id
+                You can also provide a batch_id to use the dataset linked to the batch
+            batch_id: ID of the batch
+            files : list of the file to create, str or Dict -> FilePayload(path : str, file : str)
+            disable_progress_bar: Disable the progress bar display
+        """
+
+        if not dataset_id and not batch_id:
+            raise ValueError(
+                'You must provide a dataset_id or a batch_id'
+            )
+        
+        # Get the dataset linked to the batch
+        if not dataset_id:
+            batch = GetBatchOperation(self.http_client).run(batch_id=batch_id, disable_progress_bar=disable_progress_bar)
+            if not batch:
+                raise ValueError("Batch not found")
+            if batch['projectId'] != project_id:
+                raise ValueError("batch_id is not a batch of the project")
+            if not batch['dataset']:
+                raise ValueError('The batch has no dataset')
+            dataset_id = batch['dataset']['id']    
+        
+        if not dataset_id:
+            raise ValueError("Unknown dataset")
+        
+        operation = AppendToDatasetOperation(self.http_client)
+
+        file_payloads = [*map(lambda t: FilePayload(
+            file=t['file'] if not isinstance(t, str) else t,
+            path=self._format_path(t['path']) if not isinstance(t, str) else None
+            ), files)]
+        
+        return operation.run(project_id=project_id,
+                                dataset_id=dataset_id,
+                                files=file_payloads, 
+                                disable_progress_bar=disable_progress_bar
+                                )
+    
+    def _format_path(self, path: str) -> str:
+        if not path:
+            return None
+        path = path.strip().strip('/')
+        
+        if len(path) == 0:
+            return None
+        
+        return path + '/'
+        
+
+    

isahitlab-0.0.1/src/isahitlab/actions/project_configuration.py

@@ -0,0 +1,34 @@
+from tqdm import tqdm
+from typing import List, Optional, Iterable, Dict, cast
+from isahitlab.actions.base import BaseAction
+from isahitlab.api.task.api import TaskApi
+from isahitlab.api.project_configuration.api import ProjectConfigurationApi
+from isahitlab.domain.task import TaskFilters, TaskStatus, TaskOptionalFields, TaskId, TaskCompatibilityMode
+from isahitlab.domain.batch import BatchId
+from isahitlab.operations.project_configuration.get_project_configuration import GetProjectConfigurationOperation
+from isahitlab.formatters import get_compatibility_formatter
+
+from typeguard import typechecked
+
+class ProjectConfigurationActions(BaseAction):
+    """Project configuration actions"""
+
+    @typechecked
+    def project_configuration(
+        self,
+        project_id: str,
+        disable_progress_bar: Optional[bool] = False
+    ) -> Dict:
+        """ Get the configuration of a project
+        
+        Args:
+            project_id: ID of the project
+            disable_progress_bar: Disable the progress bar display
+
+        """
+
+        operation = GetProjectConfigurationOperation(self.http_client)
+
+        return operation.run(project_id=project_id, disable_progress_bar=disable_progress_bar)
+
+    

isahitlab-0.0.1/src/isahitlab/actions/task.py

@@ -0,0 +1,140 @@
+import warnings
+from typing import List, Optional, Iterable, Dict, cast
+from isahitlab.actions.base import BaseAction
+from isahitlab.operations.task.get_tasks import GetTasksOperation
+from isahitlab.operations.task.create_tasks import CreateTask
+from isahitlab.operations.project.get_projects import GetProjectsOperation
+from isahitlab.domain.task import TaskFilters, TaskStatus, TaskOptionalFields, TaskId, TaskCompatibilityMode, TaskPayload
+from isahitlab.domain.batch import BatchId
+from isahitlab.domain.project import ProjectId, ProjectFilters, ProjectType
+
+from typeguard import typechecked
+
+class TaskActions(BaseAction):
+    """Tasks actions"""
+
+    @typechecked
+    def tasks(
+        self,
+        project_id: ProjectId,
+        batch_ids: Optional[List[str]] = None,
+        status_in: Optional[List[str]] = None,
+        task_id_in: Optional[List[str]] = None,
+        name_in: Optional[List[str]] = None,
+        name_like: Optional[str] = None,
+        created_at_gt: Optional[str] = None,
+        created_at_gte: Optional[str] = None,
+        created_at_lt: Optional[str] = None,
+        created_at_lte: Optional[str] = None,
+        updated_at_gt: Optional[str] = None,
+        updated_at_gte: Optional[str] = None,
+        updated_at_lt: Optional[str] = None,
+        updated_at_lte: Optional[str] = None,
+        optional_fields: Optional[List[TaskOptionalFields]] = ["data"],
+        disable_progress_bar: Optional[bool] = False,
+        compatibility_mode: Optional[TaskCompatibilityMode] = None
+    ) -> Iterable[Dict]:
+        """ Get an task list
+        
+        Args:
+            project_id: ID of the project
+            batch_ids: A list of batch ids to filter
+            status_in: Only in those statuses.
+                Possible choices: `pending`, `complete`, `configuring`.
+            task_id_in: Only task whose ID is in this list,
+            name_in: Only task whose name is in this list,
+            name_like: Only task whose name mathes this regex,
+            created_at_gt: Only tasks created after this date (Ex.: "2022-09-19 08:30:00")
+            created_at_gte: Only tasks created at or after this date (Ex.: "2022-09-19 08:30:00")
+            created_at_lt: Only tasks created before this date (Ex.: "2022-09-19 08:30:00")
+            created_at_lte: Only tasks created at or before this date (Ex.: "2022-09-19 08:30:00")
+            updated_at_gt: Only tasks updated after this date (Ex.: "2022-09-19 08:30:00")
+            updated_at_gte: Only tasks updated at or after this date (Ex.: "2022-09-19 08:30:00")
+            updated_at_lt: Only tasks updated before this date (Ex.: "2022-09-19 08:30:00")
+            updated_at_lte: Only tasks updated at or before this date (Ex.: "2022-09-19 08:30:00")
+            optional_fields: retreive those additional information
+                Possible choices: `data`, `jobs`, `metrics`, `data.mask`(for segmentation project).
+            disable_progress_bar: Disable the progress bar display
+            compatibility_mode: Format the output for specific use cases
+                Possible choices: `kili` -> format the ouput to look like kili.assets() results 
+
+        """
+
+        filters = TaskFilters(
+            project_id=project_id, 
+            batch_id_in = cast(List[BatchId], batch_ids) if batch_ids else None,
+            status_in = cast(List[TaskStatus], status_in) if status_in else None,
+            task_id_in = cast(List[TaskId], task_id_in) if task_id_in else None,
+            name_in = cast(List[str], name_in) if name_in else None,
+            name_like = name_like if name_like else None,
+            created_at_gt = cast(List[str], created_at_gt) if created_at_gt else None,
+            created_at_gte = cast(List[str], created_at_gte) if created_at_gte else None,
+            created_at_lt = cast(List[str], created_at_lt) if created_at_lt else None,
+            created_at_lte = cast(List[str], created_at_lte) if created_at_lte else None,
+            updated_at_gt = cast(List[str], updated_at_gt) if updated_at_gt else None,
+            updated_at_gte = cast(List[str], updated_at_gte) if updated_at_gte else None,
+            updated_at_lt = cast(List[str], updated_at_lt) if updated_at_lt else None,
+            updated_at_lte = cast(List[str], updated_at_lte) if updated_at_lte else None,
+            optional_fields = cast(List[TaskOptionalFields], optional_fields) if optional_fields else None
+        )
+        
+        operation = GetTasksOperation(self.http_client)
+
+        return operation.run(project_id=project_id, filters=filters, disable_progress_bar=disable_progress_bar, compatibility_mode=compatibility_mode )
+    
+
+    @typechecked
+    def create_tasks(
+        self,
+        project_id: str,
+        batch_id: str,
+        tasks: List[Dict],
+        disable_progress_bar: Optional[bool] = False,
+        disable_data_check: Optional[bool] = False,
+        disable_unicity_check: Optional[bool] = False,
+        raise_if_existing: Optional[bool] = True,
+        compatibility_mode: Optional[TaskCompatibilityMode] = None
+    ) -> Iterable[Dict]:
+        """ Create tasks in a batch
+        
+        Args:
+            project_id: ID of the project
+            batch_id: ID of the batch project
+            tasks : list of the tasks to create. See TaskPayload(name : str, resource : str, data : Dict[str, Any])
+            disable_progress_bar: Disable the progress bar display
+            disable_data_check: Set this option to False to ignore the data format validation
+            disable_unicity_check: Set this option to True to ignore duplicate check and insert it anyway
+            raise_if_existing: Set this option to False to skip task duplicates and only show a warning
+            compatibility_mode: Format the output for specific use cases
+                Possible choices: `kili` -> format the ouput to look like kili.assets() results 
+
+        """
+
+        projects = GetProjectsOperation(self.http_client).run(filters=ProjectFilters(id_in=[project_id]), disable_progress_bar=disable_progress_bar)
+        project = projects[0] if len(projects) > 0 else None
+
+        if not project:
+            warnings.warn('Project not found')
+            return
+
+        project_type : ProjectType = project['type']
+
+        operation = CreateTask(self.http_client)
+        task_payloads = [*map(lambda t: TaskPayload(
+            name=t['name'],
+            resources=t['resources'] if project_type != "form" else None,
+            data=t['data'] if 'data' in t else None
+            ), tasks)]
+        
+        tasks = operation.run(project_id=project_id,
+                        batch_id=batch_id,
+                        tasks=task_payloads, 
+                        disable_progress_bar=disable_progress_bar, 
+                        disable_unicity_check=disable_unicity_check,
+                        raise_if_existing=raise_if_existing,
+                        disable_data_check=disable_data_check,
+                        compatibility_mode=compatibility_mode
+                        )       
+        
+        return tasks
+    

isahitlab-0.0.1/src/isahitlab/api/base.py

@@ -0,0 +1,12 @@
+from abc import ABC
+from isahitlab.core.http.http_client import HttpClient
+
+
+class BaseApi(ABC):
+    """Base class for all API"""
+    
+    http_client: HttpClient # instantianted in the isahitlab client child class
+
+    def __init__(self, http_client: HttpClient) -> None:
+        """Initialize Base Api Class."""
+        self._http_client = http_client