synapse-sdk 1.0.0a11__py3-none-any.whl → 2026.1.1b2__py3-none-any.whl

synapse_sdk/plugins/templates/__init__.py

@@ -0,0 +1,50 @@
+"""Plugin templates for synapse plugin create."""
+
+from __future__ import annotations
+
+from importlib.resources import files
+from pathlib import Path
+
+
+def _get_templates_dir() -> Path:
+    """Get the templates directory path.
+
+    Uses importlib.resources for reliable access to package data,
+    falling back to __file__ for editable installs.
+    """
+    try:
+        # Try importlib.resources first (works with installed packages)
+        package_files = files('synapse_sdk.plugins.templates')
+        # For filesystem-based packages, this will have a real path
+        # joinpath returns a Traversable that we can use
+        base = package_files / 'base'
+        # Check if config.yaml.j2 exists to verify path is valid
+        if (base / 'config.yaml.j2').is_file():
+            # Get the actual path - package_files should be a Path-like for installed packages
+            return Path(str(package_files))
+    except (TypeError, AttributeError, FileNotFoundError):
+        pass
+
+    # Fall back to __file__ for editable installs or if above fails
+    return Path(__file__).parent
+
+
+# Cache the result to avoid repeated calls
+TEMPLATES_DIR = _get_templates_dir()
+
+
+def get_template_dir(category: str | None = None) -> Path:
+    """Get template directory for a category.
+
+    Args:
+        category: Plugin category. If None, returns base template directory.
+
+    Returns:
+        Path to template directory.
+    """
+    if category:
+        return TEMPLATES_DIR / category
+    return TEMPLATES_DIR / 'base'
+
+
+__all__ = ['TEMPLATES_DIR', 'get_template_dir']

synapse_sdk/plugins/templates/base/.gitignore.j2

@@ -0,0 +1,26 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+.venv/
+venv/
+*.egg-info/
+dist/
+build/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Misc
+.DS_Store
+*.log

synapse_sdk/plugins/templates/base/.synapseignore.j2

@@ -0,0 +1,11 @@
+# Files to exclude from plugin archive
+.git
+.venv
+venv
+__pycache__
+*.pyc
+.pytest_cache
+.ruff_cache
+*.egg-info
+dist
+build

synapse_sdk/plugins/templates/base/README.md.j2

@@ -0,0 +1,26 @@
+# {{ name }}
+
+{{ description }}
+
+## Category
+
+{{ category }}
+
+## Installation
+
+```bash
+uv sync
+```
+
+## Development
+
+```bash
+# Run locally
+synapse run <action_name>
+```
+
+## Publishing
+
+```bash
+synapse plugin publish
+```

synapse_sdk/plugins/templates/base/plugin/__init__.py.j2

@@ -0,0 +1 @@
+"""{{ name }} plugin."""

synapse_sdk/plugins/templates/base/pyproject.toml.j2

@@ -0,0 +1,14 @@
+[project]
+name = "{{ code }}"
+version = "{{ version }}"
+description = "{{ description }}"
+requires-python = ">=3.10"
+dependencies = [
+    "synapse-sdk",
+]
+
+[tool.uv]
+dev-dependencies = [
+    "pytest>=8.0",
+    "ruff>=0.8",
+]

synapse_sdk/plugins/templates/base/requirements.txt.j2

@@ -0,0 +1 @@
+synapse-sdk

synapse_sdk/plugins/templates/custom/plugin/main.py.j2

@@ -0,0 +1,18 @@
+"""Main action for {{ name }}."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+def run(**kwargs: Any) -> Any:
+    """Run the plugin.
+
+    Args:
+        **kwargs: Plugin arguments.
+
+    Returns:
+        Plugin result.
+    """
+    # TODO: Implement your plugin logic here
+    return {'result': 'success'}

synapse_sdk/plugins/templates/data_validation/plugin/validate.py.j2

@@ -0,0 +1,32 @@
+"""Validation action for {{ name }}."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class Validator:
+    """Validator class for {{ name }}.
+
+    This class handles data validation before annotation.
+    """
+
+    def __init__(self, **kwargs: Any) -> None:
+        """Initialize the validator.
+
+        Args:
+            **kwargs: Configuration options.
+        """
+        self.strict_mode = kwargs.get('strict_mode', False)
+
+    def validate(self, data: Any) -> dict[str, Any]:
+        """Validate data.
+
+        Args:
+            data: Data to validate.
+
+        Returns:
+            Validation result with 'valid' bool and optional 'errors' list.
+        """
+        # TODO: Implement your validation logic here
+        return {'valid': True, 'errors': []}

synapse_sdk/plugins/templates/export/plugin/export.py.j2

