superb-ai-onprem 0.1.0__tar.gz

superb_ai_onprem-0.1.0/.env.local

@@ -0,0 +1,10 @@
+# System SDK Configuration
+# Set to "true" to use system SDK mode (typically used in Airflow DAGs)
+SUPERB_SYSTEM_SDK=false
+
+# Host Configuration
+# Either SUNRISE_SERVER_URL or SUPERB_SYSTEM_SDK_HOST must be set when SUPERB_SYSTEM_SDK is true
+SUPERB_SYSTEM_SDK_HOST=https://your-superb-ai-host
+
+# User Configuration (Required when SUPERB_SYSTEM_SDK is true)
+SUPERB_SYSTEM_SDK_USER_EMAIL=user@example.com 

superb_ai_onprem-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on version tags
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Publish to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: twine upload dist/* 

superb_ai_onprem-0.1.0/.gitignore

@@ -0,0 +1,49 @@
+# IDE
+.vscode
+.idea
+
+# Environment
+.env
+*.env
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Logs
+*.log

superb_ai_onprem-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Superb AI
+
+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. 

superb_ai_onprem-0.1.0/PKG-INFO

@@ -0,0 +1,246 @@
+Metadata-Version: 2.4
+Name: superb-ai-onprem
+Version: 0.1.0
+Summary: Python SDK for Superb AI On-premise
+Home-page: https://github.com/Superb-AI-Suite/superb-ai-onprem-python
+Author: Superb AI
+Author-email: support@superb-ai.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.22.0
+Requires-Dist: urllib3>=1.21.1
+Requires-Dist: pydantic>=1.8.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Superb AI On-premise SDK
+
+Python SDK for Superb AI's On-premise solution. This SDK provides a simple interface to interact with your on-premise Superb AI installation.
+
+## Installation
+
+```bash
+pip install superb-ai-onprem
+```
+
+## Quick Start
+
+```python
+from spb_onprem import DatasetService, DataService
+from spb_onprem.data.enums import DataType
+
+# Initialize services
+dataset_service = DatasetService()
+data_service = DataService()
+
+# Create a dataset
+dataset = dataset_service.create_dataset(
+    name="my-dataset",
+    description="My first dataset"
+)
+
+# Upload an image with annotation
+with open("image.jpg", "rb") as f:
+    image_data = BytesIO(f.read())
+
+data = data_service.create_image_data(
+    dataset_id=dataset.id,
+    key="image_1",
+    image_content=image_data,
+    annotation={
+        "labels": ["car", "person"],
+        "boxes": [
+            {"x": 100, "y": 100, "width": 200, "height": 200}
+        ]
+    }
+)
+```
+
+## Features
+
+- Dataset Management
+  - Create, update, and delete datasets
+  - List and filter datasets
+- Data Management
+  - Upload images with annotations
+  - Update annotations
+  - Add/remove data from slices
+  - Manage metadata
+- Slice Management
+  - Create and manage data slices
+  - Filter and organize your data
+
+## Usage Examples
+
+### Dataset Operations
+
+```python
+from spb_onprem import DatasetService
+from spb_onprem import DatasetsFilter, DatasetsFilterOptions
+
+# Initialize service
+dataset_service = DatasetService()
+
+# Create a dataset
+dataset = dataset_service.create_dataset(
+    name="my-dataset",
+    description="Dataset description"
+)
+
+# List datasets with filtering
+filter = DatasetsFilter(
+    must_filter=DatasetsFilterOptions(
+        name_contains="test"
+    )
+)
+datasets = dataset_service.get_datasets(filter=filter)
+```
+
+### Data Operations
+
+```python
+from spb_onprem import DataService
+from spb_onprem import DataListFilter, DataFilterOptions
+
+# Initialize service
+data_service = DataService()
+
+# List data with filtering
+filter = DataListFilter(
+    must_filter=DataFilterOptions(
+        key_contains="image_",
+        annotation_exists=True
+    )
+)
+data_list = data_service.get_data_list(
+    dataset_id="your-dataset-id",
+    filter=filter
+)
+
+# Update annotation
+data_service.update_annotation(
+    dataset_id="your-dataset-id",
+    data_id="your-data-id",
+    annotation={
+        "labels": ["updated_label"],
+        "boxes": [...]
+    }
+)
+```
+
+### Slice Operations
+
+```python
+from spb_onprem import SliceService
+
+# Initialize service
+slice_service = SliceService()
+
+# Create a slice
+slice = slice_service.create_slice(
+    dataset_id="your-dataset-id",
+    name="validation-set",
+    description="Validation data slice"
+)
+
+# Add data to slice
+data_service.add_data_to_slice(
+    dataset_id="your-dataset-id",
+    data_id="your-data-id",
+    slice_id=slice.id
+)
+```
+
+## Error Handling
+
+The SDK provides specific error types for different scenarios:
+
+```python
+from spb_onprem.exceptions import (
+    BadParameterError,
+    NotFoundError,
+    UnknownError
+)
+
+try:
+    dataset = dataset_service.get_dataset(dataset_id="non-existent-id")
+except NotFoundError:
+    print("Dataset not found")
+except BadParameterError as e:
+    print(f"Invalid parameter: {e}")
+except UnknownError as e:
+    print(f"An unexpected error occurred: {e}")
+```
+
+## Configuration
+
+The SDK supports two authentication methods:
+
+### 1. Config File Authentication (Default)
+
+Create a config file at `~/.spb/onprem-config`:
+
+```ini
+[default]
+host=https://your-onprem-host
+access_key=your-access-key
+access_key_secret=your-access-key-secret
+```
+
+This is the default authentication method when `SUPERB_SYSTEM_SDK=false` or not set.
+
+### 2. Environment Variables (for Airflow DAGs)
+
+When running in an Airflow DAG or other system environments, you can use environment variables for authentication. This method is activated by setting `SUPERB_SYSTEM_SDK=true`.
+
+Required environment variables:
+```bash
+# Enable system SDK mode
+export SUPERB_SYSTEM_SDK=true
+
+# Set the host URL (either one is required)
+export SUPERB_SYSTEM_SDK_HOST=https://your-superb-ai-host
+# or
+export SUNRISE_SERVER_URL=https://your-superb-ai-host
+
+# Set the user email
+export SUPERB_SYSTEM_SDK_USER_EMAIL=user@example.com
+```
+
+You can set these environment variables:
+- Directly in your shell
+- In your Airflow DAG configuration
+- Through your deployment environment
+- Using a `.env` file with your preferred method of loading environment variables
+
+Note: 
+- When `SUPERB_SYSTEM_SDK=true`, the SDK will ignore the config file (`~/.spb/onprem-config`) and use environment variables exclusively.
+- When `SUPERB_SYSTEM_SDK=false` or not set, the SDK will look for authentication credentials in `~/.spb/onprem-config`.
+
+## Requirements
+
+- Python >= 3.7
+- requests >= 2.22.0
+- urllib3 >= 1.21.1
+- pydantic >= 1.8.0
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+For support or feature requests, please contact the Superb AI team or create an issue in this repository.
+

superb_ai_onprem-0.1.0/README.md

@@ -0,0 +1,219 @@
+# Superb AI On-premise SDK
+
+Python SDK for Superb AI's On-premise solution. This SDK provides a simple interface to interact with your on-premise Superb AI installation.
+
+## Installation
+
+```bash
+pip install superb-ai-onprem
+```
+
+## Quick Start
+
+```python
+from spb_onprem import DatasetService, DataService
+from spb_onprem.data.enums import DataType
+
+# Initialize services
+dataset_service = DatasetService()
+data_service = DataService()
+
+# Create a dataset
+dataset = dataset_service.create_dataset(
+    name="my-dataset",
+    description="My first dataset"
+)
+
+# Upload an image with annotation
+with open("image.jpg", "rb") as f:
+    image_data = BytesIO(f.read())
+
+data = data_service.create_image_data(
+    dataset_id=dataset.id,
+    key="image_1",
+    image_content=image_data,
+    annotation={
+        "labels": ["car", "person"],
+        "boxes": [
+            {"x": 100, "y": 100, "width": 200, "height": 200}
+        ]
+    }
+)
+```
+
+## Features
+
+- Dataset Management
+  - Create, update, and delete datasets
+  - List and filter datasets
+- Data Management
+  - Upload images with annotations
+  - Update annotations
+  - Add/remove data from slices
+  - Manage metadata
+- Slice Management
+  - Create and manage data slices
+  - Filter and organize your data
+
+## Usage Examples
+
+### Dataset Operations
+
+```python
+from spb_onprem import DatasetService
+from spb_onprem import DatasetsFilter, DatasetsFilterOptions
+
+# Initialize service
+dataset_service = DatasetService()
+
+# Create a dataset
+dataset = dataset_service.create_dataset(
+    name="my-dataset",
+    description="Dataset description"
+)
+
+# List datasets with filtering
+filter = DatasetsFilter(
+    must_filter=DatasetsFilterOptions(
+        name_contains="test"
+    )
+)
+datasets = dataset_service.get_datasets(filter=filter)
+```
+
+### Data Operations
+
+```python
+from spb_onprem import DataService
+from spb_onprem import DataListFilter, DataFilterOptions
+
+# Initialize service
+data_service = DataService()
+
+# List data with filtering
+filter = DataListFilter(
+    must_filter=DataFilterOptions(
+        key_contains="image_",
+        annotation_exists=True
+    )
+)
+data_list = data_service.get_data_list(
+    dataset_id="your-dataset-id",
+    filter=filter
+)
+
+# Update annotation
+data_service.update_annotation(
+    dataset_id="your-dataset-id",
+    data_id="your-data-id",
+    annotation={
+        "labels": ["updated_label"],
+        "boxes": [...]
+    }
+)
+```
+
+### Slice Operations
+
+```python
+from spb_onprem import SliceService
+
+# Initialize service
+slice_service = SliceService()
+
+# Create a slice
+slice = slice_service.create_slice(
+    dataset_id="your-dataset-id",
+    name="validation-set",
+    description="Validation data slice"
+)
+
+# Add data to slice
+data_service.add_data_to_slice(
+    dataset_id="your-dataset-id",
+    data_id="your-data-id",
+    slice_id=slice.id
+)
+```
+
+## Error Handling
+
+The SDK provides specific error types for different scenarios:
+
+```python
+from spb_onprem.exceptions import (
+    BadParameterError,
+    NotFoundError,
+    UnknownError
+)
+
+try:
+    dataset = dataset_service.get_dataset(dataset_id="non-existent-id")
+except NotFoundError:
+    print("Dataset not found")
+except BadParameterError as e:
+    print(f"Invalid parameter: {e}")
+except UnknownError as e:
+    print(f"An unexpected error occurred: {e}")
+```
+
+## Configuration
+
+The SDK supports two authentication methods:
+
+### 1. Config File Authentication (Default)
+
+Create a config file at `~/.spb/onprem-config`:
+
+```ini
+[default]
+host=https://your-onprem-host
+access_key=your-access-key
+access_key_secret=your-access-key-secret
+```
+
+This is the default authentication method when `SUPERB_SYSTEM_SDK=false` or not set.
+
+### 2. Environment Variables (for Airflow DAGs)
+
+When running in an Airflow DAG or other system environments, you can use environment variables for authentication. This method is activated by setting `SUPERB_SYSTEM_SDK=true`.
+
+Required environment variables:
+```bash
+# Enable system SDK mode
+export SUPERB_SYSTEM_SDK=true
+
+# Set the host URL (either one is required)
+export SUPERB_SYSTEM_SDK_HOST=https://your-superb-ai-host
+# or
+export SUNRISE_SERVER_URL=https://your-superb-ai-host
+
+# Set the user email
+export SUPERB_SYSTEM_SDK_USER_EMAIL=user@example.com
+```
+
+You can set these environment variables:
+- Directly in your shell
+- In your Airflow DAG configuration
+- Through your deployment environment
+- Using a `.env` file with your preferred method of loading environment variables
+
+Note: 
+- When `SUPERB_SYSTEM_SDK=true`, the SDK will ignore the config file (`~/.spb/onprem-config`) and use environment variables exclusively.
+- When `SUPERB_SYSTEM_SDK=false` or not set, the SDK will look for authentication credentials in `~/.spb/onprem-config`.
+
+## Requirements
+
+- Python >= 3.7
+- requests >= 2.22.0
+- urllib3 >= 1.21.1
+- pydantic >= 1.8.0
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+For support or feature requests, please contact the Superb AI team or create an issue in this repository.
+

superb_ai_onprem-0.1.0/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "spb_onprem/_version.py"

superb_ai_onprem-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

superb_ai_onprem-0.1.0/setup.py

@@ -0,0 +1,28 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="superb-ai-onprem",
+    use_scm_version=True,
+    setup_requires=['setuptools_scm'],
+    author="Superb AI",
+    author_email="support@superb-ai.com",
+    description="Python SDK for Superb AI On-premise",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/Superb-AI-Suite/superb-ai-onprem-python",
+    packages=find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.8",
+    install_requires=[
+        "requests>=2.22.0",  # Python 3.7 지원 시작 버전
+        "urllib3>=1.21.1",  # Retry 기능 안정화 버전
+        "pydantic>=1.8.0",  # Python 3.7 지원 안정 버전
+    ],
+) 

superb_ai_onprem-0.1.0/spb_onprem/__init__.py

@@ -0,0 +1,74 @@
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "0.0.0.dev0"
+
+# Services
+from .datasets.service import DatasetService
+from .data.service import DataService
+from .slices.service import SliceService
+
+# Core Entities
+from .data.entities import (
+    Data,
+    Scene,
+    Annotation,
+    AnnotationVersion,
+    Prediction,
+    DataMeta,
+)
+from .datasets.entities import Dataset
+from .slices.entities import Slice
+
+# Enums
+from .data.enums import (
+    DataType,
+    SceneType,
+    DataMetaTypes,
+    DataMetaValue,
+)
+
+# Filters
+from .data.params.data_list import (
+    AnnotationFilter,
+    DataListFilter,
+    DataFilterOptions,
+)
+from .datasets.params.datasets import (
+    DatasetsFilter,
+    DatasetsFilterOptions,
+)
+from .slices.params.slices import (
+    SlicesFilterOptions,
+)
+
+__all__ = (
+    # Services
+    "DatasetService",
+    "DataService",
+    "SliceService",
+    
+    # Core Entities
+    "Data",
+    "Scene",
+    "Annotation",
+    "AnnotationVersion",
+    "Prediction",
+    "DataMeta",
+    "Dataset",
+    "Slice",
+    
+    # Enums
+    "DataType",
+    "SceneType",
+    "DataMetaTypes",
+    "DataMetaValue",
+    
+    # Filters
+    "AnnotationFilter",
+    "DataListFilter",
+    "DataFilterOptions",
+    "DatasetsFilter",
+    "DatasetsFilterOptions",
+    "SlicesFilterOptions",
+)