scitex_hub.appmaker

SciTeX App Tools — init, validate, develop, publish, and manage app plugins.

scitex_hub.appmaker.init_app(target_dir: str | Path, name: str, *, label: str = '', icon: str = 'fas fa-puzzle-piece', description: str = '', manifest: dict | None = None, license_id: str = 'AGPL-3.0', overwrite: bool = False, frontend_type: str = 'html') → list[str]

Generate complete app boilerplate in target_dir.

Parameters:

• target_dir (path) – Project directory (e.g. data/users/alice/proj/my_app/).

• name (str) – Python module name (must end with _app, e.g. ‘my_awesome_app’).

• label (str) – Human-readable label (default: derived from name).

• icon (str) – Font Awesome icon class (default: ‘fas fa-puzzle-piece’).

• description (str) – Short description for the app.

• manifest (dict, optional) – Extra manifest fields to merge.

• license_id (str) – SPDX license identifier (default: ‘AGPL-3.0’).

• overwrite (bool) – If True, overwrite existing files (default: False).

• frontend_type (str) – Frontend type: ‘html’ (default) or ‘react’ for React+Vite+Zustand.

Returns:

Relative paths of created files.

Return type:

list[str]

scitex_hub.appmaker.get_current() → str

Get the name of the currently active app.

Reads from SCITEX_CURRENT_APP environment variable. Returns empty string if not set.

scitex_hub.appmaker.switch_to(app_name: str) → bool

Switch the active app.

Sets the SCITEX_CURRENT_APP env var for the current process. For browser-side switching, use the UI automation API.

scitex_hub.appmaker.list_all(*, server_url: str | None = None) → list[dict]

List all available apps.

If running inside Django, reads from the registry directly. Otherwise, queries the server API.

scitex_hub.appmaker.get_info(app_name: str) → dict[str, Any]

Get detailed info for a specific app from its manifest.

Tries Django registry first, then falls back to reading manifest.json from the app directory.

scitex_hub.appmaker.install_app(app_name: str, *, server_url: str | None = None, token: str | None = None) → dict

Install an app from the store.

Requires authentication. Returns result dict with success/error.

scitex_hub.appmaker.check_deps(manifest: dict[str, Any]) → dict[str, list[str]]

Check which dependencies from a manifest are missing.

Parameters:

manifest – Parsed manifest.json dict (must have dependencies key).

Returns:

Dict mapping dep type → list of missing dependency specs. Empty dict means all dependencies are satisfied.

scitex_hub.appmaker.check_deps_from_manifest(manifest_path: Path) → dict[str, list[str]]

Convenience: load manifest.json then check deps.

scitex_hub.appmaker.install_deps(manifest: dict[str, Any], dep_type: str, *, timeout: int = 300) → dict[str, Any]

Install dependencies of a specific type from a manifest.

Parameters:

• manifest – Parsed manifest.json dict.

• dep_type – One of “python”, “system”, “node”, “r”.

• timeout – Max seconds for the install command.

Returns:

Dict with success, installed, error keys.

scitex_hub.appmaker.format_missing_report(missing: dict[str, list[str]]) → str

Format missing dependencies as a human-readable string.

scitex_hub.appmaker.build_container(app_dir: Path, *, output_dir: Path | None = None, timeout: int = 600) → dict[str, Any]

Build an Apptainer container from a .def file in an app directory.

Looks for container field in manifest.json. If it’s a .def file, builds it into a .sif file.

Parameters:

• app_dir – Path to the app directory containing manifest.json.

• output_dir – Where to place the .sif file. Defaults to app_dir.

• timeout – Max build time in seconds.

Returns:

Dict with success, sif_path, error keys.

scitex_hub.appmaker.get_prefs(app_name: str, *, prefs_path: Path | None = None) → dict[str, Any]

Get saved preferences for an app.

Returns empty dict if no preferences saved.

scitex_hub.appmaker.set_prefs(app_name: str, prefs: dict[str, Any], *, prefs_path: Path | None = None) → None

Save preferences for an app. Merges with existing preferences.

scitex_hub.appmaker.delete_prefs(app_name: str, *, prefs_path: Path | None = None) → bool

Delete all preferences for an app. Returns True if prefs existed.

scitex_hub.appmaker.list_prefs(*, prefs_path: Path | None = None) → dict[str, Any]

List all saved preferences for all apps.

scitex_hub.appmaker.validate(app_dir: str | Path) → list[str]

Run all validations on a local app directory.

Returns list of error strings (empty = valid).

scitex_hub.appmaker.validate_structure(app_dir: str | Path) → list[str]

Check that required files exist.

scitex_hub.appmaker.validate_security(app_dir: str | Path) → list[str]

Scan Python files for forbidden patterns.

scitex_hub.appmaker.validate_manifest(app_dir: str | Path) → list[str]

Check manifest.json schema and content.

scitex_hub.appmaker.validate_templates(app_dir: str | Path) → list[str]

Check template compliance with workspace frame rules.

scitex_hub.appmaker.validate_css(app_dir: str | Path) → list[str]

Check CSS compliance with workspace frame rules.

scitex_hub.appmaker.validate_dependencies(app_dir: str | Path) → list[str]

Check that manifest.json dependencies field is well-formed.

scitex_hub.appmaker.generate_license_text(spdx_id: str, author: str = '', year: int | None = None) → str | None

Generate full license text for the given SPDX identifier.

Parameters:

• spdx_id (str) – SPDX license identifier (e.g. ‘MIT’, ‘AGPL-3.0’).

• author (str) – Copyright holder name.

• year (int, optional) – Copyright year (default: current year).

Returns:

Filled-in license text, or None if spdx_id is unknown.

Return type:

str or None

scitex_hub.appmaker.dev_server(app_dir: str | Path, port: int = 8000) → None

Set up a local app for development in the SciTeX workspace.

Validates the app, creates a symlink into apps/ if needed, and prints remaining manual steps.

Parameters:

• app_dir (path) – Path to the app plugin directory.

• port (int) – Port number for the dev server (default: 8000).

scitex_hub.appmaker.publish(app_dir: str | Path, server_url: str, token: str) → dict

Validate locally then submit the app for review via JWT endpoint.

Parameters:

• app_dir (path) – Directory containing the app with manifest.json.

• server_url (str) – Base URL of the SciTeX Cloud server (e.g. http://127.0.0.1:8000).

• token (str) – JWT access token (Bearer auth).

Returns:

Server response with ‘success’ and ‘pr_url’ keys.

Return type:

dict

scitex_hub.appmaker.get_component(name: str) → dict | None

Get a shared component by name.

scitex_hub.appmaker.get_all_components() → dict

Get all available shared components.

scitex_hub.appmaker.get_css_imports(component_names: list[str]) → list[str]

Get CSS import paths for a list of components.

scitex_hub.appmaker.get_ts_imports(component_names: list[str]) → list[str]

Get TypeScript import paths for a list of components.