Flask Celery Bundle

Adds Celery support to Flask Unchained projects

Install

Install from PyPI:

$ pip install flask_celery_bundle

And add it to your unchained_config.BUNDLES:

# your_app_package/unchained_config.py

BUNDLES = [
    'flask_celery_bundle',
    # ...
]

NOTE: If you're using flask_mail_bundle, and you want to send emails asynchronously with celery, then flask_celery_bundle must be listed after flask_mail_bundle (or alternatively, you could manually configure MAIL_SEND_FN in your app bundle config).

Configure

This package is just a tiny wrapper that integrates Celery with Flask, so it accepts all of the standard celery configuration options. The only restriction is that, for compatibility with Flask, you must use the "old" uppercase setting names.

The default configuration included with this bundle uses redis as a message broker:

import os

class Config:
    CELERY_BROKER_URL = 'redis://{host}:{port}/0'.format(
        host=os.getenv('FLASK_REDIS_HOST', '127.0.0.1'),
        port=os.getenv('FLASK_REDIS_PORT', 6379),
    )
    CELERY_RESULT_BACKEND = CELERY_BROKER_URL
    CELERY_ACCEPT_CONTENT = ('json', 'pickle')