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!
    Air Pollution Drives Residential Electricity Demand
    • August 18, 2020
  • 2
    • Cities
    • Lah!
    • Society
    Cashiers Need To Be Compensated With Wage Premium To Handle Cash Payments: NUS Study
    • August 27, 2021
  • 3
    • Cities
    • Lah!
    IMDA Collaborates With Industry To Help Singaporeans Continue To Enjoy A High Quality Of Life From Home With Digital Tech Amid COVID-19
    • March 26, 2020
  • 4
    • Science
    • Society
    An Indian Company Is Gearing Up To Make Millions Of Doses Of A $3 Covid-19 Vaccine
    • August 13, 2020
  • 5
    • People
    Eliminating Modern Slavery: A Call For Deliberate And Collective Action
    • July 27, 2023
  • where-american-city-dwellers-lack-access-to-running-water-23731 6
    • Cities
    Where American City-Dwellers Lack Access To Running Water
    • December 10, 2020
  • 7
    • Lah!
    • Technology
    Four Key Takeaways From The SIEW Energy Insights Sessions
    • October 31, 2019
  • 8
    • Cities
    • Technology
    UOB Ramps Up Digital Innovation To Grow Its Wealth Management Franchise Across ASEAN
    • June 28, 2021
  • 9
    • People
    Nobel Peace Prize 2023: Award For Iranian Women’s Rights Protester Highlights Fight Against Declining Democracy Around The World
    • October 8, 2023
  • 10
    • Cities
    Urban Redevelopment Authority (URA) Updates Online Geospatial Map With More Comprehensive Information
    • October 3, 2017
  • 11
    • Technology
    ST Engineering And Wilhelmsen Ships Service To Collaborate On Developing Unmanned Aerial Operations For Shore-to-Ship Parcel Deliveries
    • February 12, 2020
  • 12
    • Cities
    • Lah!
    How The Government Is Building Citizen-Centric Digital Services
    • March 7, 2019
Trending
  • 1
    Apple unveils iPhone 17 Pro and iPhone 17 Pro Max, the most powerful and advanced Pro models ever
    • September 9, 2025
  • 2
    Apple debuts iPhone 17
    • September 9, 2025
  • Fruits and vegetables for cooking. For food processors. 3
    Food Processor: The Swiss Army Knife of the Kitchen – Best All-Around Picks in 2025
    • September 8, 2025
  • 4
    Meet Samsung Galaxy Tab S11 Series: Packing Everything You Expect From a Premium Tablet
    • September 4, 2025
  • 5
    Malaysia’s ‘ASEAN Shenzhen’ needs some significant legal reform to take off — here’s how
    • August 25, 2025
  • French Fries 6
    Air Fryer: The One Cooking Appliance to Rule Them All – Best All-Around Picks in 2025
    • August 22, 2025
  • 7
    Samsung Electronics Debuts Odyssey G7 Monitors, Showcasing Top Games on Its Displays at Gamescom 2025
    • August 20, 2025
  • 8
    HP Cranks Up the Game with Smarter Systems, Cooler Builds, and Gear That Hits Different
    • August 14, 2025
  • 9
    New Trump tariffs: early modelling shows most economies lose – the US more than many
    • August 6, 2025
  • Scuba Diving 10
    Wetsuit or Drysuit? As always, it depends. This quick guide can help you choose.
    • August 2, 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.