Celery installation and setup in Django - Mini Project: Build & Apply

Celery Installation and Setup in Django

📖 Scenario: You are building a Django web application that needs to perform background tasks like sending emails or processing data without making users wait. To do this, you will set up Celery, a tool that helps run tasks in the background.

🎯 Goal: Learn how to install Celery, configure it with Django, and create a simple background task that can be run asynchronously.

📋 What You'll Learn

Install Celery package

Create a Celery instance in Django project

Configure Celery with Django settings

Write a simple Celery task

💡 Why This Matters

🌍 Real World

Many web applications need to perform time-consuming tasks like sending emails or processing files without making users wait. Celery helps by running these tasks in the background.

💼 Career

Understanding Celery setup is important for backend developers working with Django to build scalable and responsive applications.

1

Install Celery package

Install the Celery package by writing pip install celery in your terminal or command line.

Django

# Run the command to install Celery
# Your code here

Hint

Use the pip install celery command to add Celery to your project environment.

2

Create Celery instance in Django project

In your Django project folder, create a new file called celery.py. Inside it, write code to create a Celery app instance named app with the project name 'myproject'. Import os and set the default Django settings module to 'myproject.settings'.

Django

# Create celery.py file
# Your code here

Hint

Use os.environ.setdefault to set the Django settings module. Then create a Celery app with Celery('myproject').

3

Configure Celery in Django settings

Open your Django settings.py file. Add a new variable CELERY_BROKER_URL and set it to 'redis://localhost:6379/0' to use Redis as the message broker.

Django

# In settings.py
# Your code here

Hint

Set CELERY_BROKER_URL to point to your Redis server URL.

4

Write a simple Celery task

Create a new file called tasks.py inside one of your Django apps. Write a function called add that takes two arguments x and y. Decorate it with @app.task to make it a Celery task. The function should return the sum of x and y.

Django

# In tasks.py
# Your code here

Hint

Import the Celery app and use @app.task to decorate the add function.

Practice

1. What is the main purpose of using Celery in a Django project?

easy

A. To replace Django's built-in ORM

B. To create database models automatically

C. To style the frontend of the Django app

D. To run time-consuming tasks in the background without blocking the main app

Solution

1. Step 1: Understand Celery's role

   Celery is a tool for running tasks asynchronously, meaning it handles tasks in the background.

2. Step 2: Compare options

   Creating database models automatically, styling the frontend of the Django app, and replacing Django's built-in ORM are unrelated to Celery; only running time-consuming tasks in the background without blocking the main app correctly describes its purpose.

3. Final Answer:

   To run time-consuming tasks in the background without blocking the main app -> Option D

4. Quick Check:

   Celery = background task runner [OK]

Hint: Celery runs slow tasks behind scenes to keep app fast [OK]

Common Mistakes:

• Thinking Celery manages database models
• Confusing Celery with frontend styling tools
• Assuming Celery replaces Django ORM

2. Which command correctly installs Celery and Redis as the message broker for a Django project?

easy

A. pip install celery redis

B. pip install django-celery

C. pip install celery-django redis-server

D. pip install celery-redis

Solution

1. Step 1: Identify the correct packages

   Celery requires the 'celery' package and a broker like Redis, installed via 'redis' package.

2. Step 2: Evaluate commands

   Only 'pip install celery redis' installs both needed packages correctly; others are incorrect or non-existent.

3. Final Answer:

   pip install celery redis -> Option A

4. Quick Check:

   Install celery and redis packages = pip install celery redis [OK]

Hint: Use pip install celery redis to get both packages [OK]

Common Mistakes:

• Installing 'django-celery' which is outdated
• Using non-existent package names
• Forgetting to install Redis client

3. Given this Celery task in Django:

@shared_task
def add(x, y):
    return x + y

result = add.delay(4, 5)
print(result.get(timeout=10))

What will be printed when this code runs correctly?

medium

A. 9

B. delay object

C. None

D. Error: get() not found

Solution

1. Step 1: Understand task execution

   The task 'add' runs asynchronously; calling 'delay(4, 5)' queues the task to add 4 and 5.

2. Step 2: Retrieve result with get()

   'result.get(timeout=10)' waits for the task to finish and returns the sum 9.

3. Final Answer:

   9 -> Option A

4. Quick Check:

   add(4,5) = 9 [OK]

Hint: delay queues task; get() fetches result [OK]

Common Mistakes:

• Expecting delay() to return result immediately
• Confusing task object with result value
• Not using get() to wait for task completion

4. You wrote this Celery setup in your Django project:

from celery import Celery
app = Celery('proj')
app.config_from_object('django.conf:settings', namespace='CELERY')
app.autodiscover_tasks()

But your tasks are not running. What is the most likely mistake?

medium

A. Using wrong Celery import statement

B. Not running a message broker like Redis or RabbitMQ

C. Missing @shared_task decorator on tasks

D. Not calling app.start() in settings.py

Solution

1. Step 1: Check broker setup

   Celery needs a running message broker (Redis or RabbitMQ) to send and receive tasks.

2. Step 2: Analyze other options

   Imports and decorators are correct; app.start() is not required in settings.py; missing broker is common cause.

3. Final Answer:

   Not running a message broker like Redis or RabbitMQ -> Option B

4. Quick Check:

   Broker must run for tasks to work [OK]

Hint: Always start Redis or RabbitMQ before Celery workers [OK]

Common Mistakes:

• Forgetting to start Redis or RabbitMQ server
• Assuming Celery works without a broker
• Misplacing @shared_task decorator

5. You want to configure Celery in your Django project to use Redis as the broker and ensure tasks are auto-discovered. Which of the following is the correct minimal setup in your celery.py file?

hard

A. from celery import Celery
app = Celery('proj')
app.config_from_object('settings')
app.autodiscover_tasks()

B. from celery import Celery
app = Celery('proj')
app.config_from_object('django.conf:settings', namespace='CELERY')
app.autodiscover_tasks()

C. from celery import Celery
app = Celery('proj', broker='redis://localhost:6379/0')
app.autodiscover_tasks()

D. from celery import Celery
app = Celery('proj')
app.broker_url = 'redis://localhost:6379/0'
app.autodiscover_tasks()

Solution

1. Step 1: Set broker URL directly in Celery instance

   from celery import Celery app = Celery('proj', broker='redis://localhost:6379/0') app.autodiscover_tasks() correctly passes Redis broker URL when creating Celery app, which is a minimal working setup.

2. Step 2: Evaluate other options

   The first uses an invalid path to settings ('settings' instead of 'django.conf:settings'); the second requires defining CELERY_BROKER_URL in Django settings.py first; the third is correct syntax-wise but setting broker_url attribute after creation is less minimal than passing in constructor.

3. Final Answer:

   from celery import Celery app = Celery('proj', broker='redis://localhost:6379/0') app.autodiscover_tasks() -> Option C

4. Quick Check:

   Broker URL in constructor = from celery import Celery app = Celery('proj', broker='redis://localhost:6379/0') app.autodiscover_tasks() [OK]

Hint: Pass broker URL directly to Celery constructor for quick setup [OK]

Common Mistakes:

• Setting broker_url attribute instead of passing in constructor
• Misconfiguring config_from_object with wrong settings path
• Omitting broker URL causing connection failure