Utilities

Overview

This section is composed of two directories: utils and exceptions.

Prerequisites

The .streamlit/secrets.toml file must be configured with the correct external module URLs and ports.

Utils

The utils directory provides utility modules and helper functions that support both the frontend and backend. Key components include:

• session_state.py: Offers shortcuts to get, set, and remove items from Streamlit's session state.

• refresh_db_functions.py: Contains functions to fetch and format data from the database for display in the UI. These functions are often cached for performance when used with Interactive Data Tables.

• terminal_connection.py provides functions to test SSH/SFTP connections and communicate with the two external modules:

  • The SSH Module for the terminal.
  • The SFTP Module for the file explorer.

Exceptions

The exceptions directory defines custom exception classes used throughout the project to handle specific error scenarios in a structured way.