aster.cloud aster.cloud
  • /
  • Platforms
    • Public Cloud
    • On-Premise
    • Hybrid Cloud
    • Data
  • Architecture
    • Design
    • Solutions
    • Enterprise
  • Engineering
    • Automation
    • Software Engineering
    • Project Management
    • DevOps
  • Programming
    • Learning
  • Tools
  • About
  • /
  • Platforms
    • Public Cloud
    • On-Premise
    • Hybrid Cloud
    • Data
  • Architecture
    • Design
    • Solutions
    • Enterprise
  • Engineering
    • Automation
    • Software Engineering
    • Project Management
    • DevOps
  • Programming
    • Learning
  • Tools
  • About
aster.cloud aster.cloud
  • /
  • Platforms
    • Public Cloud
    • On-Premise
    • Hybrid Cloud
    • Data
  • Architecture
    • Design
    • Solutions
    • Enterprise
  • Engineering
    • Automation
    • Software Engineering
    • Project Management
    • DevOps
  • Programming
    • Learning
  • Tools
  • About
  • DevOps
  • Programming

How To: Create A Flask / API Project In Windows

  • root
  • May 24, 2019
  • 1 minute read

Prerequisites

  • Operating System: Windows 7 and above
  • Python 3.7 or greater installed
  • Python Pip is installed
  • Python Virtual Environment is installed (Optional)

 

Structure Overview


|__ geek_flask_api

  |__ api

    |__ res

      |__ __init__.py

      |__ application_res.py

    |__ __init__.py

  |__ app_wsgi.py

  |__ runserver.py

  |__ requirements.txt

  |__ README.md

 


Partner with aster.cloud
for your next big idea.
Let us know here.



From our partners:

CITI.IO :: Business. Institutions. Society. Global Political Economy.
CYBERPOGO.COM :: For the Arts, Sciences, and Technology.
DADAHACKS.COM :: Parenting For The Rest Of Us.
ZEDISTA.COM :: Entertainment. Sports. Culture. Escape.
TAKUMAKU.COM :: For The Hearth And Home.
ASTER.CLOUD :: From The Cloud And Beyond.
LIWAIWAI.COM :: Intelligence, Inside and Outside.
GLOBALCLOUDPLATFORMS.COM :: For The World's Computing Needs.
FIREGULAMAN.COM :: For The Fire In The Belly Of The Coder.
ASTERCASTER.COM :: Supra Astra. Beyond The Stars.
BARTDAY.COM :: Prosperity For Everyone.

Steps

01. Create the necessary directories and files.


|__ geek_flask_api

  |__ api

    |__ res

      |__ __init__.py

      |__ application_res.py

    |__ __init__.py

  |__ app_wsgi.py

  |__ runserver.py

  |__ requirements.txt

  |__ README.md

 

02. Update the necessary Python library/packages by setting the value of the geek_flask_api\requirements.txt


flask

 

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

For instructions on how to install and configure virtual environment. Check this post.


$ cd ~

$ cd geek_flask_api

$ virtualenv geek-python-venv

The directory structure should look something like below

 

04. Activate the Virtual Environment.


# Need to execute this beforehand to enable to run activate shell script

$ Set-ExecutionPolicy Unrestricted -Force

$ .\geek-python-venv\Scripts\activate.ps1

Notice that the command prompt has changed to include virtual environment

 

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


(geek-python-venv) $ pip install -r .\requirements.txt

 

06. Update the content of geek_flask_api\runserver.py using the editor of your choice and set the content as follows


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

# Start Flask with default web server

from api import application

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

 

07.Update the dunder geek_flask_api\api\__init__.py python file. 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

 

08. Update the geek_flask_api\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 = 'geek-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, (/).

Read More  How To Validate Kubernetes YAML Files

 

09. Run the application


(geek-python-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.

 

10. Test the application on the browser.


http://localhost:8888


For enquiries, product placements, sponsorships, and collaborations, connect with us at [email protected]. We'd love to hear from you!

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

root

Related Topics
  • Flask
  • How To
  • Python
You May Also Like
DevOps artifact management
View Post
  • Design
  • DevOps
  • Engineering

10 Awesome Benefits Of Artifact Management And Why You Need It

  • August 2, 2023
Automation | Gears
View Post
  • Automation
  • DevOps
  • Engineering

Automating CI/CD With GitHub Actions

  • June 13, 2023
View Post
  • Architecture
  • Data
  • Engineering
  • People
  • Programming
  • Software Engineering
  • Technology

Predictions: Top 25 Careers Likely In High Demand In The Future

  • June 6, 2023
View Post
  • DevOps
  • People

What’s The Future Of DevOps? You Tell Us. Take The 2023 Accelerate State Of DevOps Survey

  • June 2, 2023
View Post
  • Programming
  • Software Engineering
  • Technology

Build a Python App to Alert You When Asteroids Are Close to Earth

  • May 22, 2023
View Post
  • Programming

Illuminating Interactions: Visual State In Jetpack Compose

  • May 20, 2023
View Post
  • Computing
  • Data
  • Programming
  • Software
  • Software Engineering

The Top 10 Data Interchange Or Data Exchange Format Used Today

  • May 11, 2023
View Post
  • Cloud-Native
  • DevOps
  • Software

7 Ways To Turn Developer Experience Into A Competitive Edge

  • May 10, 2023

Stay Connected!
LATEST
  • OpenAI 1
    How We Interact With Information: The New Era Of Search
    • September 28, 2023
  • 2
    Bring AI To Looker With The Machine Learning Accelerator
    • September 28, 2023
  • 3
    How ‘Anything Is Possible’ Automated Data Pipelines With BigQuery And Windsor.ai
    • September 27, 2023
  • 4
    Artificial Intelligence, AI, Generative AI, Mercy, Azure OpenAI Service,
    • September 27, 2023
  • 5
    Oracle CloudWorld 2023: 6 Key Takeaways From The Big Annual Event
    • September 25, 2023
  • 6
    Nvidia H100 Tensor Core GPUs Come To Oracle Cloud
    • September 24, 2023
  • 7
    Combining AI With A Trusted Data Approach On IBM Power To Fuel Business Outcomes
    • September 21, 2023
  • 8
    Start Your Ubuntu Confidential VM With Intel® TDX On Google Cloud
    • September 20, 2023
  • Microsoft and Adobe 9
    Microsoft And Adobe Partner To Deliver Cost Savings And Business Benefits
    • September 20, 2023
  • Coffee | Laptop | Notebook | Work 10
    First HP Work Relationship Index Shows Majority of People Worldwide Have an Unhealthy Relationship with Work
    • September 20, 2023
about
Hello World!

We are aster.cloud. We’re created by programmers for programmers.

Our site aims to provide guides, programming tips, reviews, and interesting materials for tech people and those who want to learn in general.

We would like to hear from you.

If you have any feedback, enquiries, or sponsorship request, kindly reach out to us at:

[email protected]
Most Popular
  • 1
    Oracle Expands Distributed Cloud Offerings to Help Organizations Innovate Anywhere
    • September 20, 2023
  • 2
    Huawei Connect 2023: Accelerating Intelligence For Shared Success
    • September 20, 2023
  • 3
    Huawei Releases Data Center 2030, Leading Innovation and Development of New Data Centers
    • September 20, 2023
  • Penguin 4
    How To Find And Fix Broken Packages On Linux
    • September 19, 2023
  • Volkswagen 5
    Volkswagen Races Toward Next-Gen Automotive Manufacturing Leadership With Google Cloud And T-Systems
    • September 19, 2023
  • /
  • Technology
  • Tools
  • About
  • Contact Us

Input your search keywords and press Enter.