{ "cells": [ { "attachments": {}, "cell_type": "markdown", "metadata": { "colab_type": "text", "id": "view-in-github" }, "source": [ "\"Open" ] }, { "attachments": {}, "cell_type": "markdown", "metadata": { "id": "S1QkB4XbClXs" }, "source": [ "# 7. Create a Simple Flask App \n", "\n", "```{note} You can clone the source code [here](https://github.com/byambaa1982/python_cources_for_beginers/tree/main/Mini%20Project%202)\n", "```\n", "`Flask` is a micro web framework written in Python. It's considered a micro framework because it does not require particular tools or libraries, but it's expandable and can support complex applications as well. It has a very small and easy-to-understand code base, and provides only a few essential components out of the box, such as routing, request handling, and HTML templating. However, it's highly extensible and allows you to add more functionality through extensions and libraries, including database integration, form validation, authentication, and more.\n", "\n", "Here's why you might want to choose Flask for your web development project:\n", "\n", "1. `Simplicity and Ease of Use`: Flask is very simple to set up and use. It's a good choice if you're new to web development, if you're a solo developer, or if you're working on a small project. The Flask documentation is very comprehensive and easy to understand.\n", "\n", "2. `Flexibility`: Flask is very flexible. It doesn't make many decisions for you, which means you have the freedom to structure your application however you like and use whatever libraries or tools you prefer. This is a contrast to more \"batteries-included\" frameworks, like Django, which come with more built-in tools but are also more prescriptive.\n", "\n", "3. `Lightweight`: Flask is lightweight and has a small footprint, meaning it uses less system resources and can run efficiently on small servers.\n", "\n", "4. `Extensibility`: Even though Flask is lightweight and simple, it can be extended with various extensions to add functionalities such as SQL databases, authentication, form handling, and more. This makes it a good choice for both simple and complex projects.\n", "\n", "5. `Community and Ecosystem`: Flask has a large and active community of developers, so it's easy to find help when you need it. There are many tutorials, guides, and examples available, as well as a large number of libraries and extensions.\n", "\n", "6. `Integration with Python ecosystem`: Since Flask is a Python framework, you have access to the vast Python ecosystem and all its libraries for tasks such as data analysis, machine learning, and more.\n", "\n", "Overall, Flask provides a nice balance between simplicity, flexibility, and power, which makes it a popular choice for web development in Python.\n", "Creating a Flask application usually requires two primary files: an app.py file which will contain your application's code, and a requirements.txt file to list any dependencies your application might have. In this case, our Flask application will be very basic and will just display a \"Hello, World!\" message when someone accesses it.\n", "\n", "```\n", "python_cources_for_beginners/\n", "└── Mini Project 2/\n", " ├── requirements.txt\n", " └── app.py\n", "\n", "```\n", "\n", "Here's what those files might look like:\n", "\n", "
\n", "\n", "1. `app.py`:\n", "\n", "``` python\n", "from flask import Flask\n", "app = Flask(__name__)\n", "\n", "@app.route('/')\n", "def hello_world():\n", " return 'Hello, World!'\n", "\n", "if __name__ == '__main__':\n", " app.run(debug=True)\n", "\n", "```\n", "
\n", "\n", "This is a very simple Flask application. The `app = Flask(__name__)` line creates an instance of the Flask class for our application. The `@app.route('/')` line is a decorator that Flask provides to route web requests to particular functions. The hello_world function is mapped to the root URL ('/') and returns the string `'Hello, World!'`. Finally, `app.run(debug=True)` runs the application (in debug mode in this case).\n", "\n", "
\n", "2. `requirements.txt`: \n", "\n", "```python\n", "Flask ==2.0.1\n", "```\n", "
\n", "\n", "This file lists Flask as a dependency for our application. This is useful if we're sharing our code with others or deploying it to a production environment. Someone can use the command `pip install -r requirements.txt` to install all the dependencies listed in this file.\n", "\n", "Please replace `Flask==2.0.1` with the version of Flask we are currently using.\n", "\n", "We can run the application locally by using the terminal and typing `python app.py`, assuming you have Python and Flask installed. We can see output telling us that a server is running locally, and we can access it by opening a web browser and navigating to `http://127.0.0.1:5000/` or `http://localhost:5000/`. We should see 'Hello, World!' displayed." ] }, { "attachments": {}, "cell_type": "markdown", "metadata": { "id": "gtZe_w8RD08A" }, "source": [ "## Render HTML content in Flask\n", "\n", " To render HTML content in Flask, we typically use templates. Flask configures the Jinja2 template engine by default. Let's add an HTML file to our project:\n", "\n", "First, create a new directory named `templates` in our project's root directory. Flask looks for templates in this directory by default.\n", "\n", "Then, create a new HTML file in this directory. Let's call it `index.html`:\n", "\n", "```html\n", "\n", "\n", "\n", " \n", " Hello, World!\n", " \n", " \n", "

{{ message }}

\n", " \n", "\n", "\n", "\n", "```\n", "\n", "In this HTML file, `{{ message }}` is a placeholder for a variable that we'll pass from your Flask application.\n", "\n", "
\n", "\n", "3. Now, we need to update our `app.py` file to use this template:\n", "\n", "
\n", "\n", "```python\n", "from flask import Flask, render_template\n", "app = Flask(__name__)\n", "\n", "@app.route('/')\n", "def hello_world():\n", " return render_template('index.html', message='Hello, World!')\n", "\n", "if __name__ == '__main__':\n", " app.run(debug=True)\n", "\n", "```\n", "\n", "
\n", "
\n", "\n", "In this updated `app.py file`, `render_template('index.html', message='Hello, World!')` tells Flask to find a template called index.html and fill in the `{{ message }}` placeholder with 'Hello, World!'." ] }, { "attachments": {}, "cell_type": "markdown", "metadata": { "id": "7oe7AVJ0Eo9a" }, "source": [ "4. We don't need to change our `requirements.txt` file, as Flask includes the Jinja2 template engine by default.\n", "When we run our application and visit `http://127.0.0.1:5000/` or `http://localhost:5000/`, we should now see our message ('Hello, World!') displayed as an H1 heading on an HTML page." ] }, { "attachments": {}, "cell_type": "markdown", "metadata": { "id": "sO9ulTUVFDKf" }, "source": [ "## Flask Form\n", "\n", "We can create a form in a new HTML file, and then we'll write a Flask route and function to handle form submissions. We'll convert the submitted text to lowercase, as you've requested. Here's how:\n", "\n", "
\n", "\n", "1. First, create a new HTML file in our `templates` directory. Let's call it `form.html`:\n", "\n", "\n", "```html\n", "\n", "\n", " \n", " Submit Text\n", " \n", " \n", "
\n", "
\n", "
\n", " \n", "
\n", " \n", "\n", "\n", "```\n", "
\n", "\n", "This file contains a form that sends a POST request when submitted. The form includes a text input where users can enter their text." ] }, { "attachments": {}, "cell_type": "markdown", "metadata": { "id": "QczcXyhfPAjn" }, "source": [ "2. Next, we need to update our `app.py` file to include a new route and function for displaying the form and handling form submissions:\n", "\n", "```python\n", "\n", "from flask import Flask, render_template, request\n", "app = Flask(__name__)\n", "\n", "@app.route('/')\n", "def hello_world():\n", " return render_template('index.html', message='Hello, World!')\n", "\n", "@app.route('/form', methods=['GET', 'POST'])\n", "def render_form():\n", " if request.method == 'POST':\n", " text = request.form.get('text')\n", " return render_template('index.html', message=text.lower())\n", " return render_template('form.html')\n", "\n", "if __name__ == '__main__':\n", " app.run(debug=True)\n", "\n", "```\n", "\n", "In this updated `app.py` file, we've added a new route for '/form'. If the request method is 'POST' (which means the form is being submitted), we get the submitted text, convert it to lowercase, and then pass it to our `index.html` template. If the request method is 'GET' (which is the default method when a user visits the page), we just display the form.\n", "\n", "Now, if you run your application and visit `http://127.0.0.1:5000/form` or `http://localhost:5000/form`, you should see the form. If you submit some text, you should then see your submitted text displayed in lowercase on a new page." ] }, { "attachments": {}, "cell_type": "markdown", "metadata": { "id": "3S84LELmPirz" }, "source": [ "## Add CSS file to flask\n", "\n", "Let's add some CSS to make our application look nicer.\n", "\n", "1. First, create a new directory named static in your project's root directory. Flask serves static files (like CSS files) from this directory.\n", "\n", "2. Then, create a new CSS file in this directory. Let's call it style.css:\n", "\n", "```css\n", "body {\n", " background-color: #f0f0f0;\n", " font-family: Arial, sans-serif;\n", " padding: 30px;\n", "}\n", "\n", "form {\n", " background-color: #fff;\n", " padding: 20px;\n", " border-radius: 5px;\n", " max-width: 600px;\n", " margin: 0 auto;\n", "}\n", "\n", "input[type=\"text\"] {\n", " width: 100%;\n", " padding: 10px;\n", " margin: 10px 0;\n", " box-sizing: border-box;\n", "}\n", "\n", "input[type=\"submit\"] {\n", " background-color: #4CAF50;\n", " color: white;\n", " padding: 10px 20px;\n", " border: none;\n", " border-radius: 4px;\n", " cursor: pointer;\n", "}\n", "\n", "input[type=\"submit\"]:hover {\n", " background-color: #45a049;\n", "}\n", "\n", "h1 {\n", " text-align: center;\n", "}\n", "\n", "```\n", "\n", "This CSS file includes some styles to make our application look a little nicer.\n", "\n", "3. Next, we need to update our HTML files to include this CSS file:\n", "`index.html`:\n", "\n", "\n", "```html\n", "\n", "\n", " \n", " Hello, World!\n", " \n", " \n", " \n", "

{{ message }}

\n", " \n", "\n", "\n", "```\n", "\n", "`form.html`:\n", "\n", "```html\n", "\n", "\n", " \n", " Submit Text\n", " \n", " \n", " \n", "
\n", "
\n", "
\n", " \n", "
\n", " \n", "\n", "\n", "```\n", "\n", "In each HTML file, the line `` tells Flask to include our CSS file.\n", "\n", "Now, if we run our application and visit `http://127.0.0.1:5000/` or `http://localhost:5000/form`, we should see our pages styled with the CSS we've created." ] }, { "attachments": {}, "cell_type": "markdown", "metadata": { "id": "hwcyNpPgQghY" }, "source": [ " We can return the text on the page under the form. We will need to modify the `form.html` and `app.py` files.\n", "\n", " 1. `form.html`:\n", "\n", " ```html\n", "\n", "\n", " \n", " Submit Text\n", " \n", " \n", " \n", "
\n", "
\n", "
\n", " \n", "
\n", " {% if message %}\n", "
\n", "

Submitted Text (in lowercase):

\n", "

{{ message }}

\n", "
\n", " {% endif %}\n", " \n", "\n", "\n", " ```\n", "\n", " In this file, `{% if message %}`...`{% endif %}` is a conditional statement in Jinja2 template engine that checks if the `message` variable exists. If it does, it displays a div containing the submitted text.\n", "\n", "\n", " 2. `app.py`:\n", "\n", "\n", " ```python\n", "\n", "from flask import Flask, render_template, request\n", "app = Flask(__name__)\n", "\n", "@app.route('/')\n", "def hello_world():\n", " return render_template('index.html', message='Hello, World!')\n", "\n", "@app.route('/form', methods=['GET', 'POST'])\n", "def render_form():\n", " message = ''\n", " if request.method == 'POST':\n", " text = request.form.get('text')\n", " message = text.lower()\n", " return render_template('form.html', message=message)\n", "\n", "if __name__ == '__main__':\n", " app.run(debug=True)\n", "\n", "```\n", "\n", "In this updated `app.py` file, we've moved the `render_template` function out of the if statement. Now, it runs whether the request method is 'GET' or 'POST'. When the method is 'POST', we get the submitted text, convert it to lowercase, and pass it to our `form.html` template as the `message` variable. When the method is 'GET', we pass an empty string as the `message` variable.\n", "\n", "Upon the completion of this project, our Flask application will have the capability to accept user input through a form. This user-submitted text can be processed in three distinct ways, determined by the selection of one of three buttons: transforming the text to all uppercase, converting it to all lowercase, or computing the word count of the input. This interactive functionality will be seamlessly integrated into our application through the use of CSS for styling and HTML for structuring our web pages.\n", "\n", "```\n", "python_cources_for_beginners/\n", "├── images/\n", "│ ├── flask_page.png\n", "└── Mini Project 2/\n", " ├── static/\n", " │ ├── images/\n", " │ │ ├── flask_page.png\n", " │ └── style.css\n", " ├── templates/\n", " │ ├── form.html\n", " │ └── index.html\n", " └── app.py\n", "\n", "```\n", "\n", "```{figure} /images/flask_page.png\n", ":name: web\n", "web page\n", "```" ] } ], "metadata": { "colab": { "include_colab_link": true, "provenance": [] }, "kernelspec": { "display_name": "Python 3", "name": "python3" }, "language_info": { "name": "python" } }, "nbformat": 4, "nbformat_minor": 0 }