# xldashboard
> Sometimes I use this in different projects, so I decided to put it on pypi
`xldashboard` is a more beautiful/customizable admin dashboard for Django.
- [Images](#images)
- [Installation](#installation-%EF%B8%8F)
- [Settings](#settings-%EF%B8%8F)
## Images
## Installation 🛠️
```bash
pip install xldashboard
```
## Settings ⚙️
### In `settings.py`
```python
# settings.py
from xldashboard.jazzmin_default import JAZZMIN_SETTINGS, JAZZMIN_UI_TWEAKS
INSTALLED_APPS = [
# ...
'xldashboard',
]
# xl-dashboard
XL_DASHBOARD = {
'General': {
'Users': 'app.User',
},
'And some tab again': {
'Product': 'shop_app.ProductModel',
},
...
}
```
### In `urls.py`
```python
# urls.py
from django.urls import path, include
urlpatterns = [
# ...
path('api/v1/', include('xldashboard.routes.api')),
]
```
### Customize jazzmin.py (or just copy it)
```python
# jazzmin.py
JAZZMIN_SETTINGS = {
# Заголовки и логотипы# Headlines and logos
'site_title': 'xlartas',
'site_header': 'xlartas',
'site_brand': 'xlartas',
'site_logo': '/img/icon/logo.png', # Link to logo
'site_logo_classes': '',
'site_icon': '/img/icon/logo.png', # Link to Favicon (32x32 PX)
# Logo on the entrance page
"login_logo": '/img/icon/logo.png',
"login_logo_dark": '/img/icon/logo.png',
# Text on the entrance screen
"welcome_sign": "",
# Copyright on the footer
"copyright": "xlartas © 2025",
############
# Side menu
############
"show_sidebar": True,
"navigation_expanded": True, # Default menu is deployed
"hide_apps": [], # You can hide unnecessary applications
"hide_models": [], # Hiding unnecessary models
"order_with_respect_to": [
"core",
],
# Custom links in the side menu
# "custom_links": {
# },
"user_avatar": 'avatar',
#################
# Modal windows for related objects
#################
"related_modal_active": True,
###############
# CSS and js files
###############
"custom_css": "/admin/css/jazzmin.css", # Path to CSS User
"custom_js": "/admin/js/jazzmin.js", # Path to User JS
###############
# Dark theme and interface settings
###############
"theme": "darkly", # The main topic (Dark by default)
"dark_mode_theme": "darkly", # The topic for the dark mode
# Turning on the color switch and UI configurator
# "show_ui_builder": True,
####################
# Additional interface settings
####################
"navbar_small_text": False,
"footer_small_text": False,
"body_small_text": True,
"brand_small_text": False,
"brand_colour": "navbar-dark",
"accent": "accent-lightblue",
"navbar": "navbar-dark",
"no_navbar_border": False,
"navbar_fixed": True,
"layout_boxed": False,
"footer_fixed": False,
"sidebar_fixed": True,
"sidebar": "sidebar-dark-indigo",
"sidebar_nav_small_text": False,
"sidebar_disable_expand": True,
"sidebar_nav_child_indent": False,
"sidebar_nav_compact_style": False,
"sidebar_nav_legacy_style": False,
"sidebar_nav_flat_style": False,
"button_classes": {
"primary": "btn-primary",
"secondary": "btn-secondary",
"info": "btn-info",
"warning": "btn-warning",
"danger": "btn-danger",
"success": "btn-success"
},
"actions_sticky_top": True,
}
# Additional settings for user topics, flowers and customization
JAZZMIN_UI_TWEAKS = {
"theme": "darkly", # The Dark Topic by default
"dark_mode_theme": "darkly", # The topic for the dark mode
"navbar": "navbar-dark", # Navigation panel color
"accent": "accent-lightblue", # Basic accent color
"navbar_small_text": False, # Regular text on the navigation panel
"sidebar": "sidebar-dark-indigo", # Dark side panel
"sidebar_nav_small_text": False, # Normal text in the side menu
"sidebar_disable_expand": True, # Shutdown of menu turning
"sidebar_nav_child_indent": False, # Without indentation for nested elements
"sidebar_nav_compact_style": True, # Compact navigation style
"footer_fixed": False, # Disconnection of a fixed footer
"navbar_fixed": True, # Fixed navigation panel
"actions_sticky_top": True, # Fixation of actions in the upper part of the page
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Artasov/xldashboard",
"name": "xldashboard",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "dashboard django app apps jazzmin xldashboard utils admin beautiful funcs features",
"author": "xlartas",
"author_email": "ivanhvalevskey@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/18/b0/84a6d3802021031dd931f6e7399145e4343703f4fa544b868015d0550c02/xldashboard-0.1.9.tar.gz",
"platform": null,
"description": "# xldashboard\r\n\r\n> Sometimes I use this in different projects, so I decided to put it on pypi\r\n\r\n`xldashboard` is a more beautiful/customizable admin dashboard for Django.\r\n- [Images](#images)\r\n- [Installation](#installation-%EF%B8%8F)\r\n- [Settings](#settings-%EF%B8%8F)\r\n\r\n## Images\r\n\r\n\r\n\r\n\r\n## Installation \ud83d\udee0\ufe0f\r\n\r\n```bash\r\npip install xldashboard\r\n```\r\n\r\n## Settings \u2699\ufe0f\r\n\r\n\r\n### In `settings.py`\r\n\r\n```python\r\n# settings.py\r\nfrom xldashboard.jazzmin_default import JAZZMIN_SETTINGS, JAZZMIN_UI_TWEAKS\r\n\r\nINSTALLED_APPS = [\r\n # ...\r\n 'xldashboard',\r\n]\r\n\r\n# xl-dashboard\r\nXL_DASHBOARD = {\r\n 'General': {\r\n 'Users': 'app.User',\r\n },\r\n 'And some tab again': {\r\n 'Product': 'shop_app.ProductModel',\r\n },\r\n ...\r\n}\r\n```\r\n\r\n### In `urls.py`\r\n```python\r\n# urls.py\r\nfrom django.urls import path, include\r\n\r\nurlpatterns = [\r\n # ...\r\n path('api/v1/', include('xldashboard.routes.api')),\r\n]\r\n```\r\n\r\n### Customize jazzmin.py (or just copy it)\r\n```python\r\n# jazzmin.py\r\n\r\nJAZZMIN_SETTINGS = {\r\n # \u0417\u0430\u0433\u043e\u043b\u043e\u0432\u043a\u0438 \u0438 \u043b\u043e\u0433\u043e\u0442\u0438\u043f\u044b# Headlines and logos\r\n 'site_title': 'xlartas',\r\n 'site_header': 'xlartas',\r\n 'site_brand': 'xlartas',\r\n 'site_logo': '/img/icon/logo.png', # Link to logo\r\n 'site_logo_classes': '',\r\n 'site_icon': '/img/icon/logo.png', # Link to Favicon (32x32 PX)\r\n\r\n # Logo on the entrance page\r\n \"login_logo\": '/img/icon/logo.png',\r\n \"login_logo_dark\": '/img/icon/logo.png',\r\n\r\n # Text on the entrance screen\r\n \"welcome_sign\": \"\",\r\n\r\n # Copyright on the footer\r\n \"copyright\": \"xlartas \u00a9 2025\",\r\n\r\n ############\r\n # Side menu\r\n ############\r\n \"show_sidebar\": True,\r\n \"navigation_expanded\": True, # Default menu is deployed\r\n \"hide_apps\": [], # You can hide unnecessary applications\r\n \"hide_models\": [], # Hiding unnecessary models\r\n \"order_with_respect_to\": [\r\n \"core\",\r\n ],\r\n\r\n # Custom links in the side menu\r\n # \"custom_links\": {\r\n\r\n # },\r\n \"user_avatar\": 'avatar',\r\n\r\n #################\r\n # Modal windows for related objects\r\n #################\r\n \"related_modal_active\": True,\r\n\r\n ###############\r\n # CSS and js files\r\n ###############\r\n \"custom_css\": \"/admin/css/jazzmin.css\", # Path to CSS User\r\n \"custom_js\": \"/admin/js/jazzmin.js\", # Path to User JS\r\n\r\n ###############\r\n # Dark theme and interface settings\r\n ###############\r\n \"theme\": \"darkly\", # The main topic (Dark by default)\r\n \"dark_mode_theme\": \"darkly\", # The topic for the dark mode\r\n\r\n # Turning on the color switch and UI configurator\r\n # \"show_ui_builder\": True,\r\n\r\n ####################\r\n # Additional interface settings\r\n ####################\r\n \"navbar_small_text\": False,\r\n \"footer_small_text\": False,\r\n \"body_small_text\": True,\r\n \"brand_small_text\": False,\r\n \"brand_colour\": \"navbar-dark\",\r\n \"accent\": \"accent-lightblue\",\r\n \"navbar\": \"navbar-dark\",\r\n \"no_navbar_border\": False,\r\n \"navbar_fixed\": True,\r\n \"layout_boxed\": False,\r\n \"footer_fixed\": False,\r\n \"sidebar_fixed\": True,\r\n \"sidebar\": \"sidebar-dark-indigo\",\r\n \"sidebar_nav_small_text\": False,\r\n \"sidebar_disable_expand\": True,\r\n \"sidebar_nav_child_indent\": False,\r\n \"sidebar_nav_compact_style\": False,\r\n \"sidebar_nav_legacy_style\": False,\r\n \"sidebar_nav_flat_style\": False,\r\n\r\n \"button_classes\": {\r\n \"primary\": \"btn-primary\",\r\n \"secondary\": \"btn-secondary\",\r\n \"info\": \"btn-info\",\r\n \"warning\": \"btn-warning\",\r\n \"danger\": \"btn-danger\",\r\n \"success\": \"btn-success\"\r\n },\r\n\r\n \"actions_sticky_top\": True,\r\n}\r\n\r\n# Additional settings for user topics, flowers and customization\r\nJAZZMIN_UI_TWEAKS = {\r\n \"theme\": \"darkly\", # The Dark Topic by default\r\n \"dark_mode_theme\": \"darkly\", # The topic for the dark mode\r\n \"navbar\": \"navbar-dark\", # Navigation panel color\r\n \"accent\": \"accent-lightblue\", # Basic accent color\r\n \"navbar_small_text\": False, # Regular text on the navigation panel\r\n \"sidebar\": \"sidebar-dark-indigo\", # Dark side panel\r\n \"sidebar_nav_small_text\": False, # Normal text in the side menu\r\n \"sidebar_disable_expand\": True, # Shutdown of menu turning\r\n \"sidebar_nav_child_indent\": False, # Without indentation for nested elements\r\n \"sidebar_nav_compact_style\": True, # Compact navigation style\r\n \"footer_fixed\": False, # Disconnection of a fixed footer\r\n \"navbar_fixed\": True, # Fixed navigation panel\r\n \"actions_sticky_top\": True, # Fixation of actions in the upper part of the page\r\n}\r\n```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "More beautiful/customizable admin dashboard for Django",
"version": "0.1.9",
"project_urls": {
"Homepage": "https://github.com/Artasov/xldashboard",
"Source": "https://github.com/Artasov/xldashboard",
"Tracker": "https://github.com/Artasov/xldashboard /issues"
},
"split_keywords": [
"dashboard",
"django",
"app",
"apps",
"jazzmin",
"xldashboard",
"utils",
"admin",
"beautiful",
"funcs",
"features"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9ea24f90aebcf9166b302f3e643bab6e8a78cb1fa28b293970d406beebcc4d15",
"md5": "c716d0b0317decef50bd2b07c2c0dd42",
"sha256": "ad7b4b19165fde2d511566cbecbac1cf28773a43b0205c3278320e2bd306b250"
},
"downloads": -1,
"filename": "xldashboard-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c716d0b0317decef50bd2b07c2c0dd42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 62730,
"upload_time": "2025-10-09T03:54:23",
"upload_time_iso_8601": "2025-10-09T03:54:23.283123Z",
"url": "https://files.pythonhosted.org/packages/9e/a2/4f90aebcf9166b302f3e643bab6e8a78cb1fa28b293970d406beebcc4d15/xldashboard-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "18b084a6d3802021031dd931f6e7399145e4343703f4fa544b868015d0550c02",
"md5": "f13132a7c0c4fdde2d1d291133310e2b",
"sha256": "240802a10520c4162403d19fe1008796e439e8cf8975af6600ae589ef562985a"
},
"downloads": -1,
"filename": "xldashboard-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "f13132a7c0c4fdde2d1d291133310e2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 51946,
"upload_time": "2025-10-09T03:54:24",
"upload_time_iso_8601": "2025-10-09T03:54:24.885624Z",
"url": "https://files.pythonhosted.org/packages/18/b0/84a6d3802021031dd931f6e7399145e4343703f4fa544b868015d0550c02/xldashboard-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-09 03:54:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Artasov",
"github_project": "xldashboard",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "xldashboard"
}
JSON
