scitex_hub.module

SciTeX Hub Module – decorator and output APIs for custom workspace modules.

Example

from scitex_hub.module import module, output, html, INJECTED

@module(label="My Analysis", icon="fa-brain", category="analysis")
def my_analysis(project=INJECTED, plt=INJECTED):
    output(df, title="Raw Data")

scitex_hub.module.module(func: Callable = None, *, label: str = '', icon: str = 'fa-puzzle-piece', category: str = 'other', description: str = '', version: str = '0.1.0', dependencies: list | None = None, min_scitex_version: str = '') → Callable

Decorator to mark a function as a SciTeX workspace module.

The decorated function can declare parameters with default=INJECTED; the module runner will supply project, plt, and logger at execution time.

class scitex_hub.module.ModuleManifest(name: str = '', label: str = '', icon: str = 'fa-puzzle-piece', category: str = 'other', description: str = '', version: str = '0.1.0', dependencies: list = <factory>, min_scitex_version: str = '')

Metadata for a SciTeX workspace module.

Variables:

• name (Auto-generated slug from the decorated function name.)

• label (Human-readable display name shown in the UI.)

• icon (FontAwesome class (e.g. "fa-brain").)

• category (One of the VALID_CATEGORIES.)

• description (Short description of what the module does.)

• version (Semantic version string.)

• dependencies (Extra pip packages required by this module.)

• min_scitex_version (Minimum scitex version required (empty = any).)

name: str = ''

label: str = ''

icon: str = 'fa-puzzle-piece'

category: str = 'other'

description: str = ''

version: str = '0.1.0'

dependencies: list

min_scitex_version: str = ''

to_dict() → dict

Serialize manifest to a plain dictionary.

classmethod from_dict(data: dict) → ModuleManifest

Construct a ModuleManifest from a dictionary.

__init__(name: str = '', label: str = '', icon: str = 'fa-puzzle-piece', category: str = 'other', description: str = '', version: str = '0.1.0', dependencies: list = <factory>, min_scitex_version: str = '') → None

class scitex_hub.module.ModuleOutput(value: Any = None, title: str = '', output_type: str = '')

Single output item produced by a module function.

value: Any = None

title: str = ''

output_type: str = ''

__init__(value: Any = None, title: str = '', output_type: str = '') → None

class scitex_hub.module.ModuleOutputCollector

Thread-local collector that accumulates outputs during module execution.

classmethod get_current() → list[ModuleOutput]

Return the output list for the current thread.

classmethod add(value: Any, title: str = '') → None

Append an output item for the current thread.

classmethod clear() → None

Discard all collected outputs for the current thread.

scitex_hub.module.output(value: Any, title: str = '') → None

Add an output to the current module execution.

This is the primary API researchers call inside their module function to register figures, tables, text, or HTML for display.

scitex_hub.module.html(content: str) → _SafeHtml

Mark a string as safe HTML so the renderer emits it without escaping.

scitex_hub.module.render_output(item: ModuleOutput) → dict[str, Any]

Convert a single ModuleOutput to a serializable dict.

scitex_hub.module.render_outputs(items: list[ModuleOutput]) → list[dict[str, Any]]

Render a list of ModuleOutput items.