Custom Commands

Links

• Writing custom django-admin commands

• Writing a custom management command

• Source code (trunk)

Folder structure

polls/
    __init__.py
    models.py
    management/
        __init__.py
        commands/
            __init__.py
            closepoll.py
    tests.py
    views.py

Sample

From Parsing boolean values with argparse:

# -*- encoding: utf-8 -*-
import csv

from django.core.management.base import BaseCommand


class Command(BaseCommand):

    help = "Convert 'username' #1234"

    def add_arguments(self, parser):
        parser.add_argument("--update", dest="update", action="store_true")
        parser.set_defaults(update=False)

    def handle(self, *args, **options):
        self.stdout.write(self.help)
        update = options["update"]
        if update:
            # do something useful
            pass
        self.stdout.write("\n{} - Complete".format(self.help))

Tip

Call this command with --update (or nothing for False).

Script

To create a simple python script which will run from the root of the site:

#!/usr/bin/env python2.4

from django.core.management import setup_environ
import settings

# Setup our environment
setup_environ(settings)

import sys
import traceback

from mycompany.cheese.models import stilton

l = stilton.objects.filter(active=False)
for s in l:
    if s.user:
        print "%s,%s" % (s.type, s.user.email)