https://github.com/daadu/django-admintool-command

Run django mangement commands from django-admin site
https://github.com/daadu/django-admintool-command

django django-admin django-admin-tools django-application django-commands django-framework django-management-command django2

Last synced: 3 months ago
JSON representation

Run django mangement commands from django-admin site

• Host: GitHub
• URL: https://github.com/daadu/django-admintool-command
• Owner: daadu
• License: mit
• Created: 2019-08-07T16:19:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-09-25T06:40:51.000Z (over 3 years ago)
• Last Synced: 2024-09-27T16:40:59.595Z (3 months ago)
• Topics: django, django-admin, django-admin-tools, django-application, django-commands, django-framework, django-management-command, django2
• Language: Python
• Homepage: https://pypi.org/project/django-admintool-command
• Size: 33.2 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.txt
  • License: LICENSE

Awesome Lists containing this project

README

        
Django Admin Tool Command

=========================

![image](https://travis-ci.org/daadu/django-admintool-command.svg?branch=master%0A%20:target:%20https://travis-ci.org/daadu/django-admintool-command)

A reusable Django app that allows to run mangement commands from admin

site

Installation

------------

To get the latest stable release from PyPi

    pip install django-admintool-command

To get the latest commit from GitHub

    pip install -e git+git://github.com/daadu/django-admintool-command.git#egg=admintool_command

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

below):

Follow installation instructions for

Add `admintool_command` to your `INSTALLED_APPS`

    INSTALLED_APPS = (

        ...,

        'admin_tools',

        'admin_tools.menu',

        'admin_tools.dashboard',

        'admintool_command',

    )

Add the `admintool_command` URLs to your `urls.py`

    urlpatterns = [

        url(r'^admin/commands/', include('admintool_command.urls')),

    ]

> NOTE: if you are using `admin` prefixed url in Django 3.2+ for `admintool_command` and `admin.site` both then put it above the "admin" site url or else you will get HTTP 404.

Usage

-----

Commands need to inherit from admintool\_command.AdminCommand and

implement at least a Form which is used to present the command

arguments.

Then these are added to settings like:

    ADMIN_TOOLS_COMMANDS = {

        'app_name': ['command_name'],

    }

Optionally, add admintool\_command.dashboards.AdminCommandMenu to your

django-admin-tools menu.

TODO: Describe about django-admin-tools

TODO: Describe usage or point to docs. Also describe available settings

and templatetags.

Contribute

----------

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

steps

    # Fork this repository

    # Clone your fork

    virtualenv -p python3.6 venv

    source venv/bin/activate

    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

In order to run the tests, simply execute `tox`. This will install four

new environments (for Django 1.11, 2.0, 2.1 and 2.2) and run the tests

against all environments.