dotlah! dotlah!
  • Cities
  • Technology
  • Business
  • Politics
  • Society
  • Science
  • About
Social Links
  • zedreviews.com
  • citi.io
  • aster.cloud
  • liwaiwai.com
  • guzz.co.uk
  • atinatin.com
0 Likes
0 Followers
0 Subscribers
dotlah!
  • Cities
  • Technology
  • Business
  • Politics
  • Society
  • Science
  • About
  • Technology

How To: Create A Flask/API Project In Ubuntu

  • April 6, 2019
Total
0
Shares
0
0
0

Prerequisites

  • Operating System: Ubuntu 16 or Ubuntu 18
  • Python 3.X is installed
  • Python Pip is installed
  • Python Virtual Environment is installed (Optional)

 

Structure Overview

|__ dotlah_flask_api
    |__ api
        |__ res
            |__ __init__.py
            |__ application_res.py
        |__ __init__.py
    |__ app_wsgi.py
    |__ runserver.py
    |__ requirements.txt
    |__ README.md

Replace the dotlah_flask_api directory with the project name of your choice.

Steps

01. Create the necessary directories and files. You can use the following shell script to create it, or manually enter them in the terminal, or create them from another way.

$ cd ~ 
$ nano setup-flask-api.sh 

 

#!/bin/bash
mkdir $1
mkdir -p $1/api/res

touch $1/api/res/__init__.py
touch $1/api/res/application_res.py
touch $1/app_wsgi.py
touch $1/runserver.py
touch $1/requirements.txt
touch $1/README.md

 

02.  Run the setup script.

# FORMAT
$ sh setup-flask-api.sh <project-name-without-space> 

# SAMPLE 
$ sh setup-flask-api.sh dotlah_flask_api 

 

While it is totally safe to create a Project with spaces, it is more of a standard in this case.

 

03. Navigate to the Project directory

# FORMAT 
$ cd <project-name-without-space> 

# SAMPLE 
$ cd dotlah_flask_api 

 

04. Update the necessary Python library/packages by setting the value of the requirements.txt

$ nano requirements.txt 

 

Set the value:

flask 

 

05. (Optional but recommended). Create a virtual environment dedicated to the Flask/API project.

For instructions on how to install and configure virtual environment. See this guide.

# FORMAT 

# SAMPLE 
$ cd dotlah_flask_api 
$ python3 -m venv project-venv 

 

06. Activate the Virtual Environment.

$ source project-venv/bin/activate  

 

07. Install the flask library via Pip using the requirements.txt

(project-venv) $ pip install -r requirements.txt 

 

08. Update the content of runserver.py.

(project-venv) $ nano runserver.py 

 

# -*- coding: utf-8 -*-

# Start Flask with default web server
from api import application

application.run(host='127.0.0.1', port=8888, debug=True)

 

09.  Update the dunder python file.

(project-venv) $ nano api/__init__.py 

 

This imports the res python module, the endpoints will be located at the application_res or other res (Resource) python file.

from flask import Flask 

application = Flask(__name__) 

import api.res.application_res 

 

10.  Update the application_res.py.

(project-venv) $ nano api/res/application_res.py 

 

# -*- coding: utf-8 -*-

from flask import jsonify
from api import application

@application.route('/', methods=['GET'])
def get_app_properties():
name = 'dotlah-flask-api'
version = '0.0.1'

app_properties = \
{
  'name' : name
  , 'version' : version
}

return jsonify(app_properties)

 

Above will create a GET endpoint accessible by the root path, (/).

11. Run the application

(project-venv) $ python runsever.py 

 

It should show something similar

Note that running the application via this way (runserver.py) should only be used on local development. If needed to deploy on a Web Application server, a middleware or WSGI server should be used instead.

 

12. Test the application on the browser or via CURL.

Via Curl (open another terminal session)

$ curl http://localhost:8888

 

Via Browser

http://localhost:8888
Total
0
Shares
Share
Tweet
Share
Share
Related Topics
  • API
  • Flask
  • How To
  • Python
  • Ubuntu
majulah

Previous Article
  • Technology

How To: Configure Python Virtual Environment In Ubuntu

  • April 6, 2019
View Post
Next Article
  • Science

Statistics For Dummies: A Quick Guide On Probability Axioms

  • April 25, 2019
View Post
You May Also Like
View Post
  • Gears
  • Technology

Meet Samsung Galaxy Tab S11 Series: Packing Everything You Expect From a Premium Tablet

  • Dean Marc
  • September 4, 2025
View Post
  • Technology

Malaysia’s ‘ASEAN Shenzhen’ needs some significant legal reform to take off — here’s how

  • dotlah.com
  • August 25, 2025
