Skip to content

Commit

Permalink
Update readme installation instructions (#182)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewgy8 authored Jan 18, 2025
1 parent bab0372 commit 2799924
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 17 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributors

This file lists the contributors to the `django_dramatiq` project.
This file lists the contributors to the `Django Dramatiq` project.

| Username | Name |
| :------- | :--- |
Expand Down
38 changes: 22 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,37 @@
# django_dramatiq
# Django Dramatiq

![Python Version](https://img.shields.io/pypi/pyversions/django-dramatiq)
![Django Versions](https://img.shields.io/pypi/frameworkversions/django/django-dramatiq)
[![Build Status](https://github.com/Bogdanp/django_dramatiq/actions/workflows/ci.yml/badge.svg)](https://github.com/Bogdanp/django_dramatiq/actions/workflows/ci.yml)
[![PyPI version](https://badge.fury.io/py/django-dramatiq.svg)](https://badge.fury.io/py/django-dramatiq)
[![License](https://img.shields.io/badge/License-Apache_2.0-orange.svg)](https://opensource.org/licenses/Apache-2.0)

**django_dramatiq** is a Django app that integrates with [Dramatiq][dramatiq].
Seemlessly integrate [Dramatiq][dramatiq] with your Django project!

# Contents
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Testing](#testing)
- [Middleware](#middleware)
- [Advanced Usage](#advanced-usage)
- [Third-Party Support](#third-party-support)
- [Example App](#example)

- [Installation](#installation)
- [Getting Started](#getting-started)
- [Testing](#testing)
- [Middleware](#middleware)
- [Advanced Usage](#advanced-usage)
- [Third-Party Support](#third-party-support)
- [Example App](#example)

## Installation

If you want to install it with RabbitMQ
To install, ensure both Django Dramtiq and Dramatiq are installed, along with RabbitMQ:

pip install django-dramatiq 'dramatiq[rabbitmq, watch]'
pip install django-dramatiq 'dramatiq[rabbitmq]'

Or with Redis:

Or with Redis
pip install django-dramatiq 'dramatiq[redis]'

If you would like to install with `watch`:

pip install django-dramatiq 'dramatiq[rabbitmq, watch]'

pip install django-dramatiq 'dramatiq[redis, watch]'

Add `django_dramatiq` to installed apps *before* any of your custom
apps:
Expand Down Expand Up @@ -68,7 +74,7 @@ DRAMATIQ_TASKS_DATABASE = "default"

### Declaring tasks

django_dramatiq will auto-discover tasks defined in `tasks` modules in
Django Dramatiq will auto-discover tasks defined in `tasks` modules in
each of your installed apps. For example, if you have an app named
`customers`, your tasks for that app should live in a module called
`customers.tasks`:
Expand All @@ -95,7 +101,7 @@ DRAMATIQ_AUTODISCOVER_MODULES = ["tasks", "services"]

### Running workers

django_dramatiq comes with a management command you can use to
Django Dramatiq comes with a management command you can use to
auto-discover task modules and run workers:

python manage.py rundramatiq
Expand Down Expand Up @@ -345,7 +351,7 @@ django.setup()

## Example

You can find an example application built with django_dramatiq [here](/examples/basic/README.md).
You can find an example application built with Django Dramatiq [here](/examples/basic/README.md).


[dramatiq]: https://github.com/Bogdanp/dramatiq
Expand Down

0 comments on commit 2799924

Please sign in to comment.