Dev env setup

Python version: 3.11

verify python version: python --version
create virtual env: python -m venv venv
activate virtual env: source venv/bin/activate
install dependencies: pip install -r requirements.txt

Running the streamlit app:

streamlit run main/app.py

Note that you (usually) don't need to rerun the app for changes to take effect, as the script is executed on every interaction.

Running using PyCharm (for debugging):

Make sure the Python Interpreter is set to the virtual env created above: /venv/bin/python

Useful streamlit links:

• Streamlit-antd-components - components library
• OAuth2 Authentication example (google)
• Dataframes and Data editor
• Session State
• Robust dataframe filtering
• Deleting rows without data editor example
• Experimental connection, SQLConnection
• Auth2 Component

Adding a new configuration:

To add a configuration with the name "Example" (e.g. "ExternalProduct"), Implement the following interfaces:

• Example - the configuration object, which is also saved in the database.
• ExampleSelection - the user's selection for a new configuration. from which an Example object is created.
• ExampleConfigurationFrotnend - incharge of displaying the data and manipulation of it by the user.
• ExampleConfigurationMiddleware - handles data manipulation between the database and the frontend, can be regarded as the 'Backend logic'.
• ExampleConfigurationResponse - transforms the configurations to be served as API.

For each of the above (except ExampleSelection) an entry should be added in their respective __init__.py file, so the main script or the controller can access them.