├── .gitignore ├── LICENSE ├── Pipfile ├── README.md ├── flask_common.py └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | local_settings.py 55 | 56 | # Flask stuff: 57 | instance/ 58 | .webassets-cache 59 | 60 | # Scrapy stuff: 61 | .scrapy 62 | 63 | # Sphinx documentation 64 | docs/_build/ 65 | 66 | # PyBuilder 67 | target/ 68 | 69 | # IPython Notebook 70 | .ipynb_checkpoints 71 | 72 | # pyenv 73 | .python-version 74 | 75 | # celery beat schedule file 76 | celerybeat-schedule 77 | 78 | # dotenv 79 | .env 80 | 81 | # virtualenv 82 | venv/ 83 | ENV/ 84 | 85 | # Spyder project settings 86 | .spyderproject 87 | 88 | # Rope project settings 89 | .ropeproject 90 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [[source]] 2 | url = "https://pypi.python.org/simple" 3 | verify_ssl = true 4 | 5 | [packages] 6 | whitenoise = "*" 7 | gunicorn = "*" 8 | Flask = "*" 9 | crayons = "*" 10 | maya = "*" 11 | Flask-Compress = "*" 12 | Flask-Caching = "*" 13 | meinheld = "*" 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # flask-common 2 | A Flask extension with lots of common time-savers (file-serving, favicons, etc). 3 | 4 | 5 | An example app: 6 | 7 | ```python 8 | import time 9 | from flask import Flask 10 | from flask_common import Common 11 | 12 | app = Flask(__name__) 13 | app.debug = True 14 | 15 | common = Common(app) 16 | 17 | @app.route("/") 18 | @common.cache.cached(timeout=50) 19 | def hello(): 20 | time.sleep(1) 21 | return "Hello World!" 22 | 23 | 24 | if __name__ == "__main__": 25 | common.serve() 26 | ``` 27 | 28 | Next: 29 | 30 | - Put a `favicon.ico` in your `static` folder. 31 | - Enjoy! 32 | 33 | ## Nicities 34 | 35 | HTTP Headers: 36 | 37 | - `X-Powered-By: Flask`. 38 | - `X-Processed-Time: 0.000133037567139`. 39 | 40 | Other nice things: 41 | 42 | - `@common.cache.cached(timeout=50)` decorator for caching views in memory. 43 | - Favicon support (`/favicon.ico` redirects to `/static/favicon.ico`). 44 | 45 | ## Web Server: Gunicorn + Meinheld 46 | 47 | Automatically uses Gunicorn + Meinheld for production (when `Flask.debug = False`), Flask's dev server for development. 48 | 49 | Configuration environment variables: 50 | 51 | - `WEB_CONCURRENCY` for specifying the number of synchronous gunicorn workers. 52 | - `PORT` for binding to a specific port. 53 | 54 | ## File Server: WhiteNoise 55 | 56 | Flask-Common automatically configures [WhiteNoise](http://whitenoise.evans.io) to serve your static files. 57 | 58 | ## Configurations 59 | 60 | app.config['COMMON_FILESERVER_DISABLED'] = 1 61 | app.config['COMMON_POWERED_BY_DISABLED'] = 1 62 | app.config['COMMON_PROCESSED_TIME_DISABLED'] = 1 63 | 64 | ## Cache configures 65 | By default *simple* is a default cache type. But can you change this options, following below steps. [Flask-Caching](https://pythonhosted.org/Flask-Caching/#configuring-flask-caching) 66 | 67 | app.config['COMMON_CACHE_TYPE'] = "simple" 68 | -------------------------------------------------------------------------------- /flask_common.py: -------------------------------------------------------------------------------- 1 | import os 2 | import multiprocessing 3 | 4 | import crayons 5 | import maya 6 | from flask import request, current_app, url_for, redirect 7 | from gunicorn import util 8 | from gunicorn.app.base import Application 9 | from whitenoise import WhiteNoise 10 | from flask_caching import Cache 11 | 12 | try: 13 | from flask.exthook import ExtDeprecationWarning 14 | import warnings 15 | warnings.simplefilter('ignore', ExtDeprecationWarning) 16 | except ImportError: 17 | pass # DeprecationWarning only relevant to Flask<1.0 18 | 19 | 20 | # Find the stack on which we want to store the database connection. 21 | # Starting with Flask 0.9, the _app_ctx_stack is the correct one, 22 | # before that we need to use the _request_ctx_stack. 23 | try: 24 | from flask import _app_ctx_stack as stack 25 | except ImportError: 26 | from flask import _request_ctx_stack as stack 27 | 28 | 29 | # \ 30 | # \ji 31 | # /.((( 32 | # (,/"(((__,--. 33 | # \ ) _( /{ 34 | # !|| " :|| 35 | # !|| :|| 36 | # ''' ''' 37 | 38 | # Gunicorn Stuff 39 | # -------------- 40 | 41 | def number_of_gunicorn_workers(): 42 | if 'WEB_CONCURRENCY' not in os.environ: 43 | return (multiprocessing.cpu_count() * 2) + 1 44 | else: 45 | return os.environ['WEB_CONCURRENCY'] 46 | 47 | 48 | class WSGIApp(Application): 49 | 50 | def __init__(self, application, options={}): 51 | """ Construct the Application. Default gUnicorn configuration is loaded """ 52 | 53 | self.application = application 54 | self.usage = None 55 | self.callable = None 56 | self.options = options 57 | self.prog = None 58 | self.do_load_config() 59 | 60 | def init(self, parser, opts, args): 61 | """ Apply our custom settings """ 62 | 63 | cfg = {} 64 | for k, v in self.options.items(): 65 | if k.lower() in self.cfg.settings and v is not None: 66 | cfg[k.lower()] = v 67 | return cfg 68 | 69 | def load(self): 70 | """ Attempt an import of the specified application """ 71 | 72 | if isinstance(self.application, str): 73 | return util.import_app(self.application) 74 | else: 75 | return self.application 76 | 77 | 78 | class GunicornServer(object): 79 | 80 | def __init__(self, app, **options): 81 | """ Construct our application """ 82 | 83 | self.app = WSGIApp(app, options) 84 | 85 | def run(self): 86 | """ Run our application """ 87 | 88 | self.app.run() 89 | 90 | 91 | # Common Stuff 92 | # ------------ 93 | 94 | class Common(object): 95 | """Flask-Common.""" 96 | def __init__(self, app=None): 97 | self.app = None 98 | if app is not None: 99 | self.init_app(app) 100 | 101 | def init_app(self, app): 102 | """Initializes the Flask application with Common.""" 103 | if not hasattr(app, 'extensions'): 104 | app.extensions = {} 105 | 106 | if 'common' in app.extensions: 107 | raise RuntimeError("Flask-Common extension already initialized") 108 | 109 | app.extensions['common'] = self 110 | self.app = app 111 | 112 | if 'COMMON_FILESERVER_DISABLED' not in app.config: 113 | with app.test_request_context(): 114 | 115 | # Configure WhiteNoise. 116 | app.wsgi_app = WhiteNoise(app.wsgi_app, root=url_for('static', filename='')[1:]) 117 | 118 | self.cache = Cache(app, config={'CACHE_TYPE': app.config.get("COMMON_CACHE_TYPE", 'simple')}) 119 | 120 | @app.before_request 121 | def before_request_callback(): 122 | request.start_time = maya.now() 123 | 124 | @app.after_request 125 | def after_request_callback(response): 126 | if 'COMMON_POWERED_BY_DISABLED' not in current_app.config: 127 | response.headers['X-Powered-By'] = 'Flask' 128 | if 'COMMON_PROCESSED_TIME_DISABLED' not in current_app.config: 129 | response.headers['X-Processed-Time'] = maya.now().epoch - request.start_time.epoch 130 | return response 131 | 132 | @app.route('/favicon.ico') 133 | def favicon(): 134 | return redirect(url_for('static', filename='favicon.ico'), code=301) 135 | 136 | def serve(self, workers=None, **kwargs): 137 | """Serves the Flask application.""" 138 | if self.app.debug: 139 | print(crayons.yellow('Booting Flask development server...')) 140 | self.app.run() 141 | 142 | else: 143 | print(crayons.yellow('Booting Gunicorn...')) 144 | 145 | # Start the web server. 146 | server = GunicornServer( 147 | self.app, workers=workers or number_of_gunicorn_workers(), 148 | worker_class='egg:meinheld#gunicorn_worker', **kwargs) 149 | server.run() 150 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """ 2 | Flask-Common 3 | ------------- 4 | 5 | A Flask extension with lots of common time-savers (file-serving, favicons, etc). 6 | """ 7 | import os 8 | import sys 9 | from setuptools import setup 10 | 11 | if sys.argv[-1] == 'publish': 12 | os.system('python setup.py sdist upload') 13 | sys.exit() 14 | 15 | setup( 16 | name='Flask-Common', 17 | version='0.3.0', 18 | url='https://github.com/kennethreitz/flask-common', 19 | license='BSD', 20 | author='Kenneth Reitz', 21 | author_email='me@kennethreitz.org', 22 | description='A Flask extension with lots of common time-savers (file-serving, favicons, etc).', 23 | long_description=__doc__, 24 | py_modules=['flask_common'], 25 | # if you would be using a package instead use packages instead 26 | # of py_modules: 27 | zip_safe=False, 28 | include_package_data=True, 29 | platforms='any', 30 | install_requires=[ 31 | 'Flask', 32 | 'Gunicorn', 33 | 'WhiteNoise', 34 | 'crayons', 35 | 'maya', 36 | 'Flask-Caching', 37 | 'meinheld' 38 | ], 39 | classifiers=[ 40 | 'Environment :: Web Environment', 41 | 'Intended Audience :: Developers', 42 | 'License :: OSI Approved :: BSD License', 43 | 'Operating System :: OS Independent', 44 | 'Programming Language :: Python', 45 | 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 46 | 'Topic :: Software Development :: Libraries :: Python Modules' 47 | ] 48 | ) 49 | --------------------------------------------------------------------------------