synapse-sdk 1.0.0a59__tar.gz → 1.0.0a61__tar.gz

synapse_sdk-1.0.0a61/.github/workflows/update-changelog.yml

@@ -0,0 +1,109 @@
+name: Update Changelog on Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-changelog:
+    runs-on: runner-set
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+      
+      - name: Update changelog
+        run: |
+          # Get release information
+          RELEASE_TAG="${{ github.event.release.tag_name }}"
+          RELEASE_NAME="${{ github.event.release.name }}"
+          RELEASE_BODY=$(cat << 'EOF'
+          ${{ github.event.release.body }}
+          EOF
+          )
+          RELEASE_DATE=$(date -u +"%Y-%m-%d")
+          
+          # Create temporary file with new release entry
+          cat > release_entry.md << EOF
+          ## [$RELEASE_TAG] - $RELEASE_DATE
+          
+          ### Release: $RELEASE_NAME
+          
+          $RELEASE_BODY
+          
+          ---
+          
+          EOF
+          
+          # Check if changelog exists
+          if [ -f "docs/changelog.md" ]; then
+            # Create a backup
+            cp docs/changelog.md docs/changelog.md.bak
+            
+            # Check if file has a header (usually starts with # Changelog)
+            if grep -q "^# " docs/changelog.md; then
+              # Extract header (everything before the first ## or empty line after #)
+              awk '/^# /{print; getline; while(!/^##/ && NF>0){print; getline}} /^##/{exit}' docs/changelog.md > header.md
+              
+              # Extract existing content (everything from first ## onwards)
+              awk '/^##/{f=1} f' docs/changelog.md > content.md
+              
+              # Combine: header + new release + existing content
+              cat header.md > docs/changelog.md
+              echo "" >> docs/changelog.md
+              cat release_entry.md >> docs/changelog.md
+              cat content.md >> docs/changelog.md
+            else
+              # No header, just prepend the new release
+              cat release_entry.md > temp_changelog.md
+              cat docs/changelog.md >> temp_changelog.md
+              mv temp_changelog.md docs/changelog.md
+            fi
+            
+            # Clean up temporary files
+            rm -f header.md content.md release_entry.md docs/changelog.md.bak
+          else
+            # Create new changelog with header
+            cat > docs/changelog.md << EOF
+          # Changelog
+          
+          All notable changes to this project will be documented in this file.
+          
+          The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+          and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+          
+          EOF
+            cat release_entry.md >> docs/changelog.md
+            rm release_entry.md
+          fi
+      
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "docs: Update changelog for ${{ github.event.release.tag_name }}"
+          title: "docs: Update changelog for ${{ github.event.release.tag_name }}"
+          body: |
+            This PR automatically updates the changelog with the latest release information.
+            
+            **Release**: ${{ github.event.release.tag_name }}
+            **Name**: ${{ github.event.release.name }}
+            
+            Please review the changes to ensure the formatting is correct.
+          branch: changelog-update-${{ github.event.release.tag_name }}
+          delete-branch: true
+          labels: |
+            documentation
+            automated

{synapse_sdk-1.0.0a59 → synapse_sdk-1.0.0a61}/.gitignore

@@ -15,7 +15,6 @@
 
 # general things to ignore
 build/
-dist/
 *.egg-info/
 *.egg
 *.py[cod]
@@ -31,4 +30,12 @@ __pycache__/
 /main.py
 
 *.mo
-messages.pot
+messages.pot
+
+# Frontend development (keep only built assets)
+node_modules/
+npm-debug.log*
+
+config.yaml*
+
+synapse-sample-plugin/

{synapse_sdk-1.0.0a59 → synapse_sdk-1.0.0a61}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: synapse-sdk
-Version: 1.0.0a59
+Version: 1.0.0a61
 Summary: synapse sdk
 Author-email: datamaker <developer@datamaker.io>
 License: MIT
@@ -19,32 +19,19 @@ Requires-Dist: pydantic
 Requires-Dist: pyjwt
 Requires-Dist: universal-pathlib
 Requires-Dist: fsspec[gcs,s3,sftp]
+Requires-Dist: inquirer
 Provides-Extra: all
 Requires-Dist: ray[all]; extra == "all"
 Requires-Dist: python-nmap; extra == "all"
 Requires-Dist: hyperopt; extra == "all"
 Requires-Dist: bayesian-optimization==1.4.3; extra == "all"
