With django-beanstalkd, you can code jobs as well as clients in a Django project with minimal overhead in your application. Server connections etc. all take place in django-beanstalkd and don't unnecessarily clog your application code.
This library is based in large part on Fred Wenzel's django-gearman. If you're looking for synchronous execution of jobs, check out Gearman and Fred's library! Beanstalkd is useful for background processes only.
It's the same for both the client and worker instances of your django project:
pip install -e git://github.com/jonasvp/django-beanstalkd.git#egg=django-beanstalkd
django_beanstalkd to the
INSTALLED_APPS section of
Specify the following settings in your local settings.py file if your beanstalkd server isn't accessible on port 11300 of localhost (127.0.0.1):
# My beanstalkd server BEANSTALK_SERVER = '127.0.0.1:11300' # the default value
If necessary, you can specify a pattern to be applied to your beanstalk worker functions:
# beanstalk job name pattern. Namespacing etc goes here. This is the pattern # your jobs will register as with the server, and that you'll need to use # when calling them from a non-django-beanstalkd client. # replacement patterns are: # %(app)s : django app name the job is filed under # %(job)s : job name BEANSTALK_JOB_NAME = '%(app)s.%(job)s'
For example, if you have separate staging and production servers running beanstalk jobs with the same name, you can create a separate namespace for each:
# in the settings.py for the staging server BEANSTALK_JOB_NAME = 'staging.%(app)s.%(job)s' # in the settings.py for the production server BEANSTALK_JOB_NAME = 'production.%(app)s.%(job)s'
Create a file
beanstalk_jobs.py in any of your django apps, and define as many
jobs as functions as you like. The job must accept a single string argument as
passed by the caller.
Mark each of these functions as beanstalk jobs by decorating them with
For an example, look at the
Starting a worker
To start a worker, run
python manage.py beanstalk_worker. It will start
serving all registered jobs.
To spawn more than one worker (if, e.g., most of your jobs are I/O bound),
python manage.py beanstalk_worker -w 5
will start five workers.
Since the process will keep running while waiting for and executing jobs, you probably want to run this in a screen session or similar.
To make your workers work, you need a client app passing data to them. Create
and instance of the
django_beanstalkd.BeanstalkClient class and
function with it:
from django_beanstalkd import BeanstalkClient client = BeanstalkClient() client.call('beanstalk_example.background_counting', '5')
Alternatively, to use the settings.BEANSTALK_JOB_NAME pattern,
function with explicit appname and jobname parameters:
client.call(appname='beanstalk_example', jobname='background_counting', arg='5')
For a live example look at the
beanstalk_example app, in the
management/commands/beanstalk_example_client.py file. Arguments to
func: the function name following the pattern `appname.jobname` or the pattern specified by settings.BEANSTALK_JOB_NAME arg: the argument to pass to the beanstalk job priority: an integer number that specifies the priority. Jobs with a smaller priority get executed first delay: how many seconds to wait before the job can be reserved ttr: how many seconds a worker has to process the job before it gets requeued appname: if present with jobname, will be applied to the pattern specified by settings.BEANSTALK_JOB_NAME to specify the function name. The func argument will be ignored jobname: if present with appname, used to specify the function name
For a full, working, example application, add
beanstalk_example to your
INSTALLED_APPS, then run a worker in one shell:
python manage.py beanstalk_worker -w 4
and execute the example app in another:
python manage.py beanstalk_example_client
You can see the client sending data and the worker(s) working on it.
This software is licensed under the Mozilla Tri-License:
***** BEGIN LICENSE BLOCK ***** Version: MPL 1.1/GPL 2.0/LGPL 2.1 The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/ Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. The Original Code is django-gearman. The Initial Developer of the Original Code is Mozilla. Portions created by the Initial Developer are Copyright (C) 2010 the Initial Developer. All Rights Reserved. Contributor(s): Jonas VP <firstname.lastname@example.org> Frederic Wenzel <email@example.com> Alternatively, the contents of this file may be used under the terms of either the GNU General Public License Version 2 or later (the "GPL"), or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which case the provisions of the GPL or the LGPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of either the GPL or the LGPL, and not to allow others to use your version of this file under the terms of the MPL, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL or the LGPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the MPL, the GPL or the LGPL. ***** END LICENSE BLOCK *****