Flask with HTML
Goal
Use a basic HTML template with Flask.
Setup
You should continue to work in the FlaskLab
folder that you made for the Flask intro lab.
If you don’t have access to it anymore, just go through the steps to set up a basic Flask app with the dataset.csv
file again.
Note that you should not be worrying about style yet, that comes on Wednesday. However, if you really really really want to jump ahead (you just can’t stand the look of the basic page), here is a CSS primer.
Templates
As you know from your reading, Flask allows you to connect with HTML templates. Flask handles finding these as long as you put them where it is expecting.
(Fun fact/note: because I’m using a framework that has very similar syntax to Jinja to make this website, I have to do a special escape to actually display all the {{var}}
, and I might have missed a few, so if you see a strangely blank spot, it is very likely that it should have some curly braces with a variable in it.)
- Create a
templates
folder in yourFlaskLab
folder - Create a file in that folder
index.html
and put in the following boilerplate:<html> <head> </head> <body> </body> </html>
- Within the
heading
put in a set oftitle
HTML tags and place a placeholder{{title}}
between them:<title>{{title}}</title>
- If you have as many tabs open as I do regularly, you can’t actual see the titles easily, so, within the
body
, put in a heading with the title as well:<h1>Welcome to the {{title}}!</h1>
- Now you need to go edit your existing Flask app to use your new template. Open
flask_lab_app.py
and edit yourhomepage()
function so that instead of just returning a plain string, it returns the result of callingrender_template
with your title of choice:@app.route('/') def homepage(): return render_template('index.html', title="Silly Dataset")
- Run your app and check out your new fancy (kind of) homepage!
Data with Templates
Even though you don’t strictly have to use Jinja, it makes displaying lists much easier. Let’s display the headings of the silly dataset on the homepage.
- Within
index.html
make an unordered list in thebody
:<ul> </ul>
- Within that unordered list, we’ll use Jinja to make a list item for each heading in our list
headings
:{% for heading in headings: %} <li>{{ heading }}</li> {% endfor %}
- Now we need to actually pass that argument. Within
flask_lab_app.py
, add to the arguments that you are passing torender_template
inhomepage
:def homepage(): return render_template('index.html', title="Silly Dataset", headings = data[0])
- Restart your app to see your new fancy list!
- Try adding another list of the first data row of the silly dataset.
Fun extra
By combining the route variables and Jinja placeholders, you can let the user display what they want on your page.
Try making a new template and route so that you can go to your_url/greeting/your_name
and find a web page that greets whatever the user puts for your_name
.
Applying to your project
You don’t need to use HTML templates for what you submit for your Flask deliverables, but you will need them for the team project eventually, so it’s a good idea to try adding one to your individual deliverable project for practice.
Otherwise, feel free to keep working on your individual deliverable Flask app and/or your team’s Flask app.