nexusLIMS.tui.demo_helpers#

Helper utilities for generating TUI demos and screenshots.

This module provides functionality to create reproducible demo databases with sample instrument data for documentation and testing purposes.

Module Contents#

Functions#

create_demo_database

Create a reproducible demo database with sample instruments.

API#

nexusLIMS.tui.demo_helpers.create_demo_database(db_path: Path) → None[source]#

Create a reproducible demo database with sample instruments.

Creates a SQLite database with 10 sample instruments representing different configurations and use cases. This database is used for:

  • Documentation screenshots and recordings

  • TUI testing with realistic data

  • User guide examples

The function also sets NX_DB_PATH to the created database and refreshes the configuration.

Parameters:

db_path (Path) – Path where the demo database should be created. Will be overwritten if it already exists.

Examples:

>>> from pathlib import Path
>>> create_demo_database(Path("/tmp/demo.db"))