django-command-interface 0.5

Installation

To get the latest stable release from PyPi

pip install django-command-interface

To get the latest commit from GitHub

pip install -e git+git://github.com/bitmazk/django-command-interface.git#egg=command_interface

TODO: Describe further installation steps (edit / remove the examples below):

Add command_interface to your INSTALLED_APPS

INSTALLED_APPS = (
    ...,
    'command_interface',
)

Add the command_interface URLs to your urls.py

urlpatterns = patterns('',
    ...
    url(r'^command-interface/', include('command_interface.urls')),
)

This app uses the Django messages framework, so you need to add django.contrib.messages.middleware.MessageMiddleware to your MIDDLEWARE_CLASSES setting.

You HAVE to have DJANGO_PROJECT_ROOT in your settings pointing towards the directory of your manage.py file.

Usage

Just visit the command interface main panel at view name command_interface_main and see listed all the commands, that you can execute just by clicking “Run command”.

That’s it.

Passing arguments to the commands is still WIP.

Settings

# would list all commands of the awesome_app
COMMAND_INTERFACE_DISPLAYED_APPS = ['awesome_app']

# would on its own only show the mycommand command
COMMAND_INTERFACE_DISPLAYED_COMMANDS = ['mycommand']

Contribute

If you want to contribute to this project, please perform the following steps

# Fork this repository
# Clone your fork
mkvirtualenv -p python2.7 django-command-interface
make develop

git co -b feature_branch master
# Implement your feature and tests
git add . && git commit
git push -u origin feature_branch
# Send us a pull request for your feature branch