Beginner AI

Streamlit App Boilerplate that contains everything you need to get running.

Built with ❤️ by Gerard Bentley

Click the gitpod link above to set up your own development environment in the cloud without downloading or installing anything! (See below for more information and local setup instructions)

What's this?

• README.md: This Document! To help you find your way around
• streamlit_app.py: The main app that gets run by streamlit
• requirements.txt: Pins the version of packages needed
• LICENSE: Follows Streamlit's use of Apache 2.0 Open Source License
• .gitignore: Tells git to avoid comitting / scanning certain local-specific files
• .streamlit/config.toml: Customizes the behaviour of streamlit without specifying command line arguments (streamlit config show)
• .gitpod.yml: Special file to tell Gitpod how to start running your app (see docs and python docs)

Gitpod Setup

Using the gitpod link should present you with a screen like the following to use your github account to authenticate with gitpod (you need a github account for this).

After confirming, you should soon see a screen like the following. It will take some time (less than 2 minutes most likely) for it to download and install the necessary packages.

Once you see the "You can now view your Streamlit app in the browser." message it should open a new tab. Otherwise click the link provided in the terminal.

Local Setup

Assumes working python installation and some command line knowledge (install python with conda guide).

# External users: download Files
git clone git@github.com:gerardrbentley/Beginner-ML-Projects.git
# if you don't have ssh set up use the following
# git clone https://github.com/gerardrbentley/Beginner-ML-Projects.git

# Go to correct directory
cd Beginner-ML-Projects

# Create virtual environment for this project
python -m venv venv

# Activate the virtual environment
. ./venv/bin/activate
# .\venv\Scripts\activate for Windows

# Install required Packages
python -m pip install -r requirements.txt

# Run the streamlit app
streamlit run Home.py

Open your browser to http://localhost:8501/ if it doesn't open automatically.

Deploy

For the easiest experience, deploy to Streamlit Cloud

For other options, see Streamilt deployment wiki

Credits

This package was created with Cookiecutter and the gerardrbentley/cookiecutter-streamlit project template.

• Cookiecutter: https://github.com/audreyr/cookiecutter
• gerardrbentley/cookiecutter-streamlit: https://github.com/gerardrbentley/cookiecutter-streamlit