@@ -0,0 +1,36 @@
+"""Export action for {{ name }}."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+
+class Exporter:
+    """Exporter class for {{ name }}.
+
+    This class handles data export to custom formats.
+    """
+
+    def __init__(self, output_path: str | Path, **kwargs: Any) -> None:
+        """Initialize the exporter.
+
+        Args:
+            output_path: Path to write exported data.
+            **kwargs: Additional configuration options.
+        """
+        self.output_path = Path(output_path)
+
+    def export(self, data: Any) -> Path:
+        """Export data to custom format.
+
+        Args:
+            data: Data to export.
+
+        Returns:
+            Path to exported file.
+        """
+        # TODO: Implement your export logic here
+        output_file = self.output_path / 'export.json'
+        output_file.write_text('{}')
+        return output_file

synapse_sdk/plugins/templates/neural_net/plugin/inference.py.j2

@@ -0,0 +1,36 @@
+"""Inference action for {{ name }}."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class Inference:
+    """Inference class for {{ name }}.
+
+    This class handles model loading and prediction.
+    """
+
+    def __init__(self, model_path: str | None = None, **kwargs: Any) -> None:
+        """Initialize the inference class.
+
+        Args:
+            model_path: Path to trained model weights.
+            **kwargs: Additional configuration options.
+        """
+        self.model_path = model_path
+        self.model = None
+        # TODO: Load your model here
+        # self.model = load_model(model_path)
+
+    def predict(self, data: Any) -> Any:
+        """Run prediction on input data.
+
+        Args:
+            data: Input data for prediction.
+
+        Returns:
+            Prediction results.
+        """
+        # TODO: Implement your prediction logic here
+        return {'result': 'prediction'}

synapse_sdk/plugins/templates/neural_net/plugin/train.py.j2

@@ -0,0 +1,33 @@
+"""Training action for {{ name }}."""
+
+from __future__ import annotations
+
+
+def train(run, dataset, hyperparameter, checkpoint=None):
+    """Train the model.
+
+    Args:
+        run: Run context for logging metrics and progress.
+        dataset: Training dataset.
+        hyperparameter: Training hyperparameters.
+        checkpoint: Optional checkpoint to resume from.
+
+    Returns:
+        Path to saved model weights.
+    """
+    epochs = hyperparameter.get('epochs', 10)
+    batch_size = hyperparameter.get('batch_size', 32)
+    learning_rate = hyperparameter.get('learning_rate', 0.001)
+
+    run.set_progress(0, epochs, category='train')
+
+    for epoch in range(1, epochs + 1):
+        # TODO: Implement your training loop here
+        loss = 1.0 / epoch  # Placeholder
+        accuracy = epoch / epochs  # Placeholder
+
+        run.log_metric('epoch', epoch, loss=loss, accuracy=accuracy)
+        run.set_progress(epoch, epochs, category='train')
+
+    # Return path to saved model
+    return './'

synapse_sdk/plugins/templates/post_annotation/plugin/post_annotate.py.j2

@@ -0,0 +1,32 @@
+"""Post-annotation action for {{ name }}."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class PostAnnotator:
+    """Post-annotator class for {{ name }}.
+
+    This class handles post-processing after human annotation.
+    """
+
+    def __init__(self, **kwargs: Any) -> None:
+        """Initialize the post-annotator.
+
+        Args:
+            **kwargs: Configuration options.
+        """
+        self.auto_correct = kwargs.get('auto_correct', False)
+
+    def post_annotate(self, data: Any) -> dict[str, Any]:
+        """Process annotations.
+
+        Args:
+            data: Annotated data to process.
+
+        Returns:
+            Post-processing results.
+        """
+        # TODO: Implement your post-annotation logic here
+        return {'processed': True}

synapse_sdk/plugins/templates/pre_annotation/plugin/pre_annotate.py.j2

@@ -0,0 +1,32 @@
+"""Pre-annotation action for {{ name }}."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class PreAnnotator:
+    """Pre-annotator class for {{ name }}.
+
+    This class handles pre-annotation before human annotation.
+    """
+
+    def __init__(self, **kwargs: Any) -> None:
+        """Initialize the pre-annotator.
+
+        Args:
+            **kwargs: Configuration options.
+        """
+        self.auto_detect = kwargs.get('auto_detect', True)
+
+    def pre_annotate(self, data: Any) -> dict[str, Any]:
+        """Generate pre-annotations.
+
+        Args:
+            data: Data to pre-annotate.
+
+        Returns:
+            Pre-annotation results.
+        """
+        # TODO: Implement your pre-annotation logic here
+        return {'annotations': []}

synapse_sdk/plugins/templates/smart_tool/plugin/auto_label.py.j2

