Python Flask web application CRUD sample with MariaDB database

Let us see how to set up a python flask web application that uses MariaDB back-end. For MariaDB integration to python, mariadb library is used.

By following this sample, learn Python Flask web application development and also how to do the create, read, update and delete tasks on a MariaDB database. This is a simple application that lists a set of cars available in a showroom for sale. Users can add, edit or delete from this list.
Contents
Install Python and setup Virtual Environment

Install Flask

Install mariadb python library

Initial steps for Flask Web Apps
Setting up First page

MariaDB Database Setup

Fetch data from MariaDB and list

Insert new item to MariaDB
Update items - MariaDB

Delete an Item from MariaDB

Flask CRUD with MariaDB - Complete code

Other web app samples
Install Python and setup Virtual Environment

Download and install the latest version of python from Python Website.

Setting up virtual environment is not a must, but its is good to keep all your projects within a virtual environment. Here, we will proceed with a virtual environment.

For that, go to the command prompt and cd to the folder where you are going to keep your project.
Run command python -m venv CarSales to create a project folder CarSales and a virtual environment for it.
Activate the VE using command:

For Windows:

CarSales\Scripts\activate.bat

For Linux, macOS:

source CarSales /bin/activate

After VE activation, from cmd type cd CarSales to navigate to the project folder.
Install Flask

To install flask, run command pip install flask or pip3.9 install flask
If not working use commands:

For Windows:

py -3.9 -m pip install flask

For Linux, macOS:

python3.9 -m pip install flask

Run pip freeze or pip3.9 freeze to check if flask installed successfully. Should give an output like this.
```
click==8.1.3
colorama==0.4.4
Flask==2.1.2
itsdangerous==2.1.2
Jinja2==3.1.2
MarkupSafe==2.1.1
Werkzeug==2.1.2
```
Install mariadb python library

For MariaDB connection we are going to use the mariadb python library. Install this using the command: pip install mariadb
Initial steps for Flask Web Apps

Follow these basic steps to set up your first Flask web application.
Create a file named carsales.py (you can provide any name), inside CarSales folder and copy below code to it. carsales.py is going to contain your start-up code which is required to run your webapp. From command prompt navigate to CarSales folder and execute command py carsales.py or python carsales.py or py -3.9 -m carsales or python3.9 -m carsales depending on OS and Python version.
```
from flask import Flask

carsales = Flask(__name__)

if(__name__ == "__main__"):
    carsales.run()
```
This code imports Flask module and creates an object carsales of Flask class. Last 2 lines serves as the entry point of the app and starts the server. In cmd, we will see the below message.
```
    * Serving Flask app 'carsales' (lazy loading)
    * Environment: production
    Use a production WSGI server instead.
    * Debug mode: off
    * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
```
Copy the url http://127.0.0.1:5000/ to your browser and run. We will get the Not Found message as below.

This means that the Flask has handled the server set up and our application is ready. We will now have to set up our html pages and routing to handle page navigations.
Setting up First page

We are going to keep a list page as the first page of the application.
In Flask, all our HTML should be placed inside a folder named templates and static files like javascript or stylesheet should be placed inside static folder.So, create a folder structure as below within your application folder and add html file carslist.html inside templates folder.

Add below code to carslist.html. To handle routing for this page, modify carsales.py as below. This code imports render_template module and sets up the default route.
Copied

from flask import Flask, render_template carsales = Flask(__name__) @carsales.route("/") #For default route def main(): return render_template("carslist.html") if(__name__ == "__main__"): carsales.run()
Copied

<!DOCTYPE html> <html lang="en-US" dir="ltr"> <head> <title>Cars List</title> </head> <body> <h2>Cars List</h2> </body>
In command prompt. click Ctrl + C to stop the application and run command py -3.9 -m carsales or python3.9 -m carsales or py carsales or python carsales (Varies depending on OS and the python version used). This process is to be done each time we make any changes and want to reload the page. Some times, after stopping flask application from command prompt, just reloading the html will not give you the desired output. If any such issues are faced, close the web page and reopen.

MariaDB Database Setup

For those who are new to MariaDB, download the MariaDB server from here and install it and set up root password. Then download and install DBeaver editor for MariaDB.

Then create a database named CarSales and within it, create a table TblCars with the following structure and insert below set of data.

CREATE TABLE TblCars(
	ID INT NOT NULL,
	Name VARCHAR(100) NULL,
	Year INT NOT NULL,
	Price INT);

