ui Module (stx.ui)

scitex-ui — Shared frontend UI components for the SciTeX ecosystem.

Components ship as TypeScript + CSS static assets, discoverable by Django’s AppDirectoriesFinder when added to INSTALLED_APPS.

Python API provides component metadata and registration.

scitex.ui.get_component(name)[source]

Get metadata for a registered component.

Return type:

Optional[Any]

scitex.ui.list_components()[source]

List all registered component names.

Return type:

list[str]

scitex.ui.get_static_dir()[source]

Return the absolute path to scitex_ui’s static asset directory.

This is the directory containing css/ and ts/ subdirectories. Works for both pip-installed packages and editable (dev) installs.

Useful for build tools (Vite, Webpack) that need to resolve scitex-ui source files at build time.

Returns:

e.g. /usr/lib/python3.11/.../scitex_ui/static/scitex_ui

Return type:

pathlib.Path

scitex.ui.get_docs_path()[source]

Return the absolute path to scitex_ui’s bundled documentation directory.

The directory contains APP_DEVELOPER_GUIDE.md and the Sphinx-built HTML docs. Works for both pip-installed packages and editable (dev) installs.

Returns:

e.g. /usr/lib/python3.11/.../scitex_ui/_docs

Return type:

pathlib.Path