@@ -0,0 +1,44 @@
+"""Auto-label action for {{ name }}."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class AutoLabel:
+    """Auto-label class for {{ name }}.
+
+    This class handles input/output transformation for smart tools.
+    """
+
+    def __init__(self, **kwargs: Any) -> None:
+        """Initialize the auto-label class.
+
+        Args:
+            **kwargs: Configuration options.
+        """
+        pass
+
+    def handle_input(self, input_data: Any) -> Any:
+        """Transform smart tool input to model input format.
+
+        Args:
+            input_data: Input data from smart tool.
+
+        Returns:
+            Transformed data for model.
+        """
+        # TODO: Transform input for your model
+        return input_data
+
+    def handle_output(self, output_data: Any) -> Any:
+        """Transform model output to smart tool output format.
+
+        Args:
+            output_data: Output data from model.
+
+        Returns:
+            Transformed data for smart tool.
+        """
+        # TODO: Transform output for smart tool
+        return output_data

synapse_sdk/plugins/templates/upload/plugin/upload.py.j2

@@ -0,0 +1,35 @@
+"""Upload action for {{ name }}."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any, Iterator
+
+
+class Uploader:
+    """Uploader class for {{ name }}.
+
+    This class handles data upload from external sources.
+    """
+
+    def __init__(self, source_path: str | Path, **kwargs: Any) -> None:
+        """Initialize the uploader.
+
+        Args:
+            source_path: Path to source data.
+            **kwargs: Additional configuration options.
+        """
+        self.source_path = Path(source_path)
+
+    def upload(self) -> Iterator[dict[str, Any]]:
+        """Upload data from source.
+
+        Yields:
+            Data items to upload.
+        """
+        # TODO: Implement your upload logic here
+        # Each yielded item should be a dict with file info
+        yield {
+            'file': self.source_path / 'example.jpg',
+            'metadata': {},
+        }

synapse_sdk/plugins/testing/__init__.py

@@ -0,0 +1,25 @@
+"""Testing utilities for Synapse SDK plugins."""
+
+from synapse_sdk.plugins.testing.sample_actions import (
+    ConvertAction,
+    DownloadAction,
+    Step1Params,
+    Step1Result,
+    Step2Params,
+    Step2Result,
+    Step3Params,
+    Step3Result,
+    TrainAction,
+)
+
+__all__ = [
+    'Step1Params',
+    'Step1Result',
+    'Step2Params',
+    'Step2Result',
+    'Step3Params',
+    'Step3Result',
+    'DownloadAction',
+    'ConvertAction',
+    'TrainAction',
+]

synapse_sdk/plugins/testing/sample_actions.py

@@ -0,0 +1,98 @@
+"""Sample actions for integration testing."""
+
+import time
+
+from pydantic import BaseModel
+
+from synapse_sdk.plugins.action import BaseAction
+
+
+# Sample parameter/result models
+class Step1Params(BaseModel):
+    dataset_id: int
+
+
+class Step1Result(BaseModel):
+    dataset_id: int
+    dataset_path: str
+
+
+class Step2Params(BaseModel):
+    dataset_path: str
+
+
+class Step2Result(BaseModel):
+    dataset_path: str
+    converted_path: str
+
+
+class Step3Params(BaseModel):
+    converted_path: str
+    epochs: int = 5
+
+
+class Step3Result(BaseModel):
+    model_path: str
+    metrics: dict[str, float]
+
+
+# Sample actions
+class DownloadAction(BaseAction[Step1Params]):
+    """Simulates downloading a dataset."""
+
+    action_name = 'download'
+    params_model = Step1Params
+    result_model = Step1Result
+
+    def execute(self) -> Step1Result:
+        self.ctx.logger.info(f'Downloading dataset {self.params.dataset_id}...')
+        time.sleep(1)  # Simulate work
+        return Step1Result(
+            dataset_id=self.params.dataset_id,
+            dataset_path=f'/tmp/datasets/{self.params.dataset_id}',
+        )
+
+
+class ConvertAction(BaseAction[Step2Params]):
+    """Simulates converting a dataset."""
+
+    action_name = 'convert'
+    params_model = Step2Params
+    result_model = Step2Result
+
+    def execute(self) -> Step2Result:
+        self.ctx.logger.info(f'Converting dataset at {self.params.dataset_path}...')
+        time.sleep(1)  # Simulate work
+        return Step2Result(
+            dataset_path=self.params.dataset_path,
+            converted_path=f'{self.params.dataset_path}/yolo',
+        )
+
+
+class TrainAction(BaseAction[Step3Params]):
+    """Simulates training a model."""
+
+    action_name = 'train'
+    params_model = Step3Params
+    result_model = Step3Result
+
+    def execute(self) -> Step3Result:
+        self.ctx.logger.info(f'Training on {self.params.converted_path} for {self.params.epochs} epochs...')
+        time.sleep(2)  # Simulate work
+        return Step3Result(
+            model_path='/tmp/models/best.pt',
+            metrics={'mAP50': 0.85, 'mAP50-95': 0.72},
+        )
+
+
+__all__ = [
+    'Step1Params',
+    'Step1Result',
+    'Step2Params',
+    'Step2Result',
+    'Step3Params',
+    'Step3Result',
+    'DownloadAction',
+    'ConvertAction',
+    'TrainAction',
+]