summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRussell Keith-Magee <russell@keith-magee.com>2007-09-04 12:59:49 +0000
committerRussell Keith-Magee <russell@keith-magee.com>2007-09-04 12:59:49 +0000
commitf25b8cdbcdc99812299e9081cd3b03ddc08dcf74 (patch)
tree8209da7abc923844ab5896d6e8b88efa823f3b28 /docs
parent4e476b44afec10181114b6f1e06df74f4435e202 (diff)
Fixed #5212, #5222 -- Added the ability for users to register their own commands with django-admin. A previous attempt at this was introduced in [5923]-[5925], and rolled out in [5929].
git-svn-id: http://code.djangoproject.com/svn/django/trunk@6047 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
-rw-r--r--docs/django-admin.txt29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/django-admin.txt b/docs/django-admin.txt
index e3d1067dd3..e929f13109 100644
--- a/docs/django-admin.txt
+++ b/docs/django-admin.txt
@@ -619,3 +619,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 module 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`` module 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``.