django-rich 1.0.0

Extensions for using Rich with Django.

Extensions for using Rich with Django.

Requirements

Python 3.6 to 3.10 supported.

Django 2.2 to 4.0 supported.

---

Are your tests slow? Check out my book Speed Up Your Django Tests which covers loads of best practices so you can write faster, more accurate tests.

---

Installation

1. Install with pip:

   python -m pip install django-rich

Reference

django_rich.management.RichCommand

A subclass of Django’s BaseCommand class that sets its self.console to a Rich Console. It tries to correctly enable/disable colourization based on Django’s --no-color and --force-color flags. Use this for Rich output in your management commands.

For example:

from django_rich.management import RichCommand


class Command(RichCommand):
    def handle(self, *args, **options):
        self.console.print("[bold red]Alert![/bold red]")

You can customize the construction of the Rich console by overriding the make_rich_console class attribute. This should be a callable that will construct a Console, such as a functools.partial. For example, to disable Rich’s default console markup and highlighting:

from functools import partial

from django_rich.management import RichCommand
from rich.console import Console


class Command(RichCommand):
    make_rich_console = partial(Console, markup=False, highlight=False)

    def handle(self, *args, **options):
        ...