Dashboard

Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters.

Add a resource to the StreamlitResource.

Add technical information on the resource. Technical info are useful to set additional information on the resource.

You can redefine this method to define custom logic to check this resource. If there is a problem with the resource, return a string that define the error, otherwise return None This method is called on output resources of a task. If there is an error returned, the task will be set to error and next proceses will not be run. It is also call when uploading a resource (usually for files or folder), if there is an error returned, the resource will not be uploaded

Clone the resource to create a new instance with a new id. It copies the RFields.

Set the streamlit code from a file path. The file will be read and the content will be copied as the streamlit code. Don't use this if you have multiple files for the streamlit app. In this case, use the set_streamlit_folder method. The code is stored as a string, the dashboard need to be re-generated to update the code.

You can redefine this method to set a name of the resource. When saving the resource the name will be saved automatically This can be useful to distinguish this resource from another one or to search for the resource

Get the default style of the resource

Get the id of the resource model in the database. It is provided by the system for input resources of a task.

Get the name of the resource or the default name if the name is None

Get the parameters that will be passed to the streamlit app.

Return the first resource with the given name

Return the resource model ids of the sub resources

Return the resource models of the sub resources list

Return the sub resources as a list

Return the sub resources as a set

Get the streamlit code.

Get the technical information of the resource

Return true if the resource with the given id is in the resource list

This can be overwritten to perform custom initialization of the resource. This method is called after the init (constructor) of the resource. The values of RFields are set when this method is called.

Return true if the resource list is empty

Return True if the streamlit app is executed in a virtual environment.

Replace current resources by the resources in the dict

Set the dashboard that will be used to generate the streamlit app. The Streamlit resource stores the dashboard typing name to find the dahsboard code. As long as the dashboard typing name does not change, the dashboard will be working.

If the dashboard code is updated, the SteamlitResource will automatically use the updated the dashboard code.

Set the code that will be executed in the streamlit environment. This code is executed before the streamlit app is loaded and can be used to load environment variables.

Set a parameter that will be passed to the streamlit app into the 'params' variable.

Set the parameters that will be passed to the streamlit app into the 'params' variable.

Set the streamlit code dynamically. The code is stored as a string, the dashboard need to be re-generated to update the code.

Set the folder that contains the streamlit code. The folder must contain a main.py file.

This is only recommended if you want to force the version of the dashboard in this Resource and avoid automatic updates. Otherwise use the set_dashboard method. The folder is copied and stored as a sub resource of the StreamlitResource. The dashboard need to be re-generated to update the code.

Return the resources as a list

Returns the name of the class

Copy the style of the resource with the possibility to override some properties. Useful when settings the style for a task based on the resource style.

Returns the full name of the class

Get the human name of the resource

Get the short description of the resource

Get the style of the resource

Get the typing name of the resource

Get all the classes that inherit this class

method to migrate streamlit resources to use the dashboard class

Args: task_typing_name (str): typing name of the task that generated the SteamlitResource

Create a StreamlitResource from a file path. The file will be read and the content will be set as the streamlit code. Don't use this if you have multiple files for the streamlit app. In this case, use the set_streamlit_folder method.