1. 安装

通过指定安装最新版的xadmin

pip install https://github.com/sshwsfc/xadmin/tarball/master

在配置文件中注册应用

INSTALLED_APPS = [
        ...
        'xadmin',
        'crispy_forms',
        'reversion',
        ...
]

xadmin有建立自己的数据库模型, 所以得需要进行数据库迁移

python manage.py makemigraions
python manage.py migrate

还得在总路由当中添加xadmin的信息

import xadmin
urlpatterns= [
        url(r'xadmin/', xadmin.site.urls),
]

2. 使用全局配置

如果需要使用xadmin来管理站点的话, 就得在任意app下面创建一个adminx.py的文件, 编写配置的代码
xadmin不是继承admin.ModelAdmin, 而是直接继承object

站点的配置

import xadmin
from xadmin import views
from . import models
  
class BaseSetting(object):
    """xadmin的基本配置"""
    enable_themes = True  # 开启主题切换功能
    use_bootswath = True  # 这一行也得添加上才行

xadmin.site.register(views.BaseAdminView, BaseSetting)  # 把上面自己设定的属性注册到站点

class GlobalSettings(object):
    """xadmin的全局配置"""
    site_title = "XX运营管理系统"  # 设置站点标题
    site_footer = "XX集团有限公司"  # 设置站点的页脚
    menu_style = "accordion"  # 设置菜单折叠

xadmin.site.register(views.CommAdminView, GlobalSettings)  # 同样把自己配置的选项注册到站点

站点Model管理

list_display 控制列表展示的字段
search_fields 控制可以通过搜索框搜索的字段名称，xadmin使用的是模糊查询
list_filter 可以进行过滤操作的列
ordering 默认排序的字段
readonly_fields 在编辑页面的只读字段
exclude 在编辑页面隐藏的字段
list_editable 在列表页可以快速直接编辑的字段
show_detail_fileds 在列表页提供快速显示详情信息
refresh_times 指定列表页的定时刷新
list_export 控制列表页导出数据的可选格式
show_bookmarks 控制是否显示书签功能
data_charts 控制显示图标的样式
model_icon 控制菜单的图标

model_icon 设置models.SKU在站点里面图片的样式

class SKUAadmin(object):
      model_icon = 'fa fa-gift'

xadmin.site.register(models.SKU, SKUAdmin)  # 设置models.SKU在站点里面图片的样式

list_display 设置站点给我们看到的选项列

      # 都是基于上面的类写的类属性, 下面的也是
      list_display = ['id', 'name', 'price', 'stock', 'sales', 'comments']

- image.png

search_fields 添加一个搜索框, 并且给定搜索的字段, 并且xadmin上面也会有基于它的搜索

      search_fields = ['id','name']

list_filter

      list_filter = ['category']

image.png

list_editable 可以直接在站点主页修改数据信息

      list_editable = ['price', 'stock']

image.png

show_detail_fields 可以直接在站点主页查看详情信息

      show_detail_fields = ['name']  # 指定哪列可以查看详情信息

show_bookmarks 添加书签, 可以快速到达书签位置

      show_bookmarks = True

list_export* 设定xadmin里面的导出的类型

      list_export = ['xls', 'csv', 'xml']

注意，导出到xls（excel) 需要安装xlwt扩展

refresh_times 设定刷新时间

      refresh_times =[2, 4]  # # 可选以支持按多长时间(秒)刷新页面

data_charts 制定图表

      data_charts = {
        "order_amount": {'title': '订单金额', "x-field": "create_time", "y-field": ('total_amount',),
                       "order": ('create_time',)},
        "order_count": {'title': '订单量', "x-field": "create_time", "y-field": ('total_count',),
                       "order": ('create_time',)},
    }

title 控制图标名称
x-field 控制x轴字段
y-field 控制y轴字段，可以是多个值
order 控制默认排序

readonly_fields 禁止编辑的字段

      readonly_fields = ['sales', 'comments']

自定义用户管理

xadmin会自动为admin站点添加用户的管理配置
xadmin使用xadmin.plugins.auth.UserAdmin来配置
如果需要自定义User配置的话，需要先unregister(User)，在添加自己的User配置并注册

import xadmin
# Register your models here.

from .models import User
from xadmin.plugins import auth


class UserAdmin(auth.UserAdmin):
    list_display = ['id', 'username', 'mobile', 'email', 'date_joined']
    readonly_fields = ['last_login', 'date_joined']
    search_fields = ('username', 'first_name', 'last_name', 'email', 'mobile')
    style_fields = {'user_permissions': 'm2m_transfer', 'groups': 'm2m_transfer'}

    def get_model_form(self, **kwargs):
        # org_obj, 原始数据对象(User), 判断是否有用户
        if self.org_obj is None:
            # 添加用户表单
            self.fields = ['username', 'mobile', 'is_staff']

        return super().get_model_form(**kwargs)


xadmin.site.unregister(User)  # 反注册
xadmin.site.register(User, UserAdmin)  # 自己再注册