Flask/Packaging - Revision history

Admin at 15:45, 15 November 2018

2018-11-15T15:45:01Z

← Older revision		Revision as of 15:45, 15 November 2018
Line 80:		Line 80:
	[[Category:Web Server]]		[[Category:Web Server]]
	[[Category:Packaging]]		[[Category:Packaging]]
			[[Category:Python Packaging]]

Admin at 20:22, 4 November 2018

2018-11-04T20:22:31Z

← Older revision		Revision as of 20:22, 4 November 2018
Line 1:		Line 1:
			{{Main\|Flask}}

	=Packaging Flask in a Python Package=		=Packaging Flask in a Python Package=

Admin: /* Flags */

2018-11-04T19:33:34Z

Flags

← Older revision		Revision as of 19:33, 4 November 2018
Line 65:		Line 65:
	Voila!		Voila!


			=Resources=

			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: /* Flags */

2018-11-04T19:09:02Z

Flags

← Older revision		Revision as of 19:09, 4 November 2018
Line 70:		Line 70:
	[[Category:Flask]]		[[Category:Flask]]
	[[Category:Python]]		[[Category:Python]]
	[[Category:Web Server]		[[Category:Web Server]]
	~~[[Category:Python Packages~~]]
	[[Category:Packaging]]		[[Category:Packaging]]

Admin: Created page with "=Packaging Flask in a Python Package= ==Deploying Flask Web App as Submodule== Instructions for deploying a Flask web app as a submodule in a Python module: First, your dir..."

2018-11-04T19:08:45Z

Created page with "=Packaging Flask in a Python Package= ==Deploying Flask Web App as Submodule== Instructions for deploying a Flask web app as a submodule in a Python module: First, your dir..."

New page

=Packaging Flask in a Python Package=

==Deploying Flask Web App as Submodule==

Instructions for deploying a Flask web app as a submodule in a Python module:

First, your directory structure will look something like this:

<pre>
README.md
setup.py
mymodule/
__init__.py
submodule1/
submodule2/
webapp/
__init__.py
additional_routes.py
templates/
[...]
static/
[...]
</pre>

Next, your setup.py file will look something like this:

<pre>
config = {
'description': 'My Module',
'install_requires': ['flask'],
'packages': ['mymodule','mymodule.submodule1','mymodule.submodule2','mymodule.webapp'],
'include_package_data' : True,
'package_data' : {
'templates' : 'mymodule/webapp/templates/*',
'static' : 'mymodule/webapp/static/*'
},
'scripts': [],
'name': 'mulch',
'zip_safe' : False
}

setup(**config)
</pre>

The key lines here are <code>include_package_data</code> and <code>package_data</code>, which will also install your non-Python template and static files with your module.

Now you can install your module with <code>python setup.py install</code>, and your module is available to use from anywhere.

To create an instance of your module's web app from anywhere, follow these steps:

1. Install the module

2. Import the webapp submodule:

<pre>
from mymodule.webapp import *
</pre>

3. Start the webapp:

<pre>
app.run(debug=True)
</pre>

Voila!

=Flags=

[[Category:Flask]]
[[Category:Python]]
[[Category:Web Server]
[[Category:Python Packages]]
[[Category:Packaging]]