File: admin_generator.rst

package info (click to toggle)
python-django-extensions 2.1.4-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 2,396 kB
  • sloc: python: 11,858; makefile: 116
file content (124 lines) | stat: -rw-r--r-- 3,642 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
admin_generator
===============

:synopsis: Generate automatic Django Admin classes by providing an app name. Outputs source code at STDOUT.


Generating automatically the admin for a given app
--------------------------------------------------

You have to provide the app_name you want the admin to be generated.

::

  $ python manage.py admin_generator <your_app_name>


Example
-------

Given the app name "brody", with the models:


::

    from django.contrib.auth import get_user_model
    from django.contrib.auth.models import User
    from django.db import models
    from django.utils.translation import gettext_lazy as _
    from isbn_field import ISBNField


    class Author(models.Model):
        first_name = models.CharField(max_length=30, verbose_name=_('First name'))
        last_name = models.CharField(max_length=40, verbose_name=_('Last name'))

        def __str__(self):
            return '{} {}'.format(self.first_name, self.last_name)

        class Meta:
            verbose_name = _('Author')
            verbose_name_plural = _('Authors')


    class Tag(models.Model):
        word = models.CharField(max_length=35, verbose_name=_('Word'))
        slug = models.CharField(max_length=50, verbose_name=_('Slug'))

        def __str__(self):
            return self.word

        class Meta:
            verbose_name = _('Tag')
            verbose_name_plural = _('Tags')


    class Book(models.Model):
        title = models.CharField(max_length=40, verbose_name=_('Title'))
        cover = models.ImageField(upload_to='book-covers', verbose_name=_('Cover'), blank=True)
        tags = models.ManyToManyField(Tag, verbose_name=_('Tags'), related_name='books')
        authors = models.ManyToManyField(Author, verbose_name=_('Authors'), related_name='books')
        publication_date = models.DateField(verbose_name=_('Publication date'))
        isbn = ISBNField(verbose_name=_('ISBN code'))

        def __str__(self):
            return self.title

        class Meta:
            verbose_name = _('Book')
            verbose_name_plural = _('Books')


    class Borrow(models.Model):
        user = models.OneToOneField(get_user_model(), verbose_name=_('Usuario'), on_delete=models.PROTECT)
        borrow_date = models.DateField(verbose_name=_('Borrow date'))
        returned_date = models.DateField(verbose_name=_('Returned date'), blank=True, null=True)
        book = models.ForeignKey(Book, verbose_name=_('Book'), on_delete=models.PROTECT)

        class Meta:
            verbose_name = _('Borrow')
            verbose_name_plural = _('Borrows')

        def __str__(self):
            return '{}_{}'.format(self.user, self.borrow_date)



the following command:

::

  $ python manage.py admin_generator brody


will output to STDOUT the following code:

::

    # -*- coding: utf-8 -*-
    from django.contrib import admin
    from .models import Author, Tag, Book, Borrow


    @admin.register(Author)
    class AuthorAdmin(admin.ModelAdmin):
        list_display = ('id', 'first_name', 'last_name')


    @admin.register(Tag)
    class TagAdmin(admin.ModelAdmin):
        list_display = ('id', 'word', 'slug')
        search_fields = ('slug',)


    @admin.register(Book)
    class BookAdmin(admin.ModelAdmin):
        list_display = ('id', 'title', 'cover', 'publication_date', 'isbn')
        list_filter = ('publication_date',)
        raw_id_fields = ('tags', 'authors')


    @admin.register(Borrow)
    class BorrowAdmin(admin.ModelAdmin):
        list_display = ('id', 'user', 'borrow_date', 'returned_date', 'book')
        list_filter = ('user', 'borrow_date', 'returned_date', 'book')