cburmeister / flask-bones Goto Github PK

View Code? Open in Web Editor NEW

992.0 26.0 121.0 405 KB

An example of a large scale Flask application using blueprints and extensions.

Home Page: http://flask-bones.herokuapp.com/

License: MIT License

Python 61.54% CSS 0.48% JavaScript 1.28% HTML 34.61% Makefile 0.60% Mako 0.93% Dockerfile 0.56%

flask docker sqlalchemy alembic babel rq yarn travis-ci

flask-bones's Introduction

flask-bones

An example of a large scale Flask application using blueprints and extensions.

Setup

Quickly run the project using docker and docker-compose:

docker-compose up -d

Create the database and seed it with some data:

docker-compose run --rm app flask create-db
docker-compose run --rm app flask populate-db --num_users 5

Download front-end dependencies with yarn:

yarn install --modules-folder ./app/static/node_modules

Configuration

The following environment variables are optional:

Name	Purpose
`APP_NAME`	The name of the application. i.e Flask Bones
`MAIL_PORT`	The port number of an SMTP server.
`MAIL_SERVER`	The hostname of an SMTP server.
`MEMCACHED_HOST`	The hostname of a memcached server.
`MEMCACHED_PORT`	The port number of a memcached server.
`POSTGRES_HOST`	The hostname of a postgres database server.
`POSTGRES_PASS`	The password of a postgres database user.
`POSTGRES_PORT`	The port number of a postgres database server.
`POSTGRES_USER`	The name of a postgres database user.
`REDIS_HOST`	The hostname of a redis database server.
`REDIS_PORT`	The port number of a redis database server.
`SECRET_KEY`	A secret key required to provide authentication.
`SERVER_NAME`	The hostname and port number of the server.

Features

Caching with Memcached

from app.extensions import cache

# Cache something
cache.set('some_key', 'some_value')

# Fetch it later
cache.get('some_key')

Email delivery

from app.extensions import mail
from flask_mail import Message

# Build an email
msg = Message('User Registration', sender='[email protected]', recipients=[user.email])
msg.body = render_template('mail/registration.mail', user=user, token=token)

# Send
mail.send(msg)

Asynchronous job scheduling with RQ

RQ is a simple job queue for python backed by redis.

Define a job:

@rq.job
def send_email(msg):
    mail.send(msg)

Start a worker:

flask rq worker

Queue the job for processing:

send_email.queue(msg)

Monitor the status of the queue:

flask rq info --interval 3

For help on all available commands:

flask rq --help

Stupid simple user management

from app.extensions import login_user, logout_user, login_required

# Login user
login_user(user)

# You now have a global proxy for the user
current_user.is_authenticated

# Secure endpoints with a decorator
@login_required

# Log out user
logout_user()

Password security that can keep up with Moores Law

from app.extensions import bcrypt

# Hash password
pw_hash = bcrypt.generate_password_hash('password')

# Validate password
bcrypt.check_password_hash(pw_hash, 'password')

Easily swap between multiple application configurations

from app.config import dev_config, test_config

app = Flask(__name__)

class dev_config():
    DEBUG = True

class test_config():
    TESTING = True

# Configure for testing
app.config.from_object(test_config)

# Configure for development
app.config.from_object(dev_config)

Form validation & CSRF protection with WTForms

Place a csrf token on a form:

{{ form.csrf_token }}

Validate it:

form.validate_on_submit()

Rate-limit routes

from app.extensions import limiter

@limiter.limit("5 per minute")
@auth.route('/login', methods=['GET', 'POST'])
def login():
    # ...
    return 'your_login_page_contents'

Automated tests

Run the test suite:

pytest

Use any relational database using the SQLAlchemy ORM

from app.user.models import User

# Fetch user by id
user = User.get_by_id(id)

# Save current state of user
user.update()

# Fetch a paginated set of users
users = User.query.paginate(page, 50)

Front-end asset management

Download front-end dependencies with yarn:

yarn install --modules-folder ./app/static/node_modules

Merge and compress them together with Flask-Assets:

flask assets build

Version your database schema

Display the current revision:

