Flask - Revision history

Admin: /* Resources */

2018-11-15T17:11:42Z

Resources

← Older revision		Revision as of 17:11, 15 November 2018
Line 200:		Line 200:

	=Resources=		=Resources=

			==Flaskadillo==

			I put together a tutorial on how to use Flask. This is available in the flaskadillo repo:

			* https://git.charlesreid1.com/charlesreid1/flaskadillo
			* https://github.com/charlesreid1/flaskadillo



			==Links==

	The Flask mega tutorial is really handy: http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world		The Flask mega tutorial is really handy: http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world

Admin: /* Flags */

2018-11-15T16:08:53Z

Flags

← Older revision		Revision as of 16:08, 15 November 2018
Line 210:		Line 210:
	[[Category:Python]]		[[Category:Python]]
	[[Category:Web]]		[[Category:Web]]
			[[Category:Web Server]]
	[[Category:REST API]]		[[Category:REST API]]

			[[Category:Python Packaging]]

Admin: /* Resources */

2018-11-04T19:33:45Z

Resources

← Older revision		Revision as of 19:33, 4 November 2018
Line 200:		Line 200:

	=Resources=		=Resources=

	~~==Basics==~~

	The Flask mega tutorial is really handy: http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world		The Flask mega tutorial is really handy: http://blog.miguelgrinberg.com/post/the-flask-mega-tutorial-part-i-hello-world

	Micro blog example: https://stormpath.com/blog/build-a-flask-app-in-30-minutes		Micro blog example: https://stormpath.com/blog/build-a-flask-app-in-30-minutes

	~~==Bundling==~~

	~~Official flask site: patterns for distributing flask apps: http://flask.pocoo.org/docs/patterns/distribute/~~

	~~Packaging a flask app: http://www.plankandwhittle.com/packaging-a-flask-web-app/~~

	=Flags=		=Flags=

Admin: /* Packaging Flask Apps */

2018-11-04T19:10:21Z

Packaging Flask Apps

@@ Line 197: / Line 197: @@
 =Packaging Flask Apps=
-==Deploying Flask Web App as Submodule==
+[[Flask/Packaging]] - a page that covers how to bundle flask apps into a ready-to-distribute Python package
 =Resources=

Admin: /* Raising errors */

2018-08-23T13:55:14Z

Raising errors

@@ Line 115: / Line 115: @@
          return "<h2>Hi there!</h2>"
 </pre>
 ==POST Endpoints==

Admin: /* POST Endpoints */

2018-08-23T13:49:42Z

POST Endpoints

← Older revision		Revision as of 13:49, 23 August 2018
Line 118:		Line 118:
	==POST Endpoints==		==POST Endpoints==

	To deal with data sent via a POST request, use the <code>request</code> variable, imported from Flask:		To deal with data sent via a POST request, use the <code>request</code> variable, imported from Flask, and get the POSTed data using <code>request.json</code>:

	<pre>		<pre>
Line 125:		Line 125:
	...		...

	@app.route('/~~qwerty~~', methods=['POST'])		@app.route('/post_something',methods=['POST'])
	def ~~qwerty~~():		def post_something():
	if not request.json:		if not request.json:
	abort(400)		abort(400)
			post_data = request.json

			# Now render a template for the user
			# and populate the template variables
			# with data that was POSTed
			render_template('posted.html',
			title = post_data.get('title','A Pretty Boring Title'),
			author = post_data.get('author','Anonymous Coward'),
			color = post_data.get('color','blue'),
			)

	~~data = request.json~~
	if

			# NOTE:
			# If you'd rather return json, just do
			# return jsonify({'status':'ok'}), 200

	~~@app.route('/todo/api/v1.0/tasks', methods=['POST'])~~
	~~def create_task():~~
	~~if not request.json or not 'title' in request.json:~~
	~~abort(400)~~
	~~task = {~~
	~~'id': tasks[-1]['id'] + 1,~~
	~~'title': request.json['title'],~~
	~~'description': request.json.get('description', ""),~~
	~~'done': False~~
	}
	~~tasks.append(task)~~
	~~return jsonify({'task': task}), 201~~
	</pre>		</pre>

	~~and the corresponding output when~~ we POST data to the server:		Now we can POST data to the server by adding the JSON content type to a curl request, and pass data in using the -d flag. here's the curl request:

	<pre>		<pre>
	$ curl -i -H "Content-Type: application/json" -X POST -d '{"title":"~~Read a book~~"~~}' http://localhost:5000/todo/api/v1.0/tasks~~		$ curl -i -H "Content-Type: application/json" -X POST -d '{"title":"My first post", "author":"Gladys Overwith", "color":"orange"}' http://localhost:5000/post_something
	~~HTTP/1.0 201 Created~~
	~~Content-Type: application/json~~
	~~Content-Length: 104~~
	~~Server: Werkzeug/0.8.3 Python/2.7.3~~
	~~Date: Mon~~, ~~20 May 2013 05:56:21 GMT~~

	{
	~~"task": {~~
	"~~description~~": "",
	"~~done~~": ~~false,~~
	"id": 3,
	~~"title"~~: ~~"Read a book"~~
	}
	}
	</pre>		</pre>