INSERT INTO TblCars VALUES (1, 'Toyota Camry', 2018, 2000);
INSERT INTO TblCars VALUES (2, 'Honda Civic', 2019, 2200);
INSERT INTO TblCars VALUES (3, 'Chevrolet Silverado', 2017, 1800);
INSERT INTO TblCars VALUES (4, 'Ford F-150', 2020, 2500);
INSERT INTO TblCars VALUES (5, 'Nissan Altima', 2021, 3000);

Fetch data from MariaDB and list

carslist.html is going to hold the list of cars available for sale. To list the items, add below code in body of html and modify carsales.py main method as below. Also import mariadb. In python file, we are reading data from MariaDB database CarSales using mariadb python library.

from flask import Flask, render_template
import mariadb
import sys

carsales = Flask(__name__)

def connection():
    conn = mariadb.connect(
        user="root", #Your login user
        password="pwd", #Your login password
        host="localhost", #Your server name 
        port=3306,
        database="CarSales")
    return conn

@carsales.route("/")
def main():
    cars = []
    conn = connection()
    cursor = conn.cursor()
    cursor.execute("SELECT * FROM TblCars")
    for row in cursor.fetchall():
        cars.append({"id": row[0], "name": row[1], "year": row[2], "price": row[3]})
    conn.close()
    return render_template("carslist.html", cars = cars)

if(__name__ == "__main__"):
    carsales.run()

<table class="table">
    <thead>
        <tr>
        <th scope="col">Id</th>
        <th scope="col">Name</th>
        <th scope="col">Year</th>
        <th scope="col">Price</th>
        </tr>
    </thead>
    <tbody>
        {% for car in cars %}
            <tr>
                <td>{{ car.id }}</th>
                <td>{{ car.name }}</td>
                <td>{{ car.year }}</td>
                <td>{{ car.price }}</td>
            </tr>
        {% endfor %}
    </tbody>
</table>

For styling we will use Bootstrap 5. Add below 2 lines inside head of html.


    <link rel="stylesheet" crossorigin="anonymous"
	href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" >
    
	<script crossorigin="anonymous"
	src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" >
	</script>

On rerun, we will get below output window.

Insert new item to MariaDB

Add a new button in the carslist.html above the table.

    <a class="btn btn-primary" href="addcar">Add New Car</a>

Add new html file, addcar.html and place below code. Add below code in caresales.py as the second route below main method.

@carsales.route("/addcar", methods = ['GET','POST'])
def addcar():
    if request.method == 'GET':
        return render_template("addcar.html")
    if request.method == 'POST':
        id = int(request.form["id"])
        name = request.form["name"]
        year = int(request.form["year"])
        price = float(request.form["price"])
        conn = connection()
        cursor = conn.cursor()
        cursor.execute("INSERT INTO TblCars (id, name, year, price) VALUES (?, ?, ?, ?)", (id, name, year, price) )
        conn.commit()
        conn.close()
        return redirect('/')

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
    <title>Car Details</title>
    
    <link rel="stylesheet" crossorigin="anonymous"
	href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" >
    
	<script crossorigin="anonymous"
	src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" >
	</script>

</head>

<body>
    <h2>Car Details</h2>

    <form action="" method = "POST">
        <div class="form-group row">
          <label for="id">Id</label>
          <input type="text" class="form-control" name="id" id="id">
        </div>
        <div class="form-group row">
            <label for="name">Maker and Model</label>
            <input type="text" class="form-control" name="name" id="name">
        </div>
        <div class="form-group row">
            <label for="year">Make Year</label>
            <input type="text" class="form-control" name="year" id="year">
        </div>
        <div class="form-group row">
            <label for="price">Sell Price</label>
            <input type="text" class="form-control" name="price" id="price">
        </div>
        <button type="btnAdd" class="btn btn-primary">Submit</button>
        <a href="/" class="btn btn-primary">Cancel</a>
      </form>
</body>

Now we have to import request and redirect. For that, change first line of caresales.py as below.

from flask import Flask, render_template, request, redirect

In the python code, we are defining a new route for addcar. We are using the same method for GET and POST. GET is just rendering addcar.html. In POST, we are reading data from form controls and save data to table and then redirect to list page.

In HTML page, we are defining a form with 4 text boxes. Each has a name provided. This name is used in the python file while reading data from controls.
On rerun, we can navigate to Create page as below and add new Car.

Update items - MariaDB

For update and delete add 2 links in the carslist.html page as below.

