Skip to main content

Celery integration with pyramid

Project description

Getting Started

Include pyramid_celery either by setting your includes in your .ini, or by calling config.include(‘pyramid_celery’):

pyramid.includes = pyramid_celery

Then you just need to tell pyramid_celery what ini file your [celery] section is in:


Then you are free to use celery, for example class based:

from pyramid_celery import celery_app as app

class AddTask(app.Task):
    def run(self, x, y):
        print x+y

or decorator based:

from pyramid_celery import celery_app as app

def add(x, y):
    print x+y

To get pyramid settings you may access them in app.conf[‘PYRAMID_REGISTRY’].


By default pyramid_celery assumes you want to configure celery via an ini settings. You can do this by calling config.configure_celery(‘development.ini’) but if you are already in the main of your application and want to use the ini used to configure the app you can do the following:


If you want to use the standard celeryconfig python file you can set the USE_CELERYCONFIG = True like this:


You can get more information for here:

An example ini configuration looks like this:

BROKER_URL = redis://localhost:1337/0
CELERY_IMPORTS = app1.tasks

task = app1.tasks.Task1
type = crontab
schedule = {"minute": 0}

task = app1.tasks.Task2
type = timedelta
schedule = {"seconds": 30}
args = [16, 16]

task = app2.tasks.Task1
type = crontab
schedule = {"hour": 0, "minute": 0}
kwargs = {"boom": "shaka"}

task = myapp.tasks.Task4
type = integer
schedule = 30

Running the worker

To run the worker we just use the standard celery command with an additional argument:

celery worker -A pyramid_celery.celery_app --ini development.ini

If you’ve defined variables in your .ini like %(database_username)s you can use the –ini-var argument, which is a comma separated list of key value pairs:

celery worker -A pyramid_celery.celery_app --ini development.ini --ini-var=database_username=sontek,database_password=OhYeah!

The values in ini-var cannot have spaces in them, this will break celery’s parser.

The reason it is a csv instead of using –ini-var multiple times is because of a bug in celery itself. When they fix the bug we will re-work the API. Ticket is here:

If you use celerybeat scheduler you need to run with the -B flag to run beat and worker at the same time or you can launch it separately like this:

celery beat -A pyramid_celery.celery_app --ini development.ini


If you use the .ini configuration (i.e don’t use then the logging configuration will be loaded from the .ini and will not use the default celery loggers.

If you want use the default celery loggers then you can set CELERYD_HIJACK_ROOT_LOGGER=True in the [celery] section of your .ini


To see it all in action check out examples/long_running_with_tm, run redis-server and then do:

$ python develop
$ populate_long_running_with_tm development.ini
$ pserve ./development.ini
$ celery worker -A pyramid_celery.celery_app --ini development.ini

Project details

Download files

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

Source Distribution

pyramid_celery-2.0.0-rc3.tar.gz (5.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page