How To Create A UI For Your Python App

How To Create A UI For Your Python App

Python is likely one of the widespread programming languages for automating search engine optimisation processes.

One of many best libraries for making a front-end for our apps with none HTML, CSS data, or coding with a JavaScript-powered framework is Streamlit bundle.

On this Streamlit tutorial, we’ll dive into how one can create a lovely app with Python and the Dockerfile for deploying your Streamlit app.

What Is Streamlit?

Streamlit is an open-source app framework (a Python bundle) that provides us the facility for creating nice-looking apps with none front-end growth data.

This makes us free from involvement in any front-end framework or coding in HTML, CSS, and JavaScript.

You utilize pure Python to develop your front-end.

When Will The Streamlit Library Change into Helpful?

To begin with, in case you are coding Python scripts that run usually on a machine with a job scheduler like cron, Streamlit isn’t helpful for you.

However in case you are creating a software that you simply need to share together with your staff members, for instance, a key phrase analysis app, you should utilize Streamlit.

Additionally, if you happen to want a person authentication technique, the Streamlit group developed a bundle that may deal with it for you.

Create A Streamlit App: Getting Began

Let’s create a easy app that will get autocomplete queries for a seed key phrase from the Google public API.

Earlier than starting, create a folder in your machine, and title it what you need.

Additionally, I’ll assume you might have put in Python earlier than and know the basics of Python programming.

For the entire course of, we have to use these Python libraries:

  • Requests.
  • Streamlit.
  • Streamlit-Authenticator.
  • PyYAML.

Additionally, we’ll import a Python customary library:

The tutorial code will be present in my Streamlit starter template repository on Github.

Putting in The Streamlit Bundle

To begin with, I desire to create a digital setting by operating python3 -m venv .env, after which putting in the Streamlit bundle by operating pip3 set up streamlit.

Now create a Python script. Let’s name it streamlit_app.py.

In advanced initiatives which have too many capabilities, I desire to have separate Python script recordsdata for my totally different capabilities after which import these into the streamlit_app.py or create a separate app with Flask or FastAPI.

For instance, in a key phrase analysis app, I’ve a Python script for various capabilities that get knowledge from Semrush, a script for getting the highest 10 or 20 outcomes from Google, a script to get the Google autocomplete and Google-related searches, and so forth.

Get The Google Autocomplete Queries

For making requests, we have to use the Requests bundle. To get this bundle, it is advisable to run pip3 set up requests.

Additionally, to parse the autocomplete API response, we have to import the Python customary JSON library.

To begin with, we import the JSON customary library, the Requests bundle for making requests, and Streamlit for creating our app.

Then, I outlined a perform for getting the Google autocomplete queries as a listing of strings.

I used change perform twice to maintain every little thing easy, however you should utilize re library for utilizing regex.

