跳转至

更新日志

本项目的所有重要更改都将记录在此文件中。

格式基于 Keep a Changelog, 本项目遵循 语义化版本控制

[0.1.1] - 2026-05-08

错误修复

  • 修复打包错误:修正 pyproject.tomlpackages 配置仅包含顶层包的问题,新增显式声明所有子包(contrib.*managementtemplatetagsmigrations),确保打包后完整目录结构正确分发

改进

  • 文档更新:修正 building.md 中的版本号引用

[0.1.0] - 2026-04-11

新增功能

  • Django Admin Dashboards 初始发布
  • 可定制的 Django Admin 数据看板系统
  • 数据看板组件
  • CardComponent:支持图标、趋势和多值显示的卡片组件
  • ChartComponent:使用 Chart.js 的交互式图表(折线图、柱状图、饼图、环形图、雷达图、极坐标图)
  • TableComponent:可自定义列和样式的数据表格
  • FilterComponent:数据看板数据的交互式过滤器控件
  • CustomHTMLComponent:自定义 HTML 内容集成
  • 布局系统:响应式 12 列网格布局,支持灵活的行配置
  • 深色模式支持:完全集成 Django Admin 的深色模式系统
  • URL 参数控制:?_dark_mode_on=true/false/auto
  • 自动主题检测和组件适配
  • 全屏模式:增强的全屏查看选项
  • ?_hide_others_in_fullscreen=true:在浏览器全屏时隐藏周围元素
  • ?_force_hide_others=true:始终隐藏周围元素
  • 国际化:内置
  • 可扩展的翻译系统,支持其他语言
  • 导航集成:兼容django_admin_global_sidebar
  • URL 参数控制:通过 URL 参数进行细粒度控制
  • 完整文档
  • 安装和配置指南
  • 所有组件和功能的用户指南
  • API 参考文档
  • 示例数据看板和集成示例
  • 开发和贡献指南
  • 演示项目:完整的示例项目,用于测试和演示
  • 测试套件:核心功能的全面测试覆盖
  • 现代打包:基于 Pyproject.toml 的打包,包含开发依赖
  • 示例数据看板:完整的 ExampleDashboard 展示所有组件类型
  • 示例数据模型:产品分类、产品、销售记录、客户反馈、网站访问记录
  • 数据生成命令generate_example_data 管理命令用于生成测试数据
  • 增强的过滤器FilterComponent 支持多种过滤器类型:selectdate_rangetextnumbercheckbox
  • 示例测试:完整的 ExampleDashboard 测试用例
  • 动态数据源RecentSalesDataSource 数据源,支持通过 AJAX 动态加载最近销售记录,并集成过滤器参数过滤

改进

  • 术语统一:将 "运营统计数据看板" 和 "仪表板" 统一为 "数据看板"
  • 过滤器优化:完善 FilterComponent 前后端实现和 CSS 样式
  • 文档更新:修正过滤器定义和使用示例
  • 架构重构:添加 ExampleFiltersManager 类,避免 ExampleDashboardRecentSalesDataSource 中的代码重复,实现过滤器配置和逻辑的共享

技术特性

  • 兼容 Django 5.2+
  • 支持 Python 3.8+
  • 所有屏幕尺寸的响应式设计
  • CSS 自定义属性,便于主题定制
  • JavaScript 集成,支持交互功能
  • 模板标签系统用于数据看板渲染
  • 静态文件管理,支持适当的缓存清除
  • 数据库查询优化模式
  • 性能优化建议

安全性

  • 模板中的正确 HTML 转义
  • CSRF 保护集成
  • 基于权限的数据看板渲染
  • 安全的静态文件服务

依赖项

  • Django >= 5.2
  • django-static-remixicon >= 0.1.0(用于图标)
  • Chart.js(本地包含,位于 static/django_admin_dashboards/js/chart.umd.js

安装

pip install django-admin-dashboards

文档

完整文档可在以下网址获取:https://django-admin-dashboards.readthedocs.io/

代码仓库

  • Gitee: https://gitee.com/rRR0VrFP/django-admin-dashboards
  • PyPI: https://pypi.org/project/django-admin-dashboards/

致谢

由 Django Admin Dashboards 团队进行初始开发。


注意:这是初始版本(0.1.0)。未来版本将遵循语义化版本控制。