Table of Contents

1. Description
2. How-To
   1. Run the script
      1. Prerequisites
      2. Manually
      3. Automatically
   2. Kill streamlit instances
   3. Update streamlit in all envs
3. Run at Startup with Crontab
   1. Run one
   2. Run many

Description

A bash script to start streamlit scripts in the background. Was created out of a desire to run my various streamlit projects simultaneously, easily, and at ports I wanted them at. Check em out!

• Portfolio #wip
• Covid Dashboard #wip
• Venmo Calculator #wip
• Protein Calculator #finished

How-to

Run the script

Prerequisites

For purposes of this script, your streamlit projects are assumed to be in their own folders within one projects folder in the home directory:

|-- home
    |-- projects
        |-- streamlit_project1 # folder name matches script name. Will store project log (nohup.out)
            |--streamlit_project1.py # script name matches folder name
        |-- streamlit_project2
            |--streamlit_project2.py
        |-- streamlit_project3
            |--streamlit_project3.py
    |-- streamlit_starter # cloned repo
        |-- st_starter.sh # starts streamlit script
        |-- secret.sh # input information here
        |-- log_streamlit_project1.txt # these will be created automatically
        |-- log_streamlit_project2.txt
        |-- log_streamlit_project3.txt        

Make the scripts executable by doing the following:

cd streamlit_starter
chmod +x secret.sh 
chmod +x st_starter.sh

Automatically

To start many projects in the background, edit the secret.sh to add both streamlit and database information. Note that my_dash.py must be in a folder called my_dash.

#!/bin/bash

db_user="my_user:my_pw" # Database  login in the format of "my_user:my_pw". Quotes included
db_ip=192.168.1.11   # Database local ip such as 192.168.1.11, without http. Quotes not included
db_port=5432 # Database port such as 5432. Quotes not included

# start script |   folder    |  conda_env  |  port  |          database info         |     log file location
./st_starter.sh -f my_dash    -e dash_env   -p 8501  -u $db_user -i $db_ip -r $db_port >> ~/streamlit_starter/log_dash.txt
./st_starter.sh -f portfolio  -e port_env   -p 8502  -u $db_user -i $db_ip -r $db_port >> ~/streamlit_starter/log_port.txt

Then just start it with ./secret.sh

Manually

To start one project in the background manually, use the st_starter.sh script with the appropriate tags:

./st_starter.sh -f my_dash -e dash_env -p 8501 -u db_user_pw -i db_ip_address -r db_port

• h Print this Help.
• f Folder python script is in. Assumes script name = folder name
• e Conda environment to use.
• p Port to publish on.
• u Database user:pw as string
• i Database local ip
• r Database port

The streamlit project will have a nohup.out created in its folder, this is the streamlit log.

Kill streamlit instances

There's a couple options to kill streamlit instances:

# View streamlit instances running in the background, but it will not show the name
ps -C streamlit

# Kill a specific streamlit instance
pkill -f my_dash.py

# Kill all streamlit instances
killall -9 streamlit

Update streamlit in all envs

It gets tedious to constantly activate, update, and deactivate environments. For this reason st_updater.sh was created. It will go through all environments provided and run pip install streamlit --upgrade in them (updates to the latest streamlit version), then deactivates the environment.

1. Replace the current demo environment names with yours (no commas) (line 3) nano st_updater.sh
2. Give execute permissions sudo chmod +x st_updater.sh
3. Run the script ./st_updater.sh

Run at Startup with Crontab

Customize then add the following line at the end of crontab -e to have the script started on each reboot. A crontab line is needed for each script.

Run one

The following will run my_dash.py on at localhost:8501 in the dash_env environment every time the OS is rebooted. All terminal outputs are stored in scripts/dash_log.txt

@reboot /bin/bash ~/streamlit_starter/st_starter.sh -f my_dash -e dash_env -p 8501 >> ~/scripts/dash_log.txt

Run many

This will run all scripts that are in the secret.sh file at the appropriate ports and in the appropriate environments, each time the OS is rebooted. All terminal outputs will be stored in their respective folders.

@reboot /bin/bash ~/streamlit_starter/secret.sh