Skip to content

adminSite.md

Latest commit

 

History

History
630 lines (457 loc) · 14.5 KB

adminSite.md

File metadata and controls

630 lines (457 loc) · 14.5 KB
Raw

PRECLASS SETUP

# CREATING VIRTUAL ENVIRONMENT
# windows
py -m venv env
# windows other option
python -m venv env
# linux / Mac OS
python3 -m venv env

# ACTIVATING ENVIRONMENT
# windows
.\env\Scripts\activate
# linux / Mac OS
source env/bin/activate

# PACKAGE INSTALLATION
# if pip does not work try pip3 in linux/Mac OS
pip install django
# alternatively python -m pip install django

python -m django --version
django-admin startproject core .

pip install python-decouple
pip freeze > requirements.txt

add a gitignore file at same level as env folder

create a new file and name as .env at same level as env folder

copy your SECRET_KEY from settings.py into this .env file. Don't forget to remove quotation marks from SECRET_KEY

SECRET_KEY = django-insecure-)=b-%-w+0_^slb(exmy*mfiaj&wz6_fb4m&s=az-zs!#1^ui7j

go to settings.py, make amendments below

from decouple import config

SECRET_KEY = config('SECRET_KEY')

go to terminal

py manage.py migrate
py manage.py runserver

click the link with CTRL key pressed in the terminal and see django rocket.

go to terminal, stop project, add app

py manage.py startapp products

go to settings.py and add 'products' app to installed apps

products/models.py

from django.db import models

class Product(models.Model):
    name = models.CharField(max_length=100)
    description = models.TextField(blank=True, null=True)
    create_date = models.DateTimeField(auto_now_add=True)
    update_date = models.DateTimeField(auto_now=True)
	is_in_stock = models.BooleanField(default=True)
    slug = models.SlugField(null=True, blank=True)

    class Meta:
        verbose_name = "Product"
        verbose_name_plural = "Products"
    
    def __str__(self):
        return self.name
  • makemigrations and migrate
  • createsuperuser

products/admin.py

from django.contrib import admin
from .models import Product

admin.site.register(Product)

admin.site.site_title = "Clarusway Title"
admin.site.site_header = "Clarusway Admin Portal"  
admin.site.index_title = "Welcome to Clarusway Admin Portal"

Add data with Faker package

  • pip install Faker

py manage.py shell go to shell:

from product.models import Product
from faker import Faker
faker = Faker()

for i in range(1,200):
	product = Product(name=faker.name(),description=faker.paragraph(),is_in_stock=False)
	product.save()

go to admin site and check data

ModelAdmin options and methods

modelAdmin: got to django admin site document and modelAdmin source

some modelAdmin options:

class ProductAdmin(admin.ModelAdmin):
    list_display = ("name", "create_date", "is_in_stock", "update_date")
    list_editable = ( "is_in_stock", )
    # list_display_links = ("create_date", ) #can't add items in list_editable to here
    list_filter = ("is_in_stock", "create_date")
    ordering = ("name",)  
    search_fields = ("name",)
    prepopulated_fields = {'slug' : ('name',)}   # when adding product in admin site
    list_per_page = 25
    date_hierarchy = "update_date"
    # fields = (('name', 'slug'), 'description', "is_in_stock") #fieldset kullandığımız zaman bunu kullanamayız

    fieldsets = (
        (None, {
            "fields": (
                ('name', 'slug'), "is_in_stock" # to display multiple fields on the same line, wrap those fields in their own tuple
            ),
            # 'classes': ('wide', 'extrapretty'), wide or collapse
        }),
        ('Optionals Settings', {
            "classes" : ("collapse", ),
            "fields" : ("description",),
            'description' : "You can use this section for optionals settings"
        })
    )



admin.site.register(Product, ProductAdmin)

actions section:

   actions = ("is_in_stock", )

   def is_in_stock(self, request, queryset):
        count = queryset.update(is_in_stock=True)
        self.message_user(request, f"{count} çeşit ürün stoğa eklendi")
        
   is_in_stock.short_description = 'İşaretlenen ürünleri stoğa ekle'

Add methods to modelAdmin:

		list_display = ("name", "create_date", "is_in_stock", "update_date", "added_days_ago")    
	
	    def added_days_ago(self, product):
        	fark = timezone.now() - product.create_date
        	return fark.days

RichText Editors

WYSIWYG (what you see is what you get)

https://djangopackages.org/grids/g/wysiwyg/
https://django-ckeditor.readthedocs.io/en/latest/

  • pip install django-ckeditor

  • 'ckeditor', >>> add installed_apps

models.py

    from ckeditor.fields import RichTextField

    description = models.TextField(blank=True) >>>> description = RichTextField()

  • makemigrations and migrate

  • for extra config go to settings.py

settings.py

    CKEDITOR_CONFIGS = {
        'default' : {
            'toolbar' : 'full',
            'height' : 700,
            'width' : 1000
        }
    }
  • Note: ilgili template dosyasında: {{description | safe}}

Model Relations

  • Add new model:

models.py

class Review(models.Model):
    product = models.ForeignKey(Product, on_delete=models.CASCADE, related_name='reviews')
    review = models.TextField()
    is_released = models.BooleanField(default=True)
    created_date = models.DateField(auto_now_add=True)
    
    class Meta:
        verbose_name = 'Review'
        verbose_name_plural = 'Reviews'

    def __str__(self):
        return f"{self.product.name} - {self.review}"
  • makemigrations and migrate

admin.py

class ReviewAdmin(admin.ModelAdmin):
    list_display = ('__str__', 'created_date', 'is_released')
    list_per_page = 50
    raw_id_fields = ('product',) 

admin.site.register(Review, ReviewAdmin)

shell

from product.models import Product, Review
from faker import Faker
faker = Faker()
for product in Product.objects.iterator():
    reviews = [Review(review=faker.paragraph(), product=product) for _ in range(0,4)]
    Review.objects.bulk_create(reviews)

Review.objects.count()

TabularInline

admin.py

class ReviewInline(admin.TabularInline):  # StackedInline farklı bir görünüm aynı iş
    '''Tabular Inline View for '''
    model = Review
    extra = 1
    classes = ('collapse',)
    # min_num = 3
    # max_num = 20


class ProductAdmin(admin.ModelAdmin):
    inlines = (ReviewInline,)

custom fields

models.py

class Product(models.Model):        

    def how_many_reviews(self):
        count = self.reviews.count()
        return count
  • add productAdmin >>> list_display ("how_many_reviews")

horizontal & vertical filter (ManytoMany Field)

models.py

class Category(models.Model):
    name = models.CharField(max_length=100, verbose_name="category name")
    is_active = models.BooleanField(default=True)
    class Meta:
        verbose_name = "Category"
        verbose_name_plural = "Categories"
        
    def __str__(self):
        return self.name

class Product(models.Model):
    ...
    categories = models.ManyToManyField(Category, related_name="products")
  • makemigrations and migrate

admin.py

from .models import Product, Review, Category

    fieldsets = (
        (None, {
            "fields": (
                ('name', 'slug'), "is_in_stock" # to display multiple fields on the same line, wrap those fields in their own tuple
            ),
            # 'classes': ('wide', 'extrapretty'), wide or collapse
        }),
        ('Optionals Settings', {
            "classes" : ("collapse", ),
            "fields" : ("description", "categories"),
            'description' : "You can use this section for optionals settings"
        })
    )
    filter_horizontal = ("categories", )
   # fitler_vertical = ("categories", )

admin.site.register(Category)

Display Image Fields

settings.py

STATIC_URL = '/static/'
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'staticfiles'),
]
STATIC_ROOT = os.path.join(BASE_DIR, "static")

MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
MEDIA_URL = '/media/'

url.py

from django.contrib import admin
from django.urls import path, include
from django.conf import settings
from django.conf.urls.static import static

urlpatterns = [
    path('admin/', admin.site.urls),
]
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

models.py

from django.utils.safestring import mark_safe

product_img = models.ImageField(null=True, blank=True, default="defaults/clarusway.png", upload_to="product/")

    def bring_image(self):
        if self.product_img:
            return mark_safe(f"<img src={self.product_img.url} width=400 height=400></img>")
        return mark_safe(f"<h3>{self.name} has not image </h3>")
  • pip install pillow
  • makemigrations and migrate

admin.py

readonly_fields = ("bring_image",)

    fieldsets = (
        (None, {
            "fields": (
                ('name', 'slug'), "is_in_stock" # to display multiple fields on the same line, wrap those fields in their own tuple
            ),
            # 'classes': ('wide', 'extrapretty'), wide or collapse
        }),
        ('Optionals Settings', {
            "classes" : ("collapse", ),
            "fields" : ("description", "categories", "product_img", "bring_image"),
            'description' : "You can use this section for optionals settings"
        })
    )

listede image gösterme:

admin.py

from django.utils.safestring import mark_safe
	list_display = ("name", "create_date", "is_in_stock", "update_date", "added_days_ago", "how_many_reviews", "bring_img_to_list")    

    def bring_img_to_list(self, obj):
        if obj.product_img:
            return mark_safe(f"<img src={obj.product_img.url} width=50 height=50></img>")
        return mark_safe("******")
    
    bring_img_to_list.short_description = "product_image"

