InstallationΒΆ

  1. Install django-routines from pypi or clone from GitHub:

    pip install django-routines
    

    rich is a powerful library for rich text and beautiful formatting in the terminal. It is not required, but highly recommended for the best experience:

    pip install "django-routines[rich]"
    
  2. Add django_routines to your INSTALLED_APPS setting:

    INSTALLED_APPS = [
        ...
        'django_routines',
        'django_typer',  # optional!
    ]
    

    You only need to install django-typer as an app if you want to use the shellcompletion command to enable tab-completion or if you would like django-typer to install rich traceback rendering for you - which it does by default if rich is also installed.

  3. Create routines by adding them to the DJANGO_ROUTINES directive in your settings file.