Comment créer une application Web à l'aide de Flask et la déployer dans le cloud

introduction

Dans chaque section, je montrerai des morceaux de code que vous pourrez suivre. Tout le code utilisé dans le didacticiel est disponible dans ce référentiel GitHub.

Qu'est-ce que HTTP et qu'est-ce que cela a à voir avec Flask?

HTTP est le protocole des sites Web. Internet l'utilise pour interagir et communiquer avec les ordinateurs et les serveurs. Permettez-moi de vous donner un exemple de la façon dont vous l'utilisez au quotidien.

Lorsque vous tapez le nom d'un site Web dans la barre d'adresse de votre navigateur et que vous appuyez sur Entrée. Ce qui se passe, c'est qu'une requête HTTP a été envoyée à un serveur.

Par exemple, lorsque je vais dans ma barre d'adresse et que je tape google.com, puis que j'appuie sur Entrée, une requête HTTP est envoyée à un serveur Google. Le serveur Google reçoit la demande et doit déterminer comment interpréter cette demande. Le serveur Google renvoie une réponse HTTP contenant les informations que mon navigateur Web reçoit. Ensuite, il affiche ce que vous avez demandé sur une page du navigateur.

Comment Flask est-il impliqué?

Nous écrirons du code qui s'occupera du traitement côté serveur. Notre code recevra les demandes. Il déterminera à quoi traitent ces demandes et ce qu'elles demandent. Il déterminera également quelle réponse envoyer à l'utilisateur.

Pour faire tout cela, nous utiliserons Flask.

Qu'est-ce que Flask?

Cela simplifie le processus de conception d'une application Web. Flask nous permet de nous concentrersur ce que les utilisateurs demandent et quel type de réponse donner en retour.

En savoir plus sur les micro-frameworks.

Comment fonctionne une application Flask?

Le code nous permet d'exécuter une application Web de base que nous pouvons servir, comme s'il s'agissait d'un site Web.

from flask import Flask app = Flask(__name__) @app.route("/") def home(): return "Hello, World!" if __name__ == "__main__": app.run(debug=True)

Ce morceau de code est stocké dans notre main.py.

Ligne 1: Nous importons ici le module Flask et créons un serveur Web Flask à partir du module Flask.

Ligne 3: __name__ signifie ce fichier actuel . Dans ce cas, ce sera main.py. Ce fichier actuel représentera mon application Web.

Nous créons une instance de la classe Flask et l'appelons app. Ici, nous créons une nouvelle application Web.

Ligne 5: elle représente la page par défaut. Par exemple, si je vais sur un site Web tel que "google.com/" sans rien après la barre oblique. Ensuite, ce sera la page par défaut de Google.

Ligne 6–7 : Lorsque l'utilisateur accède à mon site Web et qu'il accède à la page par défaut (rien après la barre oblique), la fonction ci-dessous est activée.

Ligne 9: Lorsque vous exécutez votre script Python, Python attribue le nom «__main__» au script lorsqu'il est exécuté.

Si nous importons un autre script, l' instruction if empêchera l'exécution d'autres scripts. Lorsque nous exécutons main.py, il changera son nom en __main__ et ce n'est qu'alors que l'instruction if s'activera.

Ligne 10: Cela lancera l'application. Le fait d'avoir debug=Truepermet à d'éventuelles erreurs Python d'apparaître sur la page Web. Cela nous aidera à retracer les erreurs.

Essayons d'exécuter main.py

Dans votre terminal ou votre invite de commande, accédez au dossier qui contient votre main.py.Alors fais py main.pyou python main.py. Dans votre terminal ou invite de commande, vous devriez voir cette sortie.

La partie importante est là où il est dit Running on //127.0.0.1:5000/.

127.0.0.1 signifie cet ordinateur local. Si vous ne connaissez pas la signification de ceci (comme je ne l'ai pas fait quand j'ai commencé - cet article est vraiment utile), l'idée principale est que 127.0.0.1 et localhost font référence à cet ordinateur local.

