allen-munsch / django-click

Write Django management command using the click CLI library

Django Click

Project information:

Automated code metrics:

django-click is a library to easily write Django management commands using the click command line library.

• Free software: MIT license
• Documentation for the Click command line library: https://click.palletsprojects.com/en/8.0.x/
• Compatible with Django 2.2, 3.1, or 3.2 running on Python 3.6, 3.7, 3.8, 3.9, and PyPy.

Installation

pip install django-click

Example

Create a command module as you would usually do, but instead of creating a class, just put a djclick command into <yourapp>/management/commands/helloworld.py:

import djclick as click

@click.command()
@click.argument('name')
def command(name):
    click.secho('Hello, {}'.format(name), fg='red')

And then call the command with:

$ ./manage.py helloworld django-click
Hello, django-click

Check out the test commands for additional example commands and advanced usage.