Reference

██████╗      ██╗ █████╗ ███╗   ██╗ ██████╗  ██████╗
██╔══██╗     ██║██╔══██╗████╗  ██║██╔════╝ ██╔═══██╗
██║  ██║     ██║███████║██╔██╗ ██║██║  ███╗██║   ██║
██║  ██║██   ██║██╔══██║██║╚██╗██║██║   ██║██║   ██║
██████╔╝╚█████╔╝██║  ██║██║ ╚████║╚██████╔╝╚██████╔╝
╚═════╝  ╚════╝ ╚═╝  ╚═╝╚═╝  ╚═══╝ ╚═════╝  ╚═════╝

   ████████╗██╗   ██╗██████╗ ███████╗██████╗
   ╚══██╔══╝╚██╗ ██╔╝██╔══██╗██╔════╝██╔══██╗
      ██║    ╚████╔╝ ██████╔╝█████╗  ██████╔╝
      ██║     ╚██╔╝  ██╔═══╝ ██╔══╝  ██╔══██╗
      ██║      ██║   ██║     ███████╗██║  ██║
      ╚═╝      ╚═╝   ╚═╝     ╚══════╝╚═╝  ╚═╝

django-typer provides an extension class, TyperCommand, to the BaseCommand class that melds the Typer and click infrastructure with the Django infrastructure. The result is all the ease of specifying commands, groups and options and arguments using Typer and click in a way that feels like and is interface compatible with Django’s BaseCommand This should enable a smooth transition for existing Django commands and an intuitive feel for implementing new commands.

django-typer also supports shell completion for bash, zsh, fish and powershell and extends that support to native Django management commands as well.

The goal of django-typer is to provide full Typer style functionality while maintaining compatibility with the Django management command system. This means that the BaseCommand interface is preserved and the Typer interface is added on top of it. This means that this code base is more robust to changes in the Django management command system - because most of the base class functionality is preserved but many Typer and click internals are used directly to achieve this. We rely on robust CI to catch breaking changes upstream and keep a tight version lock on Typer.

Contents:

• Management
  • TyperCommand
  • BoundProxy
  • DTCommand
  • DTGroup
  • DjangoTyperMixin
  • callback()
  • command()
  • finalize()
  • get_command()
  • group()
  • initialize()
  • Context
  • Typer
  • TyperParser
  • CommandNode
  • TyperCommandMeta
• Option Types
  • ForceColor
  • HideLocals
  • NoColor
  • PythonPath
  • Settings
  • ShowLocals
  • SkipChecks
  • Traceback
  • Verbosity
  • Version
  • print_version()
  • set_force_color()
  • set_no_color()
• Completers
  • chain()
  • these_strings()
  • app_labels()
  • commands()
  • databases()
  • ModelObjectCompleter
  • date_query()
  • datetime_query()
  • duration_query()
  • float_query()
  • get_date_bounds()
  • get_time_bounds()
  • int_query()
  • text_query()
  • time_query()
  • uuid_query()
  • directories()
  • import_paths()
  • media_paths()
  • paths()
  • static_paths()
  • languages()
  • setting()
• Parsers
  • app_config()
  • ModelObjectParser
  • ReturnType
• Shell Completion
  • Command
• Shells
  • DjangoTyperShellCompleter
  • register_completion_class()
  • BashComplete
  • ZshComplete
  • PowerShellComplete
  • PwshComplete
  • FishComplete
• Utils
  • duration_iso_string()
  • get_current_command()
  • is_method()
  • model_parser_completer()
  • parse_iso_duration()
  • register_command_plugins()
  • traceback_config()