Skip to main content

Easily run Django management commands from admin

Project description

GitHub Coveralls License Version Supported Python version Supported Django version Package format Python wheel support Package status

django-mcadmin is a Django reusable app that provides simple run management commands from admin

Installation

  • Obtain your copy of source code from the git repository: $ git clone https://github.com/vint21h/django-mcadmin.git. Or download the latest release from https://github.com/vint21h/django-mcadmin/tags/.

  • Run $ python ./setup.py install from the repository source tree or unpacked archive. Or use pip: $ pip install django-mcadmin.

Configuration

  • Add "mcadmin" to settings.INSTALLED_APPS:

# settings.py

INSTALLED_APPS += [
    "mcadmin",
]
  • Add "mcadmin" to your URLs definitions:

# urls.py

from django.urls import re_path, include


urlpatterns += [
    re_path(r"^admin/mcadmin/", include("mcadmin.urls")),
]
  • Run $ python ./manage.py migrate in your project folder to apply app migrations.

Settings

MCADMIN_EXAMPLES_PATH

Management commands files templates path. Defaults to: settings.STATIC_ROOT.

MCADMIN_UPLOADS_PATH

Management commands forms with files upload path. Defaults to: settings.MEDIA_ROOT.

MCADMIN_MODULE_NAME

Management commands admin classes search module name. Defaults to: "mcommands".

MCADMIN_USE_PERMISSIONS

Management commands admin classes search module name. Defaults to: False.

Usage

For example, exists management command like this:

# management/commands/something-useless.py

from django.core.management.base import BaseCommand


class Command(BaseCommand):

    help: str = "Useless management command"

    def add_arguments(self, parser):

        parser.add_argument(
            "--object-id",
            "-o",
            dest="object_id",
            help="Object ID",
            action="store",
            required=True,
            metavar="OBJECT_ID",
            type=int,
        )

    def handle(self, *args, **kwargs):

        self.stdout.write(kwargs.get("object_id"))

Next, you need to create a form for this management command admin which we use in the next piece of code:

# forms.py

from django import forms


class SomethingUselessManagementCommandAdminForm(forms.Form):

    object_id = forms.IntegerField(label="Object ID", required=True)

And finally, write management command admin class and register it:

# mcommands/something-useless.py

from mcadmin.command import ManagementCommandAdmin
from mcadmin.registry import registry

from forms import SomethingUselessManagementCommandAdminForm


class SomethingUselessManagementCommandAdmin(ManagementCommandAdmin):

    command: str = "something-useless"
    name: str = "Useless management command"
    form: Type[Form] = SomethingUselessManagementCommandAdminForm


# registering management command admin custom classes
registry.register(command=SomethingUselessManagementCommandAdmin)

Also, there are some helpers for building more complex flows, like management commands that can be executed directly or as a background task or management commands that handle uploaded files. For example:

Management command:

# management/commands/distributed-something-useless-with-file.py

from mcadmin.management.commands import TaskCommand


class Command(TaskCommand):

    help: str = "Useless management command which process file uploaded from a command from and can be executed directly or as background task"

    def add_arguments(self, parser):

        parser.add_argument(
            "--task",
            "-T",
            dest="as_task",
            help="Run command as background task",
            default=False,
            action="store",
            metavar="TASK",
            type=bool,
        )
        parser.add_argument(
            "--object-id",
            "-o",
            dest="object_id",
            help="Object ID",
            action="store",
            required=True,
            metavar="OBJECT_ID",
            type=int,
        )
        parser.add_argument(
            "--data",
            "-D",
            dest="data",
            help="Path to file with data",
            action="store",
            metavar="DATA",
            type=str,
        )

    def _local(self, *args, **kwargs):

        self.stdout.write(kwargs.get("object_id"))
        self.stdout.write(kwargs.get("data"))

    def _as_task(self, *args, **kwargs):

        # There must be code which executed in threads or call celery task or something else asynchronous.
        self.stdout.write(kwargs.get("object_id"))
        self.stdout.write(kwargs.get("data"))

