Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Added some initial documentation on adding customized commands to dja…

…ngo-admin.py.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@5925 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit d743ccbc4b2e27a52cffa4a6c0e4b30a1eeb1651 1 parent 7fc5a3b
@freakboy3742 freakboy3742 authored
Showing with 29 additions and 0 deletions.
  1. +29 −0 docs/django-admin.txt
View
29 docs/django-admin.txt
@@ -603,3 +603,32 @@ distribution. It enables tab-completion of ``django-admin.py`` and
* Press [TAB] to see all available options.
* Type ``sql``, then [TAB], to see all available options whose names start
with ``sql``.
+
+Customized actions
+==================
+
+**New in Django development version**
+
+If you want to add an action of your own to ``manage.py``, you can.
+Simply add a ``management/commands`` directory to your application.
+Each python file in that directory will be discovered and registered as
+a command that can be executed as an action when you run ``manage.py``::
+
+ /fancy_blog
+ __init__.py
+ models.py
+ /management
+ __init__.py
+ /commands
+ __init__.py
+ explode.py
+ views.py
+
+In this example, ``explode`` command will be made available to any project
+that includes the ``fancy_blog`` application in ``settings.INSTALLED_APPS``.
+
+The ``explode.py`` file has only one requirement -- it must define a class
+called ``Command`` that extends ``django.core.management.base.BaseCommand``.
+
+For more details on how to define your own commands, look at the code for the
+existing ``django-admin.py`` commands, in ``/django/core/management/commands``.
Please sign in to comment.
Something went wrong with that request. Please try again.