Flask - Revision history

Hdridder at 20:10, 10 June 2025

2025-06-10T20:10:10Z

← Older revision		Revision as of 20:10, 10 June 2025
Line 10:		Line 10:
	pip install Flask # Install flask in the virtual environment		pip install Flask # Install flask in the virtual environment
	</syntaxhighlight>		</syntaxhighlight>


	=Basics=		=Basics=
Line 28:		Line 27:

	if __name__ == '__main__': # When executed on the commandline (build in webserver)		if __name__ == '__main__': # When executed on the commandline (build in webserver)
	app.run(host='0.0.0.0',port=5000) # Listen to ~~localhost~~ port 5000, you can also use flask run for options		app.run(host='0.0.0.0',port=5000) # Listen to all on port 5000, you can also use flask run for options
	#app.run(host='0.0.0.0',port=8080,Debug=True) # Run in debug mode, listen to all hosts on port 8080		#app.run(host='0.0.0.0',port=8080,Debug=True) # Run in debug mode, listen to all hosts on port 8080

	</syntaxhighlight>		</syntaxhighlight>
	~~Run~~ the ~~build-in server listening~~ to ~~all~~		Or run from the commandline so you can pass options to flask
	<syntaxhighlight lang=bash>		<syntaxhighlight lang=bash>
	export FLASK_APP=welcome_app.py		export FLASK_APP=welcome_app.py
	flask run --host=0.0.0.0		flask run --host=0.0.0.0
	</syntaxhighlight>		</syntaxhighlight>
			Output:
	welcome_app		welcome_app
	* Serving Flask app "welcome_app"		* Serving Flask app "welcome_app"
