Published on February 2, 2018
Nothing brings back warm childhood memories like grandma’s chocolate cake recipe. My slight alteration of her original recipe is to add a touch of Python and share it with the world through a static site.
By reading this article, you’ll learn how to create a Contentful-powered Flask app. You’ll also learn how to turn that Flask app into a static site using Frozen-Flask—and how to deploy it all to Surge.sh.
Static sites are fast, lightweight and can be deployed almost everywhere for little or no money. Using Frozen Flask, a static site generator, to turn your Flask app, with all its inner logic and dependencies, into a static site reduces the need for complex hosting environments.
Contentful is content infrastructure for any digital project. For our chocolate cake app this means that we’ll retrieve the recipe together with the list of ingredients from Contentful’s Content Delivery API (CDA).
With Contentful, a content type is similar to a database table in that it defines what kind of data it can hold. We’ll create the content type so that it can hold any recipe. Because truth be told, grandma also made some fantastic pancakes, and I would like to share that recipe too one day.
So let’s start by naming our new content type Grandma’s kitchen like so:
We can then add different field types to this content type:
This recipe we’ll need the following field types:
Medium - that will contain the image of our beautiful creation
Short text - that will contain the recipe name
Long text - that will contain our list of ingredients
Long text - that will contain instructions
Boolean - to make sure that delicious == true
With the added field types our content type will look like so:
Now that we have our content type set up, we’ll go ahead and add our chocolate cake recipe.
With the recipe in place, it’s time put together our Flask app. When a user visits /chocolatecake/
, this minimalist app will render the recipe through a the recipe.html
template as seen below:
But we of course need a way to get our chocolate cake recipe data from the Contentful CDN and pass that data to the render_template
function as a variable…..
To pull data from Contentful into Flask, you will need an access token to authorize your API calls. Note that the access token is personal so you need to generate your own to get things to work.
While we can interact with Contentful’s endpoints using bare HTTP calls, the Python SDK makes dealing with response objects easier. Run pip install contentful
to install it. We also need to install support for rendering the Markdown-formatted parts of the response: pip install Flask-Markdown
Now we’ll create a method in our Flask app that does the following:
Connects to Contentful using our unique access token
Grabs the content of our chocolate cake recipe
Handles the JSON response from Contentful
Sends the data to be rendered to our template
And to send our dictionary data structure of recipe data for rendering by the template we modify the /chocolatecake/
route to look like so:
The template that we’ll render, recipe.html
, has the following content:
We now have a working Flask app running locally. This app grabs its content from Contentful’s CDN using an API call, and then renders a page like this:
We could stop here and just deploy our creation to Heroku or any other platform that can run Flask apps. But we want more—and we want it to be static.
To turn our Contentful-powered Flask app into a static site, we’ll be using Frozen-Flask. Install it using pip: pip install Frozen-Flask
We’ll create file called freeze.py
with the following content:
After running freeze.py
, we have a build directory containing:
This is exactly what we want—HTML and styling. So let’s ship it!
Surge.sh is a single-command web publishing platform. It allows you to publish HTML, CSS, and JavaScript for free—without leaving the command line. In other words: it’s a great platform for our static site.
Run npm install --global surge
to install the Surge and to create your free account.
All we need to deploy our static site is to run the surge
command from the build directory:
When you deploy a site using Surge.sh it generates the URL based on two random words — this time we got the words loud and jeans. So now all that’s left to do is to browse to http://loud-jeans.surge.sh/chocolatecake/ and make sure that static site version of grandma’s chocolate cake recipe deployed successfully.
It sure did 🚢
All it takes to create a static site from your Contentful-powered Flask app is Frozen-Flask. You get the best of both worlds by having both writers and editors working on the app’s content in Contentful, and then generating a static site that can be deployed almost anywhere.
This workflow will save you both time and money: Your creative writers get access to a feature-rich editing platform within Contentful, and you get the chance to deploy a fast and lightweight static site for little or no money.
Subscribe for updates
Build better digital experiences with Contentful updates direct to your inbox.