Skip to main content
Help us improve Python packaging – donate today!

Celery integration for Flask

Project Description

FROM CELERY 3.0 THIS LIBRARY IS NO LONGER NECESSARY, INSTEAD YOU SHOULD USE THE STANDARD CELERY API

Using Flask with Celery

From Celery 3.0 the Flask-Celery integration package is no longer recommended and you should use the standard Celery API instead.

Please read the Celery getting started tutorial:

http://docs.celeryproject.org/en/latest/getting-started/first-steps-with-celery.html

You can easily add Celery to your flask application like this:

myapp.py:

from celery import Celery

celery = Celery('myapp', broker='amqp://guest@localhost//')

@celery.task
def add(x, y):
    return x + y

To start the worker you can then launch the celery worker command by pointing to your celery app instance:

$ celery -A myapp worker -l info

(if the app argument (-A|--app) is a module/package instead of an attribute it will automatically expand into myapp.celery)

See the commands help screen for more information:

$ celery help

If you want use the flask configuration as a source for the celery configuration you can do that like this:

celery = Celery('myapp')
celery.config_from_object(flask_app.config)

If you need access to the request inside your task then you can use the test context:

from flask import Flask
from celery import Celery

app = Flask('myapp')
celery = Celery('myapp')

celery.config_from_object(app.config)

@celery.task
def hello():
    with app.test_request_context() as request:
        print('Hello {0!r}.format(request))

Release history Release notifications

This version
History Node

2.4.3

History Node

2.4.2

History Node

2.4.1

History Node

2.4.0

History Node

2.2.5

History Node

2.2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
Flask-Celery-2.4.3.tar.gz (6.2 kB) Copy SHA256 hash SHA256 Source None Jul 7, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page