Liwaiwai Liwaiwai
  • /
  • Artificial Intelligence
  • Machine Learning
  • Robotics
  • Engineering
    • Architecture
    • Design
    • Software
    • Hybrid Cloud
    • Data
  • About
  • /
  • Artificial Intelligence
  • Machine Learning
  • Robotics
  • Engineering
    • Architecture
    • Design
    • Software
    • Hybrid Cloud
    • Data
  • About
Liwaiwai Liwaiwai
  • /
  • Artificial Intelligence
  • Machine Learning
  • Robotics
  • Engineering
    • Architecture
    • Design
    • Software
    • Hybrid Cloud
    • Data
  • About
  • Programming

How To: Create A Flask/API Project In Ubuntu

  • April 6, 2019
  • admin

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.


Partner with liwaiwai.com
for your next big idea.
Let us know here.


cyberpogo

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)

 

Read More  How To: Install Python 3.7 In Windows

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

Our humans need coffee too! Your support is highly appreciated, thank you!

admin

Related Topics
  • API
  • Flask
  • How To
  • Python
  • Ubuntu
You May Also Like
View Post
  • Artificial Intelligence
  • Programming

How To Build An AI-generated Procedural Application

  • May 22, 2023
View Post
  • Data
  • Programming
  • Software

The Top 10 Data Interchange Or Data Exchange Format Used Today

  • May 17, 2023
View Post
  • Artificial Intelligence
  • Machine Learning
  • Programming

Running ML Models Now Easier With New Dataflow ML Innovations On Apache Beam

  • May 4, 2023
View Post
  • Programming
  • Technology

From The Field: A Programming Requirement for Structural Analysis Computations. To Java or To Javascript.

  • May 3, 2023
View Post
  • Artificial Intelligence
  • Automation
  • Programming
  • Programming Languages

Speak The Language Of The Future! Here Are The Top 10 Programming Languages For AI

  • May 2, 2023
View Post
  • Artificial Intelligence
  • Programming

PromptOps In application Delivery: Empowering Your Workflow with ChatGPT

  • April 30, 2023
View Post
  • Artificial Intelligence
  • Programming
  • Software

Bard Now Helps You Code

  • April 24, 2023
View Post
  • Machine Learning
  • Programming
  • Software Engineering

10 Best Python Machine Learning Tutorials

  • February 14, 2023

Leave a Reply

Your email address will not be published. Required fields are marked *

Stay Connected!
LATEST
  • Data | Points | Binary 1
    Microsoft Offers Azure ML Data Import CLI, SDK For Snowflake, Other Databases
    • June 9, 2023
  • Classification | Binder 2
    Build An Image Data Classification Model With BigQuery ML
    • June 9, 2023
  • 3
    H.I. To Gaia. Connecting Hyperintelligence With The Earth.
    • June 8, 2023
  • 4
    Why Are Humans Afraid Of AI?
    • June 8, 2023
  • 5
    The Geography Of Artificial Intelligence
    • June 8, 2023
  • 6
    Nature Already Inspired A.I. Than Most Realise
    • June 8, 2023
  • 7
    “A Field Guide To AI: For Business, Institutions, Society & Political Economy” — Your Essential Companion In Navigating the World of Artificial Intelligence.
    • June 7, 2023
  • 8
    Predictions: Top 25 Careers Likely In High Demand In The Future
    • June 6, 2023
  • 9
    A S.W.O.T. Analysis Of Current A.I. Systems
    • June 6, 2023
  • Apple-WWCD23-Vision-Pro-glass-230605 10
    Introducing Apple Vision Pro: Apple’s first spatial computer
    • June 6, 2023

about
About
Hello World!

We are liwaiwai.com. Created by programmers for programmers.

Our site aims to provide materials, guides, programming how-tos, and resources relating to artificial intelligence, machine learning and the likes.

We would like to hear from you.

If you have any questions, enquiries or would like to sponsor content, kindly reach out to us at:

[email protected]

Live long & prosper!
Most Popular
  • 1
    Apple Unveils New Mac Studio And Brings Apple Silicon To Mac Pro
    • June 5, 2023
  • 2
    Apple Introduces M2 Ultra
    • June 5, 2023
  • 3
    tvOS 17 Brings FaceTime And Video Conferencing To The Biggest Screen In The Home
    • June 5, 2023
  • 4
    Apple Introduces The 15‑Inch MacBook Air
    • June 5, 2023
  • 5
    CrowdStrike Introduces Charlotte AI To Deliver Generative AI-Powered Cybersecurity
    • May 30, 2023
  • /
  • Artificial Intelligence
  • Explore
  • About
  • Contact Us

Input your search keywords and press Enter.