+Provides-Extra: dashboard
+Requires-Dist: fastapi>=0.115.13; extra == "dashboard"
+Requires-Dist: uvicorn[standard]>=0.34.3; extra == "dashboard"
+Requires-Dist: websockets>=15.0.1; extra == "dashboard"
+Requires-Dist: aiofiles>=24.1.0; extra == "dashboard"
 Dynamic: license-file
 
-This is the SDK to develop synapse plugins
+# Synapse SDK
 
-
-## Internationalization
-
-### Find Messages
-```bash
- $ find . -name "*.py" | xargs xgettext -o messages.pot
-```
-
-### Make Messages
-```bash
- $ msginit -l ko -i messages.pot -o locale/ko/LC_MESSAGES/messages.po
- $ msginit -l en -i messages.pot -o locale/en/LC_MESSAGES/messages.po
-```
-
-### Compile Messages
-
-```bash
- $ msgfmt locale/ko/LC_MESSAGES/messages.po -o locale/ko/LC_MESSAGES/messages.mo
- $ msgfmt locale/en/LC_MESSAGES/messages.po -o locale/en/LC_MESSAGES/messages.mo
-```
+*Docs [https://docs.synapse.sh](https://docs.synapse.sh)*

synapse_sdk-1.0.0a61/README.md

@@ -0,0 +1,3 @@
+# Synapse SDK
+
+*Docs [https://docs.synapse.sh](https://docs.synapse.sh)*

synapse_sdk-1.0.0a61/docs/api/clients/agent.md

@@ -0,0 +1,43 @@
+---
+id: agent
+title: AgentClient
+sidebar_position: 2
+---
+
+# AgentClient
+
+Client for agent-specific operations and distributed execution.
+
+## Overview
+
+The `AgentClient` provides access to agent operations, including plugin execution, job management, and Ray cluster integration.
+
+## Constructor
+
+```python
+AgentClient(
+    base_url: str,
+    agent_token: str = None,
+    timeout: dict = None
+)
+```
+
+## Usage
+
+```python
+from synapse_sdk.clients.agent import AgentClient
+
+client = AgentClient(
+    base_url="https://api.synapse.sh",
+    agent_token="your-agent-token"
+)
+```
+
+## Methods
+
+Coming soon - detailed API documentation for AgentClient methods.
+
+## See Also
+
+- [BackendClient](./backend.md) - For backend operations
+- [BaseClient](./base.md) - Base client implementation

synapse_sdk-1.0.0a61/docs/api/clients/backend.md

@@ -0,0 +1,53 @@
+---
+id: backend
+title: BackendClient
+sidebar_position: 1
+---
+
+# BackendClient
+
+Main client for interacting with the Synapse backend API.
+
+## Overview
+
+The `BackendClient` provides comprehensive access to all backend operations including data management, plugin execution, annotations, and machine learning workflows. It aggregates functionality from multiple specialized mixins.
+
+## Constructor
+
+```python
+BackendClient(
+    base_url: str,
+    api_token: str = None,
+    agent_token: str = None,
+    timeout: dict = None
+)
+```
+
+### Parameters
+
+- **base_url** (`str`): The base URL of the Synapse backend API
+- **api_token** (`str`, optional): API authentication token. Can also be set via `SYNAPSE_API_TOKEN` environment variable
+- **agent_token** (`str`, optional): Agent authentication token. Can also be set via `SYNAPSE_AGENT_TOKEN` environment variable
+- **timeout** (`dict`, optional): Custom timeout settings. Defaults to `{'connect': 5, 'read': 30}`
+
+### Example
+
+```python
+from synapse_sdk.clients.backend import BackendClient
+
+# Create client with explicit token
+client = BackendClient(
+    base_url="https://api.synapse.sh",
+    api_token="your-api-token"
+)
+
+# Or use environment variables
+import os
+os.environ['SYNAPSE_API_TOKEN'] = "your-api-token"
+client = BackendClient(base_url="https://api.synapse.sh")
+```
+
+## See Also
+
+- [AgentClient](./agent.md) - For agent-specific operations
+- [BaseClient](./base.md) - Base client implementation

synapse_sdk-1.0.0a61/docs/api/clients/base.md

@@ -0,0 +1,35 @@
+---
+id: base
+title: BaseClient
+sidebar_position: 3
+---
+
+# BaseClient
+
+Base class for all Synapse SDK clients.
+
+## Overview
+
+The `BaseClient` provides common functionality for HTTP operations, error handling, and request management used by all other clients.
+
+## Features
+
+- HTTP request handling with retry logic
+- Automatic timeout management
+- File upload/download capabilities
+- Pydantic model validation
+- Connection pooling
+
+## Usage
+
+```python
+from synapse_sdk.clients.base import BaseClient
+
+# BaseClient is typically not used directly
+# Use BackendClient or AgentClient instead
+```
+
+## See Also
+
+- [BackendClient](./backend.md) - Main client implementation
+- [AgentClient](./agent.md) - Agent-specific operations

synapse_sdk-1.0.0a61/docs/api/index.md

@@ -0,0 +1,50 @@
+---
+id: index
+title: API Reference
+sidebar_position: 1
+---
+
+# API Reference
+
+Complete reference documentation for Synapse SDK classes and functions.
+
+## Overview
+
+The Synapse SDK API is organized into the following main modules:
+
+### [Clients](./clients/backend.md)
+Client classes for interacting with backend services and agents.
+
+- **[BackendClient](./clients/backend.md)** - Main client for backend operations
+- **[AgentClient](./clients/agent.md)** - Client for agent-specific operations
+- **[BaseClient](./clients/base.md)** - Base class for all clients
+
+Core plugin system components.
+
+### [Utilities](./utils/file.md)
+Helper functions and utilities.
+
+- **[File Utils](./utils/file.md)** - File operations and handling
+- **[Storage](./utils/storage.md)** - Storage providers (S3, GCS, SFTP)
+- **[Types](./utils/types.md)** - Custom types and fields
+
+## Quick Reference
+
+### Creating a Client
+
+```python
+from synapse_sdk.clients.backend import BackendClient
+
+client = BackendClient(
+    base_url="https://api.synapse.sh",
+    api_token="your-api-token"
+)
+```
+
+### Running a Plugin
+
+### Creating a Plugin Action
+
+## Type Annotations
+
+## File Handling

synapse_sdk-1.0.0a61/docs/api/plugins/categories.md

@@ -0,0 +1,43 @@
+---
+id: categories
+title: Plugin Categories
+sidebar_position: 2
+---
+
+# Plugin Categories
+
+Available plugin categories in the Synapse SDK.
+
+## Available Categories
+
+### NEURAL_NET
+Machine learning model operations including training, inference, and deployment.
+
+### EXPORT
+Data export and transformation operations.
+
+### UPLOAD
+File and data upload functionality.
+
+### SMART_TOOL
+Intelligent automation tools and utilities.
+
+### POST_ANNOTATION
+Post-processing workflows after data annotation.
+
+### PRE_ANNOTATION
+Pre-processing workflows before data annotation.
+
+### DATA_VALIDATION
+Data quality checks and validation operations.
+
+## Usage
+
+```python
+from synapse_sdk.plugins.categories.smart_tool import register_action, Action
+
+@register_action("my_action")
+class MyAction(Action):
+    category = "SMART_TOOL"
+    # Implementation...
+```

synapse_sdk-1.0.0a61/docs/api/plugins/models.md

@@ -0,0 +1,59 @@
+---
+id: models
+title: Plugin Models
+sidebar_position: 1
+---
+
+# Plugin Models
+
+Core data models and structures for the plugin system.
+
+## PluginRelease
+
+Represents a specific version of a plugin.
+
+```python
+from synapse_sdk.plugins.models import PluginRelease
+
+release = PluginRelease(plugin_path="./my-plugin")
+```
+
+### Properties
+
+- `plugin`: Plugin code identifier
+- `version`: Plugin version
+- `code`: Combined plugin and version string
+- `category`: Plugin category
+- `name`: Human-readable plugin name
+- `actions`: Available plugin actions
+
+## PluginAction
+
+Represents a plugin action execution request.
+
+```python
+from synapse_sdk.plugins.models import PluginAction
+
+action = PluginAction(
+    plugin="my-plugin",
+    version="1.0.0",
+    action="process",
+    params={"input": "data"}
+)
+```
+
+## Run
+
+Execution context for plugin actions.
+
+```python
+def start(self):
+    # Log messages
+    self.run.log("Processing started")
+    
+    # Update progress
+    self.run.set_progress(0.5)
+    
+    # Set metrics
+    self.run.set_metrics({"processed": 100})
+```

synapse_sdk-1.0.0a61/docs/api/plugins/utils.md

@@ -0,0 +1,43 @@
+---
+id: utils
+title: Plugin Utilities
+sidebar_position: 3
+---
+
+# Plugin Utilities
+
+Utility functions for plugin development and management.
+
+## Configuration
+
+### read_plugin_config()
+
+Read plugin configuration from config.yaml file.
+
+```python
+from synapse_sdk.plugins.utils import read_plugin_config
+
+config = read_plugin_config(plugin_path="./my-plugin")
+```
+
+## Registration
+
+### register_action()
+
+Decorator for registering plugin actions.
+
+```python
+from synapse_sdk.plugins.categories.base import register_action, Action
+
+@register_action("my_action")
+class MyAction(Action):
+    pass
+```
+
+## Validation
+
+Utilities for validating plugin structure and configuration.
+
+## File Operations
+
+Helper functions for plugin file management and archiving.

synapse_sdk-1.0.0a61/docs/api/utils/file.md

@@ -0,0 +1,37 @@
+---
+id: file
+title: File Utilities
+sidebar_position: 1
+---
+
+# File Utilities
+
+File operations and handling utilities.
+
+## File Operations
+
+### Archive Functions
+
+Functions for creating and extracting plugin archives.
+
+### Download Functions
+
+Utilities for downloading files from URLs.
+
+```python
+from synapse_sdk.utils.file import download_file
+
+local_path = download_file(url, destination)
+```
+
+### Upload Functions
+
+File upload utilities with chunked upload support.
+
+## Path Utilities
+
+Functions for path manipulation and validation.
+
+## Temporary Files
+
+Utilities for managing temporary files and cleanup.

synapse_sdk-1.0.0a61/docs/api/utils/storage.md

@@ -0,0 +1,57 @@
+---
+id: storage
+title: Storage Providers
+sidebar_position: 2
+---
+
+# Storage Providers
+
+Storage abstraction layer supporting multiple cloud providers.
+
+## Supported Providers
+
+### Amazon S3
+Amazon Simple Storage Service integration.
+
+```python
+from synapse_sdk.utils.storage.providers.s3 import S3Provider
+
+provider = S3Provider(
+    bucket="my-bucket",
+    region="us-west-2"
+)
+```
+
+### Google Cloud Storage
+Google Cloud Storage integration.
+
+```python
+from synapse_sdk.utils.storage.providers.gcp import GCPProvider
+
+provider = GCPProvider(
+    bucket="my-bucket",
+    project="my-project"
+)
+```
+
+### SFTP
+Secure File Transfer Protocol support.
+
+```python
+from synapse_sdk.utils.storage.providers.sftp import SFTPProvider
+
+provider = SFTPProvider(
+    host="sftp.example.com",
+    username="user"
+)
+```
+
+## Usage
+
+```python
+from synapse_sdk.utils.storage import get_storage
+
+# Automatic provider detection from URL
+storage = get_storage("s3://my-bucket/file.csv")
+local_path = storage.download()
+```

synapse_sdk-1.0.0a61/docs/api/utils/types.md

@@ -0,0 +1,51 @@
+---
+id: types
+title: Custom Types
+sidebar_position: 3
+---
+
+# Custom Types
+
+Custom types and Pydantic fields used throughout the SDK.
+
+## FileField
+
+Custom Pydantic field for handling file URLs with automatic download.
+
+```python
+from synapse_sdk.types import FileField
+from pydantic import BaseModel
+
+class MyParams(BaseModel):
+    input_file: FileField  # Automatically downloads files
+
+def process(params: MyParams):
+    file_path = params.input_file  # Local file path
+    # Process the file...
+```
+
+### Features
+
+- Automatic file download from URLs
+- Temporary file management
+- Support for various file formats
+- Validation of file existence
+
+## Usage Examples
+
+```python
+# In plugin parameters
+class ProcessParams(BaseModel):
+    data_file: FileField
+    config_file: FileField = None  # Optional file
+
+# The FileField automatically:
+# 1. Downloads the file from URL
+# 2. Validates file existence
+# 3. Returns local file path
+# 4. Cleans up temporary files
+```
+
+## Type Validation
+
+Custom validators for ensuring type safety across the SDK.

synapse_sdk-1.0.0a61/docs/changelog.md

@@ -0,0 +1,17 @@
+---
+id: changelog
+title: Changelog
+sidebar_position: 11
+---
+
+# Changelog
+
+All notable changes to Synapse SDK are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## Getting Help
+
+- **GitHub Issues**: https://github.com/datamaker-kr/synapse-sdk/issues