Customize templates

default directory : env/lib/django/contrib/admin/templates/admin

Liste Sayfası -> admin/change_list.html Ekleme ve Güncelleme Sayfaları -> admin/change_form.html Silme İşlemi İçin Onay Sayfası -> admin/delete_confirmation.html Modelin Geçmişi -> admin/object_history.html

admin/<extend_edilecek_sablon_adi>.html >>>>>>> admin site ana sayfa admin/<app_adi>/<extend_edilecek_sablon_adi>.html >>>>>>>>> applere özel admin/<app_adi>/<model_adi>/<extend_edilecek_sablon_adi>.html >>>>>>>>>> modellere özel

settings.py:

'DIRS': [BASE_DIR, "templates"],

ilk önce buraya bakar yoksa defaulta gider,

templates/admin/products/product/change_form.html

** içi boş olduğu için Ekleme ve Güncelleme Sayfaları boş görünecek

** default olan change_forma gidip blockları bakabiliriz istediğimizi güncelleriz extend edip

{% extends 'admin/change_form.html' %}

{% block form_top %}
    <h1>Product model new template</h1>
{% endblock  %}

admin templates extends hierarchy: base.html > base_site.html > change_form.html

templates/admin/base_site.html img directory : contrib/admin/static/admin/img/clarusway.png add clarusway.png to this directory base_site.html

{% extends 'admin/base.html' %}
{% load static %}


{% block branding %}
    <div class="myDiv">
    <img src="{% static 'admin/img/clarusway.png' %}" style="height: 50px; width: 50px;" alt="">
    <h1 id="head">
        Clarusway Admin Site
    </h1>
    </div>
{% endblock %}
{% block extrastyle %}
    <style>
        #header {
            height: 50px;
            background: #542380;
            color: #fff;
        }

        #branding h1 {
            color: #fff;
        }

        a:link,
        a:visited {
            color: #10284e;
        }

        div.breadcrumbs {
            background: #542380;
            color: #10284e;
        }

        div.breadcrumbs a {
            color: #333;
        }

        .module h2, .module caption, .inline-group h2 {
            background: #542380;
        }

        .button, input[type=submit], input[type=button], .submit-row input, a.button {
            background: #10284e;
            color: #fff;
        }
        div.myDiv {
            display: flex;
            align-items: center;
        }

    </style>
{% endblock %}

THIRD PARTY PACKAGES

List-Filter Dropdown

pip install django-admin-list-filter-dropdown

INSTALLED_APPS = ( ... 'django_admin_listfilter_dropdown', ... )

admin.py

from django_admin_listfilter_dropdown.filters import RelatedDropdownFilter


class ReviewAdmin(admin.ModelAdmin):
    list_display = ('__str__', 'created_date', 'is_released')
    list_per_page = 50
    list_filter = (
        ('product', RelatedDropdownFilter),
    )

Django admin date range filter

https://github.com/silentsokolov/django-admin-rangefilter

  • pip install django-admin-rangefilter

INSTALLED_APPS = ( ... 'rangefilter', ... )

admin.py

from rangefilter.filters import DateRangeFilter, DateTimeRangeFilter

class ProductAdmin(admin.ModelAdmin):
    list_filter = ("is_in_stock", ("create_date", DateTimeRangeFilter)) # modelde datetimefield kullandığımız için

import - export

https://django-import-export.readthedocs.io/en/latest/

  • pip install django-import-export

INSTALLED_APPS = ( ... 'import_export', )

create resources.py

from import_export import resources
from products.models import Review

class ReviewResource(resources.ModelResource):

    class Meta:
        model = Review # default all fields
        # fields = ("is_released", "product")

admin.py

from import_export.admin import ImportExportModelAdmin
from products.resources import ReviewResource

class ReviewAdmin(ImportExportModelAdmin):

    resource_class = ReviewResource

custom template (grapelli)

https://django-grappelli.readthedocs.io/en/latest/

  • pip install django-grappelli

INSTALLED_APPS = ( 'grappelli', # en üstte olacak 'django.contrib.admin', )

from django.conf.urls import include urlpatterns = [ path('grappelli/', include('grappelli.urls')), # grappelli URLS üstte olacak path('admin/', admin.site.urls), # admin site ]