How to run a flask application?
you just need to run this command
python app.py
(app.py is your desire flask file)
but make sure your .py file has the following flask settings(related to port and host)
from flask import Flask, request
from flask_restful import Resource, Api
import sys
import os
app = Flask(__name__)
api = Api(app)
port = 5100
if sys.argv.__len__() > 1:
port = sys.argv[1]
print("Api running on port : {} ".format(port))
class topic_tags(Resource):
def get(self):
return {'hello': 'world world'}
api.add_resource(topic_tags, '/')
if __name__ == '__main__':
app.run(host="0.0.0.0", port=port)
Latest documentation has the following example assuming you want to run hello.py
(using .py
file extension is optional):
Unix, Linux, macOS, etc.:
$ export FLASK_APP=hello
$ flask run
Windows:
> set FLASK_APP=hello
> flask run
The flask
command is a CLI for interacting with Flask apps. The docs describe how to use CLI commands and add custom commands. The flask run
command is the preferred way to start the development server.
Never use this command to deploy publicly, use a production WSGI server such as Gunicorn, uWSGI, Waitress, or mod_wsgi.
As of Flask 2.2, use the --app
option to point the command at your app. It can point to an import name or file name. It will automatically detect an app instance or an app factory called create_app
. Use the --debug
option to run in debug mode with the debugger and reloader.
$ flask --app sample --debug run
Prior to Flask 2.2, the FLASK_APP
and FLASK_ENV=development
environment variables were used instead. FLASK_APP
and FLASK_DEBUG=1
can still be used in place of the CLI options above.
$ export FLASK_APP=sample
$ export FLASK_ENV=development
$ flask run
On Windows CMD, use set
instead of export
.
> set FLASK_APP=sample
For PowerShell, use $env:
.
> $env:FLASK_APP = "sample"
The python sample.py
command runs a Python file and sets __name__ == "__main__"
. If the main block calls app.run()
, it will run the development server. If you use an app factory, you could also instantiate an app instance at this point.
if __name__ == "__main__":
app = create_app()
app.run(debug=True)
Both these commands ultimately start the Werkzeug development server, which as the name implies starts a simple HTTP server that should only be used during development. You should prefer using the flask run
command over the app.run()
.