scitex-app — App Developer SDK

Toolkit for building SciTeX workspace apps with scaffold, validation, standalone mode, and cloud integration.

Sub-skills

• files-sdk — get_files(), FilesBackend protocol, FileSystemBackend, build_tree()
• app-lifecycle — init_app(), validate(), AppValidator, ValidationResult
• paths — Path resolution: get_base_dir(), resolve_*, parse_dev_module_name()
• standalone — run_standalone() for local Django workspace shell
• cli — scitex-app CLI: file commands, app commands, MCP, introspection
• environment-vars — All environment variable configuration

References

• references/app-lifecycle — End-to-end guide: scaffold → develop → validate → dev-install → test → submit. CLI commands with expected outputs, complete manifest schema, file structure.
• references/app-develop — Development patterns: views.py, urls.py, templates (AJAX partial), CSS scoping, React bridge setup.
• references/app-validate-install — Validate, dev-install, browser testing, environment variables, troubleshooting.
• references/app-registration — How apps register with the workspace sidebar: manifest.json → ModuleConfig → sidebar tab. Dev-install vs published paths, frontend integration points, troubleshooting.

Quick Start

scitex-app app init . --name my_app
scitex-app app validate .
scitex-app app dev-install . --server http://127.0.0.1:8000

from scitex_app.sdk import get_files, build_tree
from scitex_app._standalone import run_standalone

files = get_files("./my_project")
content = files.read("config/settings.yaml")
files.write("output/result.csv", csv_text)
tree = build_tree(files, max_depth=2)
run_standalone(app_module="my_app", port=8050)

MCP Tools

Tool	Parameters	Purpose
app_scaffold	name, frontend	Scaffold new app
app_validate	path	Validate app structure
app_read_file	path, root, binary	Read file content
app_write_file	path, content, root	Write file
app_list_files	directory, root, extensions	List directory
app_file_exists	path, root	Check file existence
app_delete_file	path, root	Delete file
app_copy_file	src_path, dest_path, root	Copy file
app_rename_file	old_path, new_path, root	Rename/move file