Accédez à cette adresse et vous devriez voir ce qui suit:

Plus de plaisir avec Flask

Plus tôt, vous avez vu ce qui s'est passé lorsque nous avons exécuté main.py avec une route qui était app.route («/»).

Ajoutons plus de routes afin que vous puissiez voir la différence.

from flask import Flask app = Flask(__name__) @app.route("/") def home(): return "Hello, World!" @app.route("/salvador") def salvador(): return "Hello, Salvador" if __name__ == "__main__": app.run(debug=True)

Aux lignes 9 à 11 . nous avons ajouté une nouvelle route, cette fois vers / salvador.

Maintenant, exécutez à nouveau main.py et accédez à// localhost: 5000 / salvador.

Jusqu'à présent, nous avons renvoyé du texte. Rendons notre site Web plus agréable en ajoutant du HTML et du CSS.

HTML, CSS et environnements virtuels

HTML et modèles dans Flask

Créez d'abord un nouveau fichier HTML. J'ai appelé le mien home.html.

Voici un code pour vous aider à démarrer.

    Flask Tutorial   

My First Try Using Flask

Flask is Fun

Point important à retenir

Flask Framework recherche les fichiers HTML dans un dossier appelé templates. Vous devez créer un dossier de modèles et y placer tous vos fichiers HTML.

Nous devons maintenant modifier notre main.py afin de pouvoir afficher le fichier HTML que nous avons créé.

from flask import Flask, render_template app = Flask(__name__) @app.route("/") def home(): return render_template("home.html") @app.route("/salvador") def salvador(): return "Hello, Salvador" if __name__ == "__main__": app.run(debug=True) We made two new changes

Line 1: We imported render_template() method from the flask framework. render_template() looks for a template (HTML file) in the templates folder. Then it will render the template for which you ask. Learn more about render_templates() function.

Line 7: We change the return so that now it returns render_template(“home.html”). This will let us view our HTML file.

Now visit your localhost and see the changes: //localhost:5000/.

Let’s add more pages

Let’s create an about.html inside the templates folder.

    About Flask   

About Flask

Flask is a micro web framework written in Python.

Applications that use the Flask framework include Pinterest, LinkedIn, and the community web page for Flask itself.

Let’s make a change similar to what we did before to our main.py.