"""A Streamlit app for getting the Google autocomplete queries
import json

import requests
import streamlit as st

def google_autocomplete(key phrase: str) -> listing[str]:
    """Get Google autocomplete queries for a seed key phrase

        key phrase (str): The seed key phrase

        listing[str]: A listing of the autocomplete queries
    google_autocomplete_api: str = "https://www.google.com/full/search"
    google_autocomplete_params: dict = 
        "q": key phrase,
        "cp": 8,
        "shopper": "gws-wiz",
        "xssi": "t",
        "hl": "en-US"

    response = requests.get(google_autocomplete_api, params=google_autocomplete_params)

    list_google_autocomplete_uncleaned: listing[list] = json.masses((response.content material).decode("UTF-8")[5:])[0]
    list_google_autocomplete_cleaned: listing[str] = [
        element[0].change('<b>', '').change('</b>', '')
        for factor in list_google_autocomplete_uncleaned

    return list_google_autocomplete_cleaned

The Streamlit App

Up till now, we have now put in the Streamlit bundle and outlined our perform to get the Google autocomplete queries. Now, let’s create the precise app.

To view the Streamlit app, we have to run the Streamlit with the run streamlit_app.py command within the terminal for operating our app domestically. After you run this command, by going to the http://localhost:8501/ URL, you’ll be able to view the app.

Sure, it’s clean as a result of we didn’t add any heading, and so forth., to it.

Running the Streamlit app from a terminalScreenshot from writer, October 2022

Add A Heading To The Streamlit App

Let’s add a heading to our app. As you see above, I imported the Streamlit as st.

Now by calling the st.title() perform, we are able to add a heading to the web page with a title fashion. Let’s say st.title(“It is a subsequent stage search engine optimisation app”).

Do not forget that after modifying your streamlit_app.py file and saving it, an icon seems within the prime proper nook of the web page, and it’s essential to press All the time return to view the app adjustments with none web page refresh.

Always return button in the Streamlit appScreenshot from writer, October 2022

Now our app seems to be just like the picture beneath. In case your system theme is darkish, your app is with a darkish theme.

A look at a Streamlit app with headingScreenshot from writer, October 2022

Add Textual content To The Streamlit App

For including a textual content paragraph to the app, it is advisable to use the st.write() perform. For instance, st.write(“Make your concepts actual”).

Steamlit appScreenshot from writer, October 2022

Add A Textual content Enter To The Streamlit App

As you noticed within the Google autocomplete perform, there was an argument referred to as “key phrase”.

This argument should come from the person enter.

To get the person enter, we are able to use a textual content enter area in Streamlit. With st.text_input() we are able to add a textual content enter. For instance, st.text_input(“What’s your seed key phrase?”).

Additionally, with a purpose to use the enter key phrase later to move to our perform, we should assign it to a variable.

input_google_autocomplete_keyword: str = st.text_input(
    "What's your seed key phrase?")

Now we need to run our app when there may be an enter key phrase. Right here, we use an if assertion to examine if the variable is empty or not.

if input_google_autocomplete_keyword:
    output_list_google_autocomplete: listing[str] = google_autocomplete(
A look at a Streamlit app with a heading, text, and text inputScreenshot from writer, October 2022

Obtain From The Streamlit App

So, we have now added a heading, a line of textual content, and an enter textual content area to get the person seed key phrase.

Now we should execute our written perform and make a obtain button for the person to get the ends in a textual content file.

if output_list_google_autocomplete:
        st.download_button("Obtain the output",
                           ("n").be part of(output_list_google_autocomplete))
A look at a Streamlit app with a heading, text, text input, and download buttonScreenshot from writer, October 2022

We constructed our easy app! Let’s change the app title and favicon.

Earlier than that, let’s see the Streamlit app part code up till now.

The Streamlit app section codeScreenshot from writer, October 2022

Change The App Title And Favicon

The default title of the app is streamlit_app · Streamlit, and the favicon of the app is the Streamlit icon.

To alter the title and favicon, we should use the st.set_page_config().

Additionally, I desire the app format to be vast (you’ll be able to take a look at it).

    page_title="Oh My App!",
The Streamlit app in the browserScreenshot from writer, October 2022

Set The App’s Default Theme

The app theme relies on the person’s system settings, however personally, most instances, I discover out the sunshine theme has higher distinction – and I don’t need my staff to place their time into discovering out how one can change the app theme.

To set a default theme for the Streamlit app, first, it’s essential to create a folder, and title it .streamlit. Inside this folder create a file, and title it config.toml.

Contained in the config.toml it’s essential to insert the beneath strains to set your app’s default theme.

base = "gentle"
The confing.toml file code for customizing the Streamlit app themeScreenshot from writer, October 2022

Authenticating Customers In Streamlit

Think about that after you deploy your app, somebody finds out the app URL and accesses it.

To guard your app, it’s essential to authorize the customers earlier than they’ll use the app – like most SASSs we use day-after-day.

For a Streamlit app, we are able to use the Streamlit-Authenticator bundle. To put in it, within the terminal positioned in your app folder, kind the pip3 set up streamlit-authenticator command, and import the bundle into your app.

I like to recommend you learn the Streamlit authenticator package documentation to get a greater understanding of what’s going on.

import streamlit_authenticator as stauth

Now create a config.yaml file for inserting our customers’ credentials.

      e-mail: [email protected]
      title: The primary username
      password: 12345 # Should be changed with the hashed password
      e-mail: [email protected]
      title: The second username
      password: 111213 # Should be changed with the hashed password
  expiry_days: 30
  key: some_signature_key
  title: some_cookie_name
    - [email protected]

As within the bundle doc you’ll be able to see, now we should hash the passwords with the Hasher modules. I desire to open an IPython and run the beneath code line.

hashed_passwords = stauth.Hasher([‘12345’, ‘111213’]).generate()

Creating A Login Widget

Now we should create a login widget the place customers can enter their username, password, after which login into the app.

First, it is advisable to set up the PyYAML bundle with the pip3 set up pyyaml command and import it with the import yaml.

Then create an authenticator object, and render the login module.

with open("./config.yaml") as file:
    config = yaml.load(file, Loader=yaml.SafeLoader)

authenticator = stauth.Authenticate(

title, authentication_status, username = authenticator.login("Login", "essential")
The Streamlit login widgetScreenshot from writer, October 2022

Present The App To Efficiently Logged In Customers

Now we are able to use the authentication_status variable to see the app for our efficiently logged-in customers.

if authentication_status:
    authenticator.logout('Logout', 'essential')
elif authentication_status == False:
    st.error('Username/password is wrong')
elif authentication_status == None:
    st.warning('Please enter your username and password')

Deploy The Streamlit App With Docker

Now we’re within the closing step of creating our app.

You should use totally different providers for deploying your app, like AWS, Google Cloud, Azure, Heroku, DigitalOcean, and so forth.

Earlier than the Dockerfile, let’s create the necessities.txt file. To take action, we are able to use the pip3 freeze > necessities.txt command.

Streamlit Dockerfile

For deploying our app, I take advantage of Python 3.9.10.

FROM python:3.9.10
COPY . .
RUN pip3 set up -r necessities.txt
CMD ["streamlit", "run", "streamlit_app.py"]

Wrap Up

On this tutorial, we noticed how we are able to create a shocking UI with pure Python, and deploy it with Docker.

To study extra about totally different Streamlit widgets, see their well-documented API reference.

Extra assets: 

Featured Picture: Yaran/Shutterstock

Source link

Leave A Comment



Our purpose is to build solutions that remove barriers preventing people from doing their best work.

Giza – 6Th Of October
(Sunday- Thursday)
(10am - 06 pm)

No products in the cart.

Select the fields to be shown. Others will be hidden. Drag and drop to rearrange the order.
  • Image
  • SKU
  • Rating
  • Price
  • Stock
  • Availability
  • Add to cart
  • Description
  • Content
  • Weight
  • Dimensions
  • Additional information
  • Attributes
  • Custom attributes
  • Custom fields
Click outside to hide the comparison bar
Compare ×
Let's Compare! Continue shopping