Management command admin form:

# forms.py

from django import forms

from mcadmin.forms.helpers import (
    ManagementCommandAdminTaskForm,
    ManagementCommandAdminFilesForm
)


class DistributedSomethingUselessWithFileManagementCommandAdminForm(
    ManagementCommandAdminTaskForm,
    ManagementCommandAdminFilesForm
):

    data = forms.FileField(label="data, required=True)
    object_id = forms.IntegerField(label="Object ID", required=True)

Management command admin example file:

# mcommands/examples.py

from mcadmin.example import ManagementCommandAdminExampleFile


class DistributedSomethingUselessWithFileManagementCommandAdminExampleFile(
    ManagementCommandAdminExampleFile
):

    description: str = "Management command with files example file"
    path: str = "distributed-something-useless-with-file-example.csv"

Or for the file which not served using Django but directly available for download via HTTP:

# mcommands/examples.py

from mcadmin.example import ManagementCommandAdminExampleFile


class DistributedSomethingUselessWithFileManagementCommandAdminExampleFile(
    ManagementCommandAdminExampleFile
):

    description: str = "Management command with files example file"
    path: str = "https://www.example.com/distributed-something-useless-with-file-example.csv"
    raw: bool = True

Management command admin:

# mcommands/something-useless.py

from mcadmin.command import ManagementCommandAdmin
from mcadmin.registry import registry

from forms import DistributedSomethingUselessWithFileManagementCommandAdminForm


class DistributedSomethingUselessWithFileManagementCommandAdmin(ManagementCommandAdmin):

    command: str = "distributed-something-useless-with-file"
    name: str = "Distributed useless management command with file"
    form: Type[Form] = DistributedSomethingUselessWithFileManagementCommandAdminForm
    examples: Type[ManagementCommandAdminExampleFile] = [DistributedSomethingUselessWithFileManagementCommandAdminExampleFile]


# registering management command admin custom classes
registry.register(command=DistributedSomethingUselessWithFileManagementCommandAdmin)

Contributing

  1. Fork it

  2. Install GNU Make

  3. Install and configure pyenv and pyenv-virtualenv plugin

  4. Install and configure direnv

  5. Create environment config from example

cp .env.example .env
  1. Install development dependencies:

make install
  1. Create your fix/feature branch:

git checkout -b my-new-fix-or-feature
  1. Check code style and moreover:

make check
  1. Run tests:

make test
  1. Push to the branch:

git push origin my-new-fix-or-feature
  1. Create a new Pull Request

Licensing

django-mcadmin is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. For complete license text see COPYING file.

Contacts

Project Website: https://github.com/vint21h/django-mcadmin/

Author: Alexei Andrushievich <vint21h@vint21h.pp.ua>

For other authors list see AUTHORS file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-mcadmin-0.12.0.zip (60.0 kB view details)

Uploaded Source

Built Distribution

django_mcadmin-0.12.0-py3-none-any.whl (45.8 kB view details)

Uploaded Python 3

File details

Details for the file django-mcadmin-0.12.0.zip.

File metadata

  • Download URL: django-mcadmin-0.12.0.zip
  • Upload date:
  • Size: 60.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for django-mcadmin-0.12.0.zip
Algorithm Hash digest
SHA256 09091a76bf58b69cd1d3c7d0bbfe476a960aa5e4b6146ab8f6a131e6d55da4a2
MD5 ed9732a6de06d769e5336a6e3d06c37f
BLAKE2b-256 a77f7d38bd22d07856609b071395393a52f0fcfbcee4385fb913dada2a71dffe

See more details on using hashes here.

File details

Details for the file django_mcadmin-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: django_mcadmin-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 45.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for django_mcadmin-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a36e33b96d0da45f0abdafda74fe04f77afecbd13a9e0a3613332182cc51f5d
MD5 255880721f4634b828f9347ae68c84a0
BLAKE2b-256 122fae15bac787df8ebdeb76aa55bf2d042ee06d4de9868832e72f0514bf272d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page