Admin: /* Rendering templates */

2018-08-23T13:43:42Z

Rendering templates

← Older revision		Revision as of 13:43, 23 August 2018
Line 81:		Line 81:
	@app.route('/sample/<int:sample_number>')		@app.route('/sample/<int:sample_number>')
	def sample(sample_number):		def sample(sample_number):
	render_template('sample.html')		render_template('sample.html', sample_number=sample_number)
	</pre>		</pre>

Line 89:		Line 89:
	<html>		<html>
	<head>		<head>
	<title>{{~~title~~}}</title>		<title>Sample {{sample_number}}</title>
	</head>		</head>
	<body>		<body>
	<h2>{{~~title~~}}</h2>		<h2>{{sample_number}}</h2>
	<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula.</p>		<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula.</p>
	</body>		</body>
	</html>		</html>
	</pre>		</pre>



	===Raising errors===		===Raising errors===

Admin: /* Raising errors */

2018-08-23T13:42:54Z

Raising errors

@@ Line 69: / Line 69: @@
      return jsonify(d)
 </pre>
 ===Raising errors===

Admin: /* Routes */

2018-08-23T13:21:59Z

Routes

← Older revision		Revision as of 13:21, 23 August 2018
Line 27:		Line 27:
	==Routes==		==Routes==

	Simple hello world route:		===Simple hello world route===

			A simple hello world route:

	<pre>		<pre>
Line 38:		Line 40:
	return "Hello, World!"		return "Hello, World!"
	</pre>		</pre>

			===Returning HTML===

	To return HTML, we can return it in a string:		To return HTML, we can return it in a string:
Line 50:		Line 54:
	return "<h2>Flask Returns HTML Code</h2>"		return "<h2>Flask Returns HTML Code</h2>"
	</pre>		</pre>

			===Returning JSON===

	If we are writing an API, we want routes that return JSON. we can use Flask's jsonify function:		If we are writing an API, we want routes that return JSON. we can use Flask's jsonify function:
Line 63:		Line 69:
	return jsonify(d)		return jsonify(d)
	</pre>		</pre>

			===Raising errors===

	To abort with a 400 (server error), use the abort function		To abort with a 400 (server error), use the abort function

Admin: /* RESTful API */

2018-08-23T13:21:16Z

RESTful API

← Older revision		Revision as of 13:21, 23 August 2018
Line 64:		Line 64:
	</pre>		</pre>

	~~=RESTful API=~~		To abort with a 400 (server error), use the abort function

	~~We can use~~ Flask to design and implement a RESTful API service. Flask will be a server and interpret between URLs and Python actions. Note that this is particularly handy if you're designing an internet-of-things thing, as you can install Flask on a [[RaspberryPi]], and now you have a RESTful API for accessing your Raspberry Pi! If you take it a step further, you can control the GPIO pins on the Raspberry Pi, ~~and make the Pi do things with your hardware and circuitry based on your API actions.~~		<pre>
			from flask import Flask, abort

	~~==Hello World==~~		...

	~~Let~~'~~s put our Flask hello world app in~~ <~~code~~>~~run.py~~</~~code~~>:		@app.route('/how_to_abort')
			def how_to_abort():
			import random
			if random.random() < 0.5:
			abort(400)
			else:
			return "<h2>Hi there!</h2>"
			</pre>

	~~<pre>~~		==POST Endpoints==
	~~from flask import Flask~~

	~~app =~~ Flask~~(__name__)~~		To deal with data sent via a POST request, use the <code>request</code> variable, imported from Flask:

	~~@app.route('/')~~		<pre>
	~~def index():~~		from flask import Flask, jsonify, abort, request
	~~return "Hello~~, ~~World!"~~

	~~if __name__ == '__main__':~~		...
	~~app~~.~~run(debug=True)~~
	~~</pre>~~

	~~now we run it with <code>python run~~.~~py<~~/~~code>~~		@app.route('/qwerty', methods=['POST'])
			def qwerty():
			if not request.json:
			abort(400)

	~~==Send Some Data with POST==~~

	~~You can also send some~~ data ~~with POST requests:~~		data = request.json
			if

	~~<pre>~~
	~~from flask import request~~

	@app.route('/todo/api/v1.0/tasks', methods=['POST'])		@app.route('/todo/api/v1.0/tasks', methods=['POST'])