Line 49:		Line 49:
	Mayor part is from this site [https://vladikk.com/2013/09/12/serving-flask-with-nginx-on-ubuntu/].		Mayor part is from this site [https://vladikk.com/2013/09/12/serving-flask-with-nginx-on-ubuntu/].

	* Install [[uwsgi]].		* Install [[uwsgi]] and uwsgi-plugin-python3.

	The inifile in ~~/var/www/flask/project/demoprofect_uwsgi.ini~~		The inifile in
	<syntaxhighlight lang="~~nginx~~">		<syntaxhighlight lang="text">
	[uwsgi]		[uwsgi]
	~~#application's base folder~~		base = /var/www/flask/demoapp
	base = /var/www/flask/~~project~~

	plugins = python3		plugins = python3

	#~~python module~~ to ~~import~~		# Script to run without .py
	app = hello		app = hello
			# It's unclear if the script to run is defined by module or callable
	module = %(app)		module = %(app)
			callable = app

	home = %(base)/venv		home = %(base)/.venv
	pythonpath = %(base)		pythonpath = %(base)

	#socket file's location		#socket file's location and permission
	socket = /~~var/www/flask/project~~/%n.sock		socket = /tmp/%n.sock # %n is the name of the ini-file without .ini

	#~~permissions for~~ the ~~socket~~ file
	chmod-socket = 666		chmod-socket = 666

	~~#the variable that holds a flask application inside the module imported at line #6~~
	~~callable = app~~

	#location of log files		#location of log files
	logto = /var/log/uwsgi/%n.log		logto = /var/log/uwsgi/%n.log # Funny, logging is done to /var/log/uwsgi/app/%n.log
	</syntaxhighlight>		</syntaxhighlight>



	* Create a virtual webserver (port 80 is save enough if you have a secure front-end server)		* Create a virtual webserver (port 80 is save enough if you have a secure front-end server)
Line 91:		Line 84:
	server_name <fqdn>;		server_name <fqdn>;

	location ~~/app1~~ {		location @demoapp {
	include uwsgi_params;		include uwsgi_params;
	~~uwsgi_param SCRIPT_NAME /app1;~~		uwsgi_pass unix://tmp/demoapp_uwsgi.sock;
	~~uwsgi_modifier1 30;~~
	uwsgi_pass unix://tmp/~~app1~~.sock;
	}		}
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	~~===Super simple app===~~		That's it. Point your webbrowser to http://<your webserver fdqn></code> and it will show you what the app returns
	~~In /var/www/flask/app1/app1.py~~
	~~<syntaxhighlight lang=python>~~
	~~#!/usr/bin/env python3~~

	~~from flask import Flask~~
	~~import os~~

	~~application = Flask(__name__)~~

	~~@application.route('/app1')~~
	~~def app1():~~
	~~return "App 1 live and kicking"~~

	~~if __name__ == '__main__':~~
	~~application.run(host='0.0.0.0', port=8080,debug=True)~~
	~~</syntaxhighlight>~~

	That's it. Point your webbrowser to http://<your webserver fdqn>~~/app1~~</code> and it will show you~~: "App 1 live and kicking"~~

	=Running applications=		=Running applications=

Hdridder: /* Basics */

2025-06-09T21:37:41Z

Basics

← Older revision		Revision as of 21:37, 9 June 2025
Line 1:		Line 1:
			=Installation=
			Check this[https://flask.palletsprojects.com/en/1.1.x/quickstart/]

			In the directory where you want to create your flask application:

			<syntaxhighlight lang=bash>
			apt install python3.11-venv # make sure the venv module is there
			python -m venv .venv # Create a virtual environment
			. .venv/bin/activate # Activate the virtual environment
			pip install Flask # Install flask in the virtual environment
			</syntaxhighlight>


	=Basics=		=Basics=
	~~Check this[https://flask.palletsprojects.com/en/1.1.x/quickstart/]~~

	Hello world app:		Hello world app:

Hdridder: /* Integrate with nginx */

2025-01-08T21:58:58Z

Integrate with nginx

← Older revision		Revision as of 21:58, 8 January 2025
Line 38:		Line 38:

	* Install [[uwsgi]].		* Install [[uwsgi]].

			The inifile in /var/www/flask/project/demoprofect_uwsgi.ini
			<syntaxhighlight lang="nginx">
			[uwsgi]
			#application's base folder
			base = /var/www/flask/project

			plugins = python3

			#python module to import
			app = hello
			module = %(app)

			home = %(base)/venv
			pythonpath = %(base)

			#socket file's location
			socket = /var/www/flask/project/%n.sock

			#permissions for the socket file
			chmod-socket = 666

			#the variable that holds a flask application inside the module imported at line #6
			callable = app

			#location of log files
			logto = /var/log/uwsgi/%n.log
			</syntaxhighlight>



	* Create a virtual webserver (port 80 is save enough if you have a secure front-end server)		* Create a virtual webserver (port 80 is save enough if you have a secure front-end server)

Hdridder: /* Microservices and/or more applications on 1 web-server */

2021-07-21T06:56:18Z

Microservices and/or more applications on 1 web-server

← Older revision		Revision as of 06:56, 21 July 2021
Line 78:		Line 78:
	That's it. Point your webbrowser to http://<your webserver fdqn>/app1</code> and it will show you: "App 1 live and kicking"		That's it. Point your webbrowser to http://<your webserver fdqn>/app1</code> and it will show you: "App 1 live and kicking"

	=~~Microservices and/or more~~ applications ~~on 1 web-server~~=		=Running applications=
	You can make any number of ~~application~~ by adding more apps to [[uwsgi]] and a location in [[nginx]] ~~for each of them~~. ~~However with only 1 app you~~ can run ~~all python scripts you want.~~		You can make any number of applications by adding more apps to [[uwsgi]] and a location in [[nginx]]. You can also run any number of programs by adding routes to an app or with just a few routes like this:

	<syntaxhighlight lang=python>		<syntaxhighlight lang=python>

Hdridder: /* Generate web pages */

2021-07-20T08:36:17Z

Generate web pages

← Older revision		Revision as of 08:36, 20 July 2021
Line 124:		Line 124:

	=Generate web pages=		=Generate web pages=
	~~https://flask.palletsprojects.com/en/1.1.x/patterns/templateinheritance/#template-inheritance~~

			Flask is by default using the [https://jinja.palletsprojects.com jinja] template engine. They have a nice tutorial for this too[https://flask.palletsprojects.com/en/2.0.x/tutorial/].

	~~[https://www.idkrtm.com/creating-a-webpage-using-python-and-flask/ Source for this basic app]~~		Very simple example is to put a index.html in <code><app-base>/templates/</code>

	~~Put~~ a index.html in <app-base>/templates/

	<syntaxhighlight lang=python>		<syntaxhighlight lang=python>
Line 139:		Line 137:
	app = Flask(__name__)		app = Flask(__name__)

	@app.route('/html')		@app.route('/app1/html')
	def static_page():		def static_page():
	return render_template('index.html')		return render_template('index.html')

Hdridder at 15:43, 19 July 2021

2021-07-19T15:43:18Z

Show changes

Hdridder: /* Super simple apps */

2021-07-19T15:14:22Z

Super simple apps

← Older revision		Revision as of 15:14, 19 July 2021
Line 95:		Line 95:
	</code>		</code>

	===Super simple ~~apps~~===		===Super simple app===
	In /var/www/flask/app1/app1.py		In /var/www/flask/app1/app1.py
	<syntaxhighlight lang=python>		<syntaxhighlight lang=python>
Line 113:		Line 113:
	</syntaxhighlight>		</syntaxhighlight>

	~~/var/www/flask/app2/app2.py~~		Pointing your browser at <code><webserver>:/app1</code> will now show you: "App 1 live and kicking"
	<~~syntaxhighlight lang=python~~>
	#!/~~usr~~/~~bin/env python3~~

	~~from flask import Flask~~
	~~import os~~

	~~application = Flask(__name__)~~

	~~@application.route('/app2')~~
	~~def app2()~~:
	~~return~~ "App 2 live and kicking"

	~~if __name__ == '__main__':~~
	~~application.run(host='0.0.0.0', port=8080,debug=True)~~
	~~</syntaxhighlight>~~

	===Create a nginx virtual host===		===Create a nginx virtual host===

Hdridder: /* Super simple apps */

2021-07-14T18:09:15Z

Super simple apps

← Older revision		Revision as of 18:09, 14 July 2021
Line 96:		Line 96:

	===Super simple apps===		===Super simple apps===
	In /var/www/flask/app1/app1/py		In /var/www/flask/app1/app1.py
	<syntaxhighlight lang=python>		<syntaxhighlight lang=python>
	#!/usr/bin/env python3		#!/usr/bin/env python3

Hdridder at 13:07, 14 July 2021

2021-07-14T13:07:38Z

@@ Line 128: / Line 128: @@
 if __name__ == '__main__':
      application.run(host='0.0.0.0', port=8080,debug=True)
 </syntaxhighlight>

Hdridder: /* Integrate with nginx */

2021-07-14T12:21:46Z

Integrate with nginx

@@ Line 37: / Line 37: @@
 Mayor part is from this site [https://vladikk.com/2013/09/12/serving-flask-with-nginx-on-ubuntu/].
-* Install uwgi-emperor and it's python plugin
+* Install [[uwsgi]] it's python plugin.
 * Create a virtual webserver (port 80 is save enough if you have a secure front-end server)
@@ Line 83: / Line 43: @@
 <syntaxhighlight lang="nginx">
 server {
-	listen 80 ;
+    listen 80 ;
-	listen [::]:80 ;
+    listen [::]:80;
-	server_name <fqdn>;
+    root /var/www/flask;
-	location / {
+    location /app1 {
-		include uwsgi_params;
+        include uwsgi_params;
-        	uwsgi_pass unix:/var/local/uwsgi/welcome.sock;
+        uwsgi_param SCRIPT_NAME /app1;
+        uwsgi_modifier1 30;
+}
 </syntaxhighlight>