<table class="table">
    <thead>
        <tr>
        <th scope="col">Id</th>
        <th scope="col">Name</th>
        <th scope="col">Year</th>
        <th scope="col">Price</th>
        <th scope="col">Edit</th>
        <th scope="col">Delete</th>
        </tr>
    </thead>
    <tbody>
        {% for car in cars %}
            <tr>
                <td>{{ car.id }}</th>
                <td>{{ car.name }}</td>
                <td>{{ car.year }}</td>
                <td>{{ car.price }}</td>
                <td><a href='updatecar/{{ car.id }}'>Edit</a></td>
                <td><a href='deletecar/{{ car.id }}'>Delete</a></td>
            </tr>
        {% endfor %}
    </tbody>
</table>

First, in addcar.html, in order to populate the values, use the value attribute and bind the car object values as in html provided below.

Then, in carsales.py, add new updatecar route. Use the GET to fetch the details of the selected item and bind to the html. In POST, we are exeucting the update based on the selected ID.

Note: Disable the ID textbox to not make changes to ID. Here we are not doing it and if ID is changed no update will happen.

@carsales.route('/updatecar/<int:id>',methods = ['GET','POST'])
def updatecar(id):
    cr = []
    conn = connection()
    cursor = conn.cursor()
    if request.method == 'GET':
        cursor.execute("SELECT * FROM TblCars WHERE id=?", (id,))
        for row in cursor.fetchall():
            cr.append({"id": row[0], "name": row[1], "year": row[2], "price": row[3]})
        conn.close()
        return render_template("addcar.html", car = cr[0])
    if request.method == 'POST':
        name = str(request.form["name"])
        year = int(request.form["year"])
        price = float(request.form["price"])
        cursor.execute("UPDATE TblCars SET name = ?, year = ?, price = ? WHERE id = ?", (name, year, price, id))
        conn.commit()
        conn.close()
        return redirect('/')

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
    <title>Car Details</title>
    
    <link rel="stylesheet" crossorigin="anonymous"
	href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" >
    
	<script crossorigin="anonymous"
	src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" >
	</script>

</head>

<body>
    <h2>Car Details</h2>

    <form action="" method = "POST">
        <div class="form-group row">
          <label for="id">Id</label>
          <input type="text" class="form-control" name="id" id="id" value="{{car.id}}">
        </div>
        <div class="form-group row">
            <label for="name">Maker and Model</label>
            <input type="text" class="form-control" name="name" id="name" value="{{car.name}}">
        </div>
        <div class="form-group row">
            <label for="year">Make Year</label>
            <input type="text" class="form-control" name="year" id="year" value="{{car.year}}">
        </div>
        <div class="form-group row">
            <label for="price">Sell Price</label>
            <input type="text" class="form-control" name="price" id="price" value="{{car.price}}">
        </div>
        <button type="btnAdd" class="btn btn-primary">Submit</button>
        <a href="/" class="btn btn-primary">Cancel</a>
      </form>
</body>

After the above changes, update will work, but create will throw an error. To fix this, change the render_template line of addcar as below.

return render_template("addcar.html", car = {})

We are binding an empty car object to make it working.

Delete an Item from MariaDB

For delete, add a new route deletecar and execute delete query.

@carsales.route('/deletecar/<int:id>')
def deletecar(id):
    conn = connection()
    cursor = conn.cursor()
    cursor.execute("DELETE FROM TblCars WHERE id=?", (id,))
    conn.commit()
    conn.close()
    return redirect('/')

Flask CRUD with MariaDB database - Complete code

Complete code is placed below.

from flask import Flask, render_template, request, redirect
import mariadb
import sys

carsales = Flask(__name__)

def connection():
    conn = mariadb.connect(
        user="root", #Your login user
        password="pwd", #Your login password
        host="localhost", #Your server name 
        port=3306,
        database="CarSales")
    return conn
	

@carsales.route("/")
def main():
    cars = []
    conn = connection()
    cursor = conn.cursor()
    cursor.execute("SELECT * FROM TblCars")
    for row in cursor.fetchall():
        cars.append({"id": row[0], "name": row[1], "year": row[2], "price": row[3]})
    conn.close()
    return render_template("carslist.html", cars = cars)

@carsales.route("/addcar", methods = ['GET','POST'])
def addcar():
    if request.method == 'GET':
        return render_template("addcar.html", car = {})
    if request.method == 'POST':
        id = int(request.form["id"])
        name = request.form["name"]
        year = int(request.form["year"])
        price = float(request.form["price"])
        conn = connection()
        cursor = conn.cursor()
        cursor.execute("INSERT INTO TblCars (id, name, year, price) VALUES (?, ?, ?, ?)", (id, name, year, price) )
        conn.commit()
        conn.close()
        return redirect('/')

