Django Custom Management Command

Reading Time : ~ .

In Django project, We could manage by executing some commands which could be invoked through the manage.py.

For example:

# Sync database
python manage.py syncdb

# Start the webserver
python manage.py runserver

Management Command is used to create our own actions with manage.py.

If your app is in projectdirectory then create the directories projectdirectory/app/management/commands.

Create an empty file called __init__.py in both the management and commands directories. Once you’ve done that every other python file in the commands directory can be executed via manage.py.

If you create the file project/app/management/commands/management_command.py. Django will register a manage.py command for each Python module in that directory whose name doesn’t begin with an underscore, then it can be run as manage.py management_command.

In the app which the command is used for make the following directory structure:

management/
    __init__.py
    commands/
        __init__.py
        your_command_name.py


from django.core.management.base import BaseCommand, CommandError

from django.conf import settings

from django.core.management import call_command

import json

class Command(BaseCommand):

    args = ''

    help = 'Loads the initial data in to database'

    def handle(self, *args, **options):
        # Your Code
        call_command('loaddata', 'peeldb/fixtures/countries.json', verbosity=0)
        call_command('loaddata', 'peeldb/fixtures/states.json', verbosity=0)
        call_command('loaddata', 'peeldb/fixtures/cities.json', verbosity=0)
        call_command('loaddata', 'peeldb/fixtures/skills.json', verbosity=0)
        call_command('loaddata', 'peeldb/fixtures/industries.json', verbosity=0)
        call_command('loaddata', 'peeldb/fixtures/qualification.json', verbosity=0)
        result = {'message': "Successfully Loading initial data"}
        return json.dumps(result)
 

In the above example, i'm using management command to load the initial data from the fixtures into the database.In the above code, call_command calls the built in management commands, with the given options and args/kwargs.

Some examples:
call_command(‘syncdb’), call_command(‘shell’, plain=True), call_command(‘sqlall’, ‘myapp’)

    By Posted On
SENIOR DEVELOPER at MICROPYRAMID

Need any Help in your Project?Let's Talk

Latest Comments
Related Articles
Google plus API integration with django Nikhila Mergu

Using GPlus integration, we can get the user verified email id, general information, friends in a less span of time, and user can also share ...

Continue Reading...
Factory Boy - An alternative for Fixtures Shirisha Gaddi

Factory Boy is a fixtures replacement tool. It allows you to use objects customized for the current test, while only declaring the test-specific fields. For ...

Continue Reading...
Understanding Checkout flow in Django Oscar. Shirisha Gaddi

Explaining Django Oscar checkout flow.

Continue Reading...

Subscribe To our news letter

Subscribe to our news letter to receive latest blog posts into your inbox. Please fill your email address in the below form.
*We don't provide your email contact details to any third parties