View Post
  • Gears
  • Technology

Samsung Electronics Debuts Odyssey G7 Monitors, Showcasing Top Games on Its Displays at Gamescom 2025

  • Dean Marc
  • August 20, 2025
View Post
  • Artificial Intelligence
  • Technology

Thoughts on America’s AI Action Plan

  • Dean Marc
  • July 24, 2025
View Post
  • Technology

ESWIN Computing launches the EBC77 Series Single Board Computer with Ubuntu

  • dotlah.com
  • July 17, 2025
View Post
  • Gears
  • Technology

Samsung Galaxy Z Fold7: Raising the Bar for Smartphones

  • Dean Marc
  • July 9, 2025
View Post
  • Cities
  • Technology

Meralco PowerGen’s PacificLight starts up 100 MW fast-response plant in Singapore

  • dotlah.com
  • June 20, 2025
View Post
  • Technology

Apple services deliver powerful features and intelligent updates to users this autumn

  • Dean Marc
  • June 12, 2025


Trending
  • 1
    • Lah!
    NTU Singapore Maintains Its Place Among The World’s Best Universities
    • June 11, 2020
  • 2
    • Artificial Intelligence
    • Machine Learning
    • Technology
    Apple supercharges its tools and technologies for developers to foster creativity, innovation, and design
    • June 11, 2025
  • countries-with-the-highest-cost-of-living-plus-rent-index-in-2020-25862 3
    • Cities
    Where Living Is the Most Expensive
    • September 29, 2021
  • 4
    • Cities
    • Technology
    How Tech Is Changing The Way Singapore Manages Parks And Gardens
    • May 15, 2019
  • workplace 5
    • Business
    • People
    Simple Tips That Will Help Protect Your Rights In The Office
    • January 13, 2021
  • 6
    • Engineering
    • People
    • Technology
    Three MIT Alumni Graduate From NASA Astronaut Training
    • March 8, 2024
  • prince-harry-spare 7
    • Books
    • Features
    • People
    Spare – Prince Harry’s Tell-All Memoir Shows The Royal Family In A Different Light
    • January 7, 2023
  • 8
    • Cities
    Traffic Congestion Reconsidered
    • November 7, 2019
  • 9
    • People
    Pope Benedict XVI: A man at odds with the modern world who leaves a legacy of intellectual brilliance and controversy
    • January 1, 2023
  • 10
    • Computing
    • People
    • Technology
    IBM And Top Universities To Advance Quantum Education For 40,000 Students In Japan, South Korea, And The United States
    • December 13, 2023
  • fluid-intelligence_feature 11
    • Features
    • People
    • Technology
    Fluid Intelligence. The Brain’s Slippery Secret to Solving the Puzzle of Life!
    • June 27, 2023
  • Prince Harry has said his problem is with the press, not his family. But the two can’t be separated | PA Images / Alamy Stock Photo 12
    • People
    The Monarchy And Media Are Trapped In A Mutually Dependent Relationship
    • January 10, 2023
Trending
  • Smart Watch 1
    Best Smartwatches, Your Gateway to Health Monitoring and Everyday Use
    • October 5, 2025
  • Cooking pots and pans 2
    Best Pots and Pans 2025: All-Season, All-Purpose Picks for Every Kitchen
    • September 23, 2025
  • 3
    Politicians love comparing NZ’s economy to Singapore or Ireland – but it’s simplistic and misleading
    • September 21, 2025
  • Kitchen Knives - Best All-Around Picks in 2025 4
    Kitchen Knives : The Surgeons of Cooking – Best All-Around Picks in 2025
    • September 15, 2025
  • 5
    Apple unveils iPhone 17 Pro and iPhone 17 Pro Max, the most powerful and advanced Pro models ever
    • September 9, 2025
  • 6
    Apple debuts iPhone 17
    • September 9, 2025
  • Fruits and vegetables for cooking. For food processors. 7
    Food Processor: The Swiss Army Knife of the Kitchen – Best All-Around Picks in 2025
    • September 8, 2025
  • 8
    Meet Samsung Galaxy Tab S11 Series: Packing Everything You Expect From a Premium Tablet
    • September 4, 2025
  • 9
    Malaysia’s ‘ASEAN Shenzhen’ needs some significant legal reform to take off — here’s how
    • August 25, 2025
  • French Fries 10
    Air Fryer: The One Cooking Appliance to Rule Them All – Best All-Around Picks in 2025
    • August 22, 2025
Social Links
dotlah! dotlah!
  • Cities
  • Technology
  • Business
  • Politics
  • Society
  • Science
  • About
Connecting Dots Across Asia's Tech and Urban Landscape

Input your search keywords and press Enter.