<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Writing custom django-admin commands — Django v1.1 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '1.1', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="top" title="Django v1.1 documentation" href="../index.html" /> <link rel="up" title="“How-to” guides" href="index.html" /> <link rel="next" title="Writing custom model fields" href="custom-model-fields.html" /> <link rel="prev" title="Authentication using REMOTE_USER" href="auth-remote-user.html" /> <script type="text/javascript" src="../templatebuiltins.js"></script> <script type="text/javascript"> (function($) { if (!django_template_builtins) { // templatebuiltins.js missing, do nothing. return; } $(document).ready(function() { // Hyperlink Django template tags and filters var base = "../ref/templates/builtins.html"; if (base == "#") { // Special case for builtins.html itself base = ""; } // Tags are keywords, class '.k' $("div.highlight\\-html\\+django span.k").each(function(i, elem) { var tagname = $(elem).text(); if ($.inArray(tagname, django_template_builtins.ttags) != -1) { var fragment = tagname.replace(/_/, '-'); $(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>"); } }); // Filters are functions, class '.nf' $("div.highlight\\-html\\+django span.nf").each(function(i, elem) { var filtername = $(elem).text(); if ($.inArray(filtername, django_template_builtins.tfilters) != -1) { var fragment = filtername.replace(/_/, '-'); $(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>"); } }); }); })(jQuery); </script> </head> <body> <div class="document"> <div id="custom-doc" class="yui-t6"> <div id="hd"> <h1><a href="../index.html">Django v1.1 documentation</a></h1> <div id="global-nav"> <a title="Home page" href="../index.html">Home</a> | <a title="Table of contents" href="../contents.html">Table of contents</a> | <a title="Global index" href="../genindex.html">Index</a> | <a title="Module index" href="../modindex.html">Modules</a> </div> <div class="nav"> « <a href="auth-remote-user.html" title="Authentication using <tt class="docutils literal docutils literal docutils literal"><span class="pre">REMOTE_USER</span></tt>">previous</a> | <a href="index.html" title="&#8220;How-to&#8221; guides" accesskey="U">up</a> | <a href="custom-model-fields.html" title="Writing custom model fields">next</a> »</div> </div> <div id="bd"> <div id="yui-main"> <div class="yui-b"> <div class="yui-g" id="howto-custom-management-commands"> <div class="section" id="s-writing-custom-django-admin-commands"> <span id="s-howto-custom-management-commands"></span><span id="writing-custom-django-admin-commands"></span><span id="howto-custom-management-commands"></span><h1>Writing custom django-admin commands<a class="headerlink" href="#writing-custom-django-admin-commands" title="Permalink to this headline">¶</a></h1> <div class="versionadded"> <span class="title">New in Django 1.0:</span> <a class="reference external" href="../releases/1.0.html#releases-1-0"><em>Please, see the release notes</em></a></div> <p>Applications can register their own actions with <tt class="docutils literal"><span class="pre">manage.py</span></tt>. For example, you might want to add a <tt class="docutils literal"><span class="pre">manage.py</span></tt> action for a Django app that you’re distributing.</p> <p>To do this, just add a <tt class="docutils literal"><span class="pre">management/commands</span></tt> directory to your application. Each Python module in that directory will be auto-discovered and registered as a command that can be executed as an action when you run <tt class="docutils literal"><span class="pre">manage.py</span></tt>:</p> <div class="highlight-python"><pre>blog/ __init__.py models.py management/ __init__.py commands/ __init__.py explode.py views.py</pre> </div> <p>In this example, the <tt class="docutils literal"><span class="pre">explode</span></tt> command will be made available to any project that includes the <tt class="docutils literal"><span class="pre">blog</span></tt> application in <tt class="docutils literal"><span class="pre">settings.INSTALLED_APPS</span></tt>.</p> <p>The <tt class="docutils literal"><span class="pre">explode.py</span></tt> module has only one requirement -- it must define a class called <tt class="docutils literal"><span class="pre">Command</span></tt> that extends <tt class="docutils literal"><span class="pre">django.core.management.base.BaseCommand</span></tt>.</p> <p>For more details on how to define your own commands, look at the code for the existing <tt class="docutils literal"><span class="pre">django-admin.py</span></tt> commands, in <tt class="docutils literal"><span class="pre">/django/core/management/commands</span></tt>.</p> </div> </div> </div> </div> <div class="yui-b" id="sidebar"> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3>Browse</h3> <ul> <li>Prev: <a href="auth-remote-user.html">Authentication using <tt class="docutils literal docutils literal docutils literal"><span class="pre">REMOTE_USER</span></tt></a></li> <li>Next: <a href="custom-model-fields.html">Writing custom model fields</a></li> </ul> <h3>You are here:</h3> <ul> <li> <a href="../index.html">Django v1.1 documentation</a> <ul><li><a href="index.html">“How-to” guides</a> <ul><li>Writing custom django-admin commands</li></ul> </li></ul> </li> </ul> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/howto/custom-management-commands.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" size="18" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <h3>Last update:</h3> <p class="topless">Feb 18, 2011</p> </div> </div> <div id="ft"> <div class="nav"> « <a href="auth-remote-user.html" title="Authentication using <tt class="docutils literal docutils literal docutils literal"><span class="pre">REMOTE_USER</span></tt>">previous</a> | <a href="index.html" title="&#8220;How-to&#8221; guides" accesskey="U">up</a> | <a href="custom-model-fields.html" title="Writing custom model fields">next</a> »</div> </div> </div> <div class="clearer"></div> </div> </body> </html>