flask db current

Create a new migration:

flask db revision

Upgrade the database to a later version:

flask db upgrade

Internationalize the application for other languages (i18n)

Extract strings from source and compile a catalog (.pot):

pybabel extract -F babel.cfg -o i18n/messages.pot .

Create a new resource (.po) for German translators:

pybabel init -i i18n/messages.pot -d i18n -l de

Compile translations (.mo):

pybabel compile -d i18n

Merge changes into resource files:

pybabel update -i i18n/messages.pot -d i18n

flask-bones's People

Contributors

Stargazers

Watchers

Forkers

ivanrvpereira anioko nezaj adxio jstacoder randy-ran dansamara danlopez00 paulo-sergio-softlog 5290charlie aregee xym2010 alexmerser jfreax dylanroy thecypher zouchao2010 chenweihua kua-hosi-grup lbzhao28 murindwaz michaelporras emdem piusdan sharmaansh21 jjediny debetux rivar77 kernity puddlesxxx janist7 maksimmisin connectthefuture vin0010 nyimbi feelthelearn skyclub66 www3838438 ocervell willm78 deepakdubey90 awei-robot qrcodedoesntcode pywkm guoyu07 piroux vkelk sattamjh valrcs juanyongzhang hucares rizplate nanra focode jwhitaker peterlada marlin7 kflyddn unoatinfou tsyjwct ik-learning morpheus747 miaohf laayis xie137z dgreyling jpfrank maddozs google38438 bryancresswell edward01 opensourcelearningrepos jamesgear modulexcite unutulmaz jimupon sserurich semernyakov yuriykulakov daghan petrgru blackhacked sssevennn lightcax lodilorenzo dt021 ashwanitr adv27 oscarpoppa sheelask dwreeves aaron-beach kshitizkoirala walsad srinath4223 zenahr shalevy1 hiven baronrustamov jyothi-jaci

flask-bones's Issues

Update README

SQLAlchemy Declarative models don't require init() method

https://github.com/cburmeister/flask-bones/blob/master/app/user/models.py#L17-L24

Fairly sure some of this doesn't need to happen based on
http://docs.sqlalchemy.org/en/latest/orm/constructors.html
http://stackoverflow.com/questions/13384996/how-do-i-set-attribute-default-values-in-sqlalchemy-declarative

cachecore isn't available on pypi

https://pypi.python.org/pypi/cachecore/ is 404'ing for me

Change blueprint/templates/* to blueprint/templates/blueprint/*

Flask blueprints have a number of template conflict issues. The suggested solution by most people is to add an additional folder to the templates path.

example:

user/templates/add.html --> user/templates/user/add.html

Details:
http://stackoverflow.com/questions/7974771/flask-blueprint-template-folder/8198325

Note also the jinja2 caching issue mentioned here:
http://stackoverflow.com/a/11145483/770425

Update dependencies

In particular, Flask-SQLAlchemy has seen quite a few changes since 1.0... any particular reason it's pinned to such an old version?

Add flask-oauth extension

Update Flask to 1.0

Move DataTable to separate module

Use FactoryBoy for generating fake data for tests & dev

Be nice to swap from using a custom factory to using FactoryBoy for generating fake data for tests/dev. A lot more powerful, and integrates cleanly with faker & sqlalchemy.

Improve config classes

Integer/Boolean columns not being displayed when adding to DataTables?

Improve test coverage

User_accessed is invalid

Hi
I'm using this scaffold to build my project. When I add user_access func to record user access time. but seem to it 's invalid . What is the problem?
thank you

auth/view.py

from flask_login import (current_user, login_required, user_accessed,
                         logout_user, UserMixin, AnonymousUserMixin,
                         confirm_login, login_user)
...
@user_accessed.connect_via(auth)
def when_user_accessed(sender, **extra):
    user_id = session.get('user_id')
    if user_id:
        print 'access'

...

EDIT: I also stripped out REDIS and the problem persists.

Use Flask-DebugToolbar

Using Flask-DebugToolbar adds a number of helpful things, including timing pageloads (without having to manually code it) and viewing SQLAlchemy queries.