cookiecutter-flask ================== A Flask template for cookiecutter_. .. _cookiecutter: https://github.com/audreyr/cookiecutter Features -------- - Twitter Bootstrap 3 and starter templates - Flask-SQLAlchemy with basic User model - Flask-WTForms with login and registration forms - Flask-Login for authentication - Procfile for deploying to a PaaS (e.g. Heroku) - Flask-Testing, nose, and Factory-Boy for testing - A simple ``manage.py`` script. - CSS and JS minification using Flask-Assets - Utilizes best practices: `Blueprints `_ and `Application Factory `_ patterns Screenshots ----------- .. image:: https://dl.dropboxusercontent.com/u/1693233/github/cookiecutter-flask-01.png :target: https://dl.dropboxusercontent.com/u/1693233/github/cookiecutter-flask-01.png :alt: Home page .. image:: https://dl.dropboxusercontent.com/u/1693233/github/cookiecutter-flask-02.png.png :target: https://dl.dropboxusercontent.com/u/1693233/github/cookiecutter-flask-02.png.png :alt: Registration form Using this template ------------------- :: $ pip install cookiecutter $ cookiecutter https://github.com/sloria/cookiecutter-flask.git You will be asked about your basic info (name, project name, etc.). This info will be used in your new project. Blueprints? App factories? -------------------------- If you prefer not to use blueprints or an application factory, check out the ``simple`` branch which has the older structure without these patterns. Note, however, only the ``master`` branch will be actively maintained. Inspiration ----------- - `Building Websites in Python with Flask `_ - `Getting Bigger with Flask `_ - `Structuring Flask Apps `_ - `Flask-Foundation `_ by `@JackStouffer `_ - `flask-bones `_ by `@cburmeister `_ - `flask-basic-registration `_ by `@mjhea0 `_ - `Flask Official Documentation `_ License ------- BSD licensed. Changelog --------- 0.3.0 ***** - More modular organization: each blueprint contains its own view, models, and forms in a directory. There is still a single directory for templates and static assets. - Use Flask-Bcrypt for password hashing. - Flask-Login for authentication. - Simple test setup. Just create a subclass of ``DbTestCase``. - Flask-Testing support. - Use Factory-Boy for test factories. 0.2.0 (09/21/2013) ****************** - Add manage.py script - Add Flask-Assets for CSS and JS bundling+minification - Use different configs for development and production environments, controlled by the MYFLASKAPP_ENV system environment variable - Use Blueprints and application factory pattern. The ``simple`` branch does not use these. 0.1.0 (08/20/2013) ****************** - First iteration - Bootstrap 3 final - Working User model and registration