@carsales.route('/updatecar/<int:id>',methods = ['GET','POST'])
def updatecar(id):
    cr = []
    conn = connection()
    cursor = conn.cursor()
    if request.method == 'GET':
        cursor.execute("SELECT * FROM TblCars WHERE id=?", (id,))
        for row in cursor.fetchall():
            cr.append({"id": row[0], "name": row[1], "year": row[2], "price": row[3]})
        conn.close()
        return render_template("addcar.html", car = cr[0])
    if request.method == 'POST':
        name = str(request.form["name"])
        year = int(request.form["year"])
        price = float(request.form["price"])
        cursor.execute("UPDATE TblCars SET name = ?, year = ?, price = ? WHERE id = ?", (name, year, price, id))
        conn.commit()
        conn.close()
        return redirect('/')

@carsales.route('/deletecar/<int:id>')
def deletecar(id):
    conn = connection()
    cursor = conn.cursor()
    cursor.execute("DELETE FROM TblCars WHERE id=?", (id,))
    conn.commit()
    conn.close()
    return redirect('/')

if(__name__ == "__main__"):
    carsales.run()

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
    <title>Cars List</title>
    
    <link rel="stylesheet" crossorigin="anonymous"
	href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" >
    
	<script crossorigin="anonymous"
	src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" >
	</script>

</head>

<body>
    <h2>Cars List</h2>
    <a class="btn btn-primary" href="addcar">Add New Car</a>
    <table class="table">
        <thead>
            <tr>
            <th scope="col">Id</th>
            <th scope="col">Name</th>
            <th scope="col">Year</th>
            <th scope="col">Price</th>
            <th scope="col">Edit</th>
            <th scope="col">Delete</th>
            </tr>
        </thead>
        <tbody>
            {% for car in cars %}
                <tr>
                    <td>{{ car.id }}</th>
                    <td>{{ car.name }}</td>
                    <td>{{ car.year }}</td>
                    <td>{{ car.price }}</td>
                    <td><a href='updatecar/{{ car.id }}'>Edit</a></td>
                    <td><a href='deletecar/{{ car.id }}'>Delete</a></td>
                </tr>
            {% endfor %}
        </tbody>
    </table>
</body>

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
    <title>Car Details</title>
    
    <link rel="stylesheet" crossorigin="anonymous"
	href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" >
    
	<script crossorigin="anonymous"
	src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" >
	</script>

</head>

<body>
    <h2>Car Details</h2>

    <form action="" method = "POST">
        <div class="form-group row">
          <label for="id">Id</label>
          <input type="text" class="form-control" name="id" id="id" value="{{car.id}}">
        </div>
        <div class="form-group row">
            <label for="name">Maker and Model</label>
            <input type="text" class="form-control" name="name" id="name" value="{{car.name}}">
        </div>
        <div class="form-group row">
            <label for="year">Make Year</label>
            <input type="text" class="form-control" name="year" id="year" value="{{car.year}}">
        </div>
        <div class="form-group row">
            <label for="price">Sell Price</label>
            <input type="text" class="form-control" name="price" id="price" value="{{car.price}}">
        </div>
        <button type="btnAdd" class="btn btn-primary">Submit</button>
        <a href="/" class="btn btn-primary">Cancel</a>
      </form>
</body>

Other web app samples

Crud Samples implemented using different frameworks and databases.

Flask

Flask CRUD with JSON

Flask CRUD with SQL Server

Flask CRUD with MySQL

Flask Web App Sample using MongoDB

Flask CRUD with Oracle

Flask CRUD with PostgreSQL

Flask Web App Sample using MariaDB

Flask Web App Sample using Firebase DB

Django

Django CRUD with JSON

Django CRUD with SQL Server

Django CRUD with MySQL

Django Web App Sample using MongoDB

Django CRUD with Oracle

Django CRUD with PostgreSQL

Django Web App Sample using MariaDB

Django Web App Sample using Firebase DB

CherryPy

CherryPy CRUD with SQL Server

CherryPy Web App Sample using MongoDB

CherryPy CRUD with Oracle

CherryPy CRUD with JSON

CherryPy Web App Sample using Firebase DB

CherryPy CRUD with MySQL

CherryPy Web App Sample using MariaDB

CherryPy CRUD with PostgreSQL

Python Flask web application CRUD sample with MariaDB database

Contents

Install Python and setup Virtual Environment

Install Flask

Install mariadb python library

Initial steps for Flask Web Apps

Setting up First page

MariaDB Database Setup

Fetch data from MariaDB and list

Insert new item to MariaDB

Update items - MariaDB

Delete an Item from MariaDB

Flask CRUD with MariaDB database - Complete code

Other web app samples

Flask

Django

CherryPy