from flask import Flask, render_template app = Flask(__name__) @app.route("/") def home(): return render_template("home.html") @app.route("/about) def about(): return render_template("about.html") if __name__ == "__main__": app.run(debug=True)

We made three new changes:

Line 9: Change the route to"/about".

Line 10: Change the function so it is nowdef about():

Line 11: Change the return so that now it returns render_template("about.html").

Now see the changes: //localhost:5000/about.

Let’s Connect Both Pages with a Navigation

To connect both pages we can have a navigation menu on the top. We can use Flask to make the process of creating a navigation menu easier.

First, let’s create a template.html. This template.html will serve as a parent template. Our two child templates will inherit code from it.

     Flask Parent Template 

First Web App

  • Home
  • About
{% block content %} {% endblock %}

Line 13–14: We use the function calledurl_for(). It accepts the name of the function as an argument. Right now we gave it the name of the function. More information on url_for() function.

The two lines with the curly brackets will be replaced by the content of home.html and about.html. This willdepend on the URL in which the user is browsing.

These changes allow the child pages (home.html and about.html) to connect to the parent (template.html). This allows us to not have to copy the code for the navigation menu in the about.html and home.html.

Content of about.html:

    About Flask   {% extends "template.html" %} {% block content %} 

About Flask

Flask is a micro web framework written in Python.

Applications that use the Flask framework include Pinterest, LinkedIn, and the community web page for Flask itself.

{% endblock %}

Content of home.html:

    Flask Tutorial   {% extends "template.html" %} {% block content %} 

My First Try Using Flask

Flask is Fun

{% endblock %}

Let’s try adding some CSS.

Adding CSS to Our Website

An important note to remember

In the same way as we created a folder called templates to store all our HTML templates, we need a folder called static.

In static, we will store our CSS, JavaScript, images, and other necessary files. That is why it is important that you should create a CSSfolder to store your stylesheets. After you do this, your project folder should look like this:

Linking our CSS with our HTML file

Our template.html is the one that links all pages. We can insert the code here and it will be applicable to all child pages.

    Flask Parent Template 

First Web App

  • Home
  • About
{% block content %} {% endblock %}

Line 7: Here we are giving the path to where the template.css is located.

Now see the changes: //localhost:5000/about.

Moving Forward with Flask and virtualenv

Now that you are familiar with using Flask, you may start using it in your future projects. One thing to always do is use virtualenv.

Why use virtualenv?

You may use Python for others projects besides web-development.

Your projects might have different versions of Python installed, different dependencies and packages.

We use virtualenv to create an isolated environment for your Python project. This means that each project can have its own dependencies regardless of what dependencies every other project has.

Getting started with virtualenv

First, run this command on your command prompt or terminal:

pip install virtualenv

Second, do the following:

virtualenv “name of virtual environment”

Here you can give a name to the environment. I usually give it a name of virtual. It will look like this: virtualenv virtual.

After setting up virtual environment, check your project folder. It should look like this. The virtual environment needs to be created in the same directory where your app files are located.

Activating the virtual environment

Now go to your terminal or command prompt. Go to the directory that contains the file called activate. The file called activate is found inside a folder called Scripts for Windows and bin for OS X and Linux.

For OS X and Linux Environment:

$ name of virtual environmnet/bin/activate

For Windows Environment:

name of virtual environment\Scripts\activate

Since I am using a Windows machine, when I activate the environment it will look like this:

The next step is to install flask on your virtual environment so that we can run the application inside our environment. Run the command:

pip install flask

Run your application and go to //localhost:5000/

We finally made our web application. Now we want to show the whole world our project.

(More information on virtualenv can be found in the following guides on virtualenv and Flask Official Documentation)

Let’s send it to the Cloud

To show others the project we made, we will need to learn how to use Cloud Services.

Deploy Your Web Application to the Cloud

To deploy our web application to the cloud, we will use Google App Engine (Standard Environment). This is an example of a Platform as a Service (PaaS).

PaaS fait référence à la fourniture de systèmes d'exploitation et de services associés sur Internet sans téléchargement ni installation . L'approche permet aux clients de créer et de déployer des applications sans avoir à investir dans l'infrastructure sous-jacente (plus d'informations sur PaaS consultez TechTarget).

Google App Engine est une plate-forme en tant qu'offre de service qui permet aux développeurs et aux entreprises de créer et d'exécuter des applications à l'aide de l'infrastructure avancée de Google - TechOpedia.

Avant de commencer:

Vous aurez besoin d'un compte Google . Une fois que vous avez créé un compte, accédez à la console Google Cloud Platform et créez un nouveau projet. Vous devez également installer le SDK Google Cloud.

À la fin de ce didacticiel, la structure de votre projet ressemblera à ceci.

We will need to create three new files: app.yaml, appengine_config.py, and requirements.txt.

Content of app.yaml:

runtime: python27 api_version: 1 threadsafe: true handlers: - url: /static static_dir: static - url: /.* script: main.app libraries: - name: ssl version: latest

If you were to check Google’s Tutorial in the part where they talk about content of the app.yaml, it does not include the section where I wrote about libraries.

When I first attempted to deploy my simple web app, my deployment never worked. After many attempts, I learned that we needed to include the SSL library.

The SSL Library allows us to create secure connections between the client and server. Every time the user goes to our website they will need to connect to a server run by Google App Engine. We need to create a secure connection for this. (I recently learned this, so if you have a suggestions for this let me know!)

Content of appengine_config.py:

from google.appengine.ext import vendor # Add any libraries installed in the "lib" folder. vendor.add('lib')

Content of requirements.txt:

Flask Werkzeug

Now inside our virtual environment (make sure your virtualenv is activated),we are going to install the new dependencies we have in requirements.txt. Run this command:

pip install -t lib -r requirements.txt

-t lib: This flag copies the libraries into a lib folder, which uploads to App Engine during deployment.

-r requirements.txt: Tells pip to install everything from requirements.txt.

Deploying the Application

To deploy the application to Google App Engine, use this command.

gcloud app deploy

I usually include — project [ID of Project]

This specifies what project you are deploying. The command will look like this:

gcloud app deploy --project [ID of Project]

The Application

Now check the URL of your application. The application will be store in the following way:

"your project id".appspot.com

My application is here: //sal-flask-tutorial.appspot.com

Conclusion

From this tutorial, you all learned how to:

  • Use the framework called Flask to use Python as a Server Side Language.
  • Learned how to use HTML, CSS, and Flask to make a website.
  • Learned how to create Virtual Environments using virtualenv.
  • Use Google App Engine Standard Environment to deploy an application to the cloud.

What I learned

I learned three important things from this small project.

First, I learned about the difference between a static website and a web application

Static Websites:

  • Means that the server is serving HTML, CSS, and JavaScript files to the client. The content of the site does not change when the user interacts with it.

Web Applications:

  • A web application or dynamic website generates content based on retrieved data (most of the time is a database) that changes based on a user’s interaction with the site. In a web application, the server is responsible for querying, retrieving, and updating data. This causes web applications to be slower and more difficult to deploy than static websites for simple applications (Reddit).

Server Side and Client Side:

  • I learned that a web application has two sides. The client side and the server side. The client side is what the user interacts with and the server side is where the all the information that the user inputted is processed.

Second, I learned about Cloud Services

Most of my previous projects were static websites, and to deploy them I used GitHub Pages. GitHub Pages is a free static site hosting service designed to host projects from a GitHub Repository.

When working with web applications, I could not use GitHub Pages to host them. GitHub Pages is only meant for static websites not for something dynamic like a web application that requires a server and a database. I had to use Cloud Services such as Amazon Web Services or Heroku

Third, I learned how to use Python as a Server Side Language

To create the server side of the web application we had to use a server side language. I learned that I could use the framework called Flask to use Python as the Server Side Language.

Next Steps:

You can build all sorts of things with Flask. I realized that Flask helps make the code behind the website easier to read. I have made the following applications during this summer of 2018 and I hope to make more.

Personal Projects

  • A Twilio SMS App
  • My Personal Website

During my internship

  • Part of a project where I learned about Docker and Containers

Here is the list of resources that helped me create this tutorial:

  • “App Engine — Build Scalable Web & Mobile Backends in Any Language | App Engine | Google Cloud.” Google, Google, cloud.google.com/appengine/.
  • “Building a Website with Python Flask.” PythonHow, pythonhow.com/building-a-website-with-python-flask/.
  • “Flask — Lecture 2 — CS50’s Web Programming with Python and JavaScript.” YouTube, 6 Feb. 2018, youtu.be/j5wysXqaIV8.
  • “Getting Started with Flask on App Engine Standard Environment | App Engine Standard Environment for Python | Google Cloud.” Google, Google, cloud.google.com/appengine/docs/standard/python/getting-started/python-standard-env.
  • “Installation.” Welcome | Flask (A Python Microframework), flask.pocoo.org/docs/0.12/installation/.
  • “Python — Deploying Static Flask Sites for Free on Github Pages.” Reddit, www.reddit.com/r/Python/comments/1iewqt/deploying_static_flask_sites_for_free_on_github/.
  • Real Python. “Python Virtual Environments: A Primer — Real Python.” Real Python, Real Python, 7 Aug. 2018, realpython.com/python-virtual-environments-a-primer/.
  • “What Is Cloud Services? — Definition from WhatIs.com.” SearchITChannel, searchitchannel.techtarget.com/definition/cloud-services.
  • “What Is Google App Engine (GAE)? — Definition from Techopedia.” Techopedia.com, www.techopedia.com/definition/31267/google-app-engine-gae.

If you have any suggestions or questions, feel free to leave a comment.