django-bangla-admin 0.1.0__tar.gz

django_bangla_admin-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ifte Samul Ohy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_bangla_admin-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include LICENSE
+include README.md
+recursive-include django_bangla_admin/static *
+recursive-include django_bangla_admin/templates *
+recursive-include django_bangla_admin/locale *
+global-exclude *.py[cod]
+global-exclude __pycache__
+prune example
+prune .venv

django_bangla_admin-0.1.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: django-bangla-admin
+Version: 0.1.0
+Summary: A free, Bangladeshi Django admin theme & dashboard — HTMX SPA feel, live Chart.js dashboards, Bangla ⇄ English.
+Author-email: Ifte Samul Ohy <iftesamulohy@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/iftesamulohy/django-bangla-admin
+Project-URL: Repository, https://github.com/iftesamulohy/django-bangla-admin
+Project-URL: Author, https://iftesamulohy.com
+Keywords: django,admin,theme,dashboard,bangla,bengali,htmx,jazzmin
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: Bengali
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Dynamic: license-file
+
+# django-bangla-admin
+
+> A free, open-source, reusable **Django admin theme & dashboard** built for a
+> Bangladeshi audience. SPA-feel via HTMX, live Chart.js dashboards,
+> **Bangla ⇄ English** language switching, and a single config dict — no
+> template editing for basic use.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-14B8A6.svg)](LICENSE)
+[![Django](https://img.shields.io/badge/Django-4.2%20→%205.x-0C4B33.svg)](https://www.djangoproject.com/)
+
+![Dashboard — dark, Bangla](docs/screenshots/dashboard-dark-bn.png)
+
+<p align="center">
+  <img src="docs/screenshots/dashboard-light-en.png" width="49%" alt="Dashboard — light, English">
+  <img src="docs/screenshots/changelist-dark-bn.png" width="49%" alt="Changelist — dark, Bangla">
+</p>
+
+---
+
+## Features
+
+- 🎨 **Drop-in theme** — install, add to `INSTALLED_APPS`, point your URLs at it. No template edits required.
+- ⚙️ **One config dict** (`BANGLA_ADMIN`) controls branding, menu, colors, dashboard.
+- ⚡ **SPA feel, no JS framework** — HTMX partial navigation; the admin never full-reloads.
+- 🇧🇩 **First-class Bangla** — full Bn/En UI, instant cookie-based toggle, Bengali font stack, Bangla numerals (০১২৩).
+- 📊 **Live dashboard** — stat cards, line / doughnut / bar charts (Chart.js), activity feed; charts recolor on theme/lang change.
+- 🌗 **Dark default + light mode** — persisted toggle; charts and components follow.
+- 📦 **Zero-build, offline-friendly** — prebuilt CSS, self-hosted fonts, vendored HTMX / Alpine / Chart.js. No CDN. Works on BDIX / offline VPS.
+
+## Installation
+
+```bash
+pip install django-bangla-admin
+```
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    "django_bangla_admin",      # BEFORE django.contrib.admin
+    "django.contrib.admin",
+    # ...
+]
+
+# i18n (the Django 4.2+ correct way — cookie + LocaleMiddleware)
+USE_I18N = True
+LANGUAGE_CODE = "bn"
+LANGUAGES = [("bn", "বাংলা"), ("en", "English")]
+
+MIDDLEWARE = [
+    # ...
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.locale.LocaleMiddleware",          # after Session, before Common
+    "django.middleware.common.CommonMiddleware",
+    # ...
+    "django_bangla_admin.middleware.HtmxShellMiddleware",  # strips shell on HX-Request
+]
+
+# Add the context processor for theme/language in templates
+TEMPLATES[0]["OPTIONS"]["context_processors"] += [
+    "django_bangla_admin.context_processors.bangla_admin",
+]
+
+BANGLA_ADMIN = {"site_title": "My Shop Admin", "default_language": "bn"}
+```
+
+```python
+# urls.py
+from django.urls import path
+from django_bangla_admin.sites import urls as ba_urls
+
+urlpatterns = [path("admin/", ba_urls)]
+```
+
+That's it — a fully themed, Bangla, HTMX-driven admin with charts. Your existing
+`@admin.register` / `admin.site.register` calls work unchanged: the themed site
+mirrors the default admin registry automatically.
+
+## Configuration
+
+A single `BANGLA_ADMIN` dict, deep-merged over the defaults:
+
+```python
+BANGLA_ADMIN = {
+    # Branding
+    "site_title": "Bangla Admin",
+    "site_brand": {"bn": "বাংলা অ্যাডমিন", "en": "Bangla Admin"},
+    "welcome_sign": {"bn": "স্বাগতম", "en": "Welcome"},
+
+    # Theme
+    "theme": "dark",                 # "dark" | "light"
+    "allow_theme_toggle": True,
+    "primary_color": "#2DD4BF",
+
+    # Language
+    "default_language": "bn",
+    "allow_language_toggle": True,
+    "bangla_numerals": True,
+
+    # Navigation — omit `menu` to auto-build from registered models
+    "menu": [
+        {"section": {"bn": "প্রধান", "en": "Main"}},
+        {"label": {"bn": "ড্যাশবোর্ড", "en": "Dashboard"},
+         "icon": "layout-dashboard", "url": "bangla_admin:index"},
+        {"label": {"bn": "অর্ডার", "en": "Orders"},
+         "icon": "shopping-cart", "model": "shop.Order"},
+    ],
+    "icons": {"auth.User": "user"},  # per-model Lucide icons
+    "hide_apps": [], "hide_models": [],
+
+    # Dashboard
+    "dashboard": "django_bangla_admin.dashboard.default.DefaultDashboard",
+    "show_dashboard": True,
+}
+```
+
+Read values anywhere via `from django_bangla_admin.conf import ba_conf` → `ba_conf("theme")`.
+
+## Custom dashboards
+
+```python
+from django_bangla_admin.dashboard import Dashboard, StatCard, ChartWidget, ListWidget
+
+class MyDashboard(Dashboard):
+    widgets = [
+        StatCard(label={"bn": "অর্ডার", "en": "Orders"},
+                 value=lambda r: Order.objects.count(), icon="shopping-cart", trend="+8%"),
+        ChartWidget(id="sales", kind="line",
+                    title={"bn": "বিক্রি", "en": "Sales"},
+                    data_url="bangla_admin:ba_chart_data", params={"metric": "sales"}),
+    ]
+```
+
+Point `BANGLA_ADMIN["dashboard"]` at it. Register custom chart metrics with
+`@register_metric("name")` from `django_bangla_admin.dashboard.data`, returning
+`{"labels": [...], "datasets": [...]}`.
+
+## Demo project
+
+```bash
+cd example
+python manage.py migrate
+python manage.py seed_demo      # creates admin/admin + sample shop data
+python manage.py runserver
+```
+
+Open <http://127.0.0.1:8000/admin/> and log in with **admin / admin**.
+
+## Development
+
+```bash
+pip install -e .
+python -m django test tests --settings=tests.settings   # run the suite
+python scripts/compile_messages.py                       # compile .po -> .mo (no gettext needed)
+```
+
+## Tech
+
+HTMX 2 · Alpine.js 3 · Chart.js 4 · self-hosted Hind Siliguri / Inter fonts ·
+Django 4.2 LTS → 5.x.
+
+## License
+
+MIT © [Ifte Samul Ohy](https://iftesamulohy.com)

django_bangla_admin-0.1.0/README.md

@@ -0,0 +1,163 @@
+# django-bangla-admin
+
+> A free, open-source, reusable **Django admin theme & dashboard** built for a
+> Bangladeshi audience. SPA-feel via HTMX, live Chart.js dashboards,
+> **Bangla ⇄ English** language switching, and a single config dict — no
+> template editing for basic use.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-14B8A6.svg)](LICENSE)
+[![Django](https://img.shields.io/badge/Django-4.2%20→%205.x-0C4B33.svg)](https://www.djangoproject.com/)
+
+![Dashboard — dark, Bangla](docs/screenshots/dashboard-dark-bn.png)
+
+<p align="center">
+  <img src="docs/screenshots/dashboard-light-en.png" width="49%" alt="Dashboard — light, English">
+  <img src="docs/screenshots/changelist-dark-bn.png" width="49%" alt="Changelist — dark, Bangla">
+</p>
+
+---
+
+## Features
+
+- 🎨 **Drop-in theme** — install, add to `INSTALLED_APPS`, point your URLs at it. No template edits required.
+- ⚙️ **One config dict** (`BANGLA_ADMIN`) controls branding, menu, colors, dashboard.
+- ⚡ **SPA feel, no JS framework** — HTMX partial navigation; the admin never full-reloads.
+- 🇧🇩 **First-class Bangla** — full Bn/En UI, instant cookie-based toggle, Bengali font stack, Bangla numerals (০১২৩).
+- 📊 **Live dashboard** — stat cards, line / doughnut / bar charts (Chart.js), activity feed; charts recolor on theme/lang change.
+- 🌗 **Dark default + light mode** — persisted toggle; charts and components follow.
+- 📦 **Zero-build, offline-friendly** — prebuilt CSS, self-hosted fonts, vendored HTMX / Alpine / Chart.js. No CDN. Works on BDIX / offline VPS.
+
+## Installation
+
+```bash
+pip install django-bangla-admin
+```
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    "django_bangla_admin",      # BEFORE django.contrib.admin
+    "django.contrib.admin",
+    # ...
+]
+
+# i18n (the Django 4.2+ correct way — cookie + LocaleMiddleware)
+USE_I18N = True
+LANGUAGE_CODE = "bn"
+LANGUAGES = [("bn", "বাংলা"), ("en", "English")]
+
+MIDDLEWARE = [
+    # ...
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.locale.LocaleMiddleware",          # after Session, before Common
+    "django.middleware.common.CommonMiddleware",
+    # ...
+    "django_bangla_admin.middleware.HtmxShellMiddleware",  # strips shell on HX-Request
+]
+
+# Add the context processor for theme/language in templates
+TEMPLATES[0]["OPTIONS"]["context_processors"] += [
+    "django_bangla_admin.context_processors.bangla_admin",
+]
+
+BANGLA_ADMIN = {"site_title": "My Shop Admin", "default_language": "bn"}
+```
+
+```python
+# urls.py
+from django.urls import path
+from django_bangla_admin.sites import urls as ba_urls
+
+urlpatterns = [path("admin/", ba_urls)]
+```
+
+That's it — a fully themed, Bangla, HTMX-driven admin with charts. Your existing
+`@admin.register` / `admin.site.register` calls work unchanged: the themed site
+mirrors the default admin registry automatically.
+
+## Configuration
+
+A single `BANGLA_ADMIN` dict, deep-merged over the defaults:
+
+```python
+BANGLA_ADMIN = {
+    # Branding
+    "site_title": "Bangla Admin",
+    "site_brand": {"bn": "বাংলা অ্যাডমিন", "en": "Bangla Admin"},
+    "welcome_sign": {"bn": "স্বাগতম", "en": "Welcome"},
+
+    # Theme
+    "theme": "dark",                 # "dark" | "light"
+    "allow_theme_toggle": True,
+    "primary_color": "#2DD4BF",
+
+    # Language
+    "default_language": "bn",
+    "allow_language_toggle": True,
+    "bangla_numerals": True,
+
+    # Navigation — omit `menu` to auto-build from registered models
+    "menu": [
+        {"section": {"bn": "প্রধান", "en": "Main"}},
+        {"label": {"bn": "ড্যাশবোর্ড", "en": "Dashboard"},
+         "icon": "layout-dashboard", "url": "bangla_admin:index"},
+        {"label": {"bn": "অর্ডার", "en": "Orders"},
+         "icon": "shopping-cart", "model": "shop.Order"},
+    ],
+    "icons": {"auth.User": "user"},  # per-model Lucide icons
+    "hide_apps": [], "hide_models": [],
+
+    # Dashboard
+    "dashboard": "django_bangla_admin.dashboard.default.DefaultDashboard",
+    "show_dashboard": True,
+}
+```
+
+Read values anywhere via `from django_bangla_admin.conf import ba_conf` → `ba_conf("theme")`.
+
+## Custom dashboards
+
+```python
+from django_bangla_admin.dashboard import Dashboard, StatCard, ChartWidget, ListWidget
+
+class MyDashboard(Dashboard):
+    widgets = [
+        StatCard(label={"bn": "অর্ডার", "en": "Orders"},
+                 value=lambda r: Order.objects.count(), icon="shopping-cart", trend="+8%"),
+        ChartWidget(id="sales", kind="line",
+                    title={"bn": "বিক্রি", "en": "Sales"},
+                    data_url="bangla_admin:ba_chart_data", params={"metric": "sales"}),
+    ]
+```
+
+Point `BANGLA_ADMIN["dashboard"]` at it. Register custom chart metrics with
+`@register_metric("name")` from `django_bangla_admin.dashboard.data`, returning
+`{"labels": [...], "datasets": [...]}`.
+
+## Demo project
+
+```bash
+cd example
+python manage.py migrate
+python manage.py seed_demo      # creates admin/admin + sample shop data
+python manage.py runserver
+```
+
+Open <http://127.0.0.1:8000/admin/> and log in with **admin / admin**.
+
+## Development
+
+```bash
+pip install -e .
+python -m django test tests --settings=tests.settings   # run the suite
+python scripts/compile_messages.py                       # compile .po -> .mo (no gettext needed)
+```
+
+## Tech
+
+HTMX 2 · Alpine.js 3 · Chart.js 4 · self-hosted Hind Siliguri / Inter fonts ·
+Django 4.2 LTS → 5.x.
+
+## License
+
+MIT © [Ifte Samul Ohy](https://iftesamulohy.com)

django_bangla_admin-0.1.0/django_bangla_admin/__init__.py

@@ -0,0 +1,9 @@
+"""django-bangla-admin — a Bangladeshi Django admin theme & dashboard.
+
+A free, open-source, reusable Django admin theme: HTMX SPA feel, live
+Chart.js dashboards, Bangla <-> English switching, config-driven design.
+"""
+
+__version__ = "0.1.0"
+
+default_app_config = "django_bangla_admin.apps.BanglaAdminConfig"

django_bangla_admin-0.1.0/django_bangla_admin/admin.py

@@ -0,0 +1,71 @@
+"""BanglaAdminSite — themed AdminSite with dashboard + chart-data endpoints.
+
+Drop-in replacement for ``django.contrib.admin.site``. It reuses Django's
+admin registry/permissions and only adds theming, a dashboard index, the
+language-switch view, and JSON chart-data endpoints.
+"""
+
+from django.contrib.admin import AdminSite
+from django.urls import path
+from django.utils.translation import gettext_lazy as _
+
+from .conf import ba_conf
+
+
+class BanglaAdminSite(AdminSite):
+    """A themed admin site for a Bangladeshi audience."""
+
+    # Defaults; overridden per-request from BANGLA_ADMIN via each_context.
+    site_title = ba_conf("site_title")
+    site_header = ba_conf("site_header")
+    index_title = _("Dashboard")
+    enable_nav_sidebar = False  # we render our own sidebar
+
+    def each_context(self, request):
+        context = super().each_context(request)
+        context.update(self._ba_context(request))
+        return context
+
+    def _ba_context(self, request):
+        """Inject Bangla-admin specifics shared by every admin page."""
+        from .menu import build_menu
+
+        return {
+            "ba": ba_conf.as_dict(),
+            "ba_menu": build_menu(request, self),
+        }
+
+    def get_urls(self):
+        from . import i18n, views
+
+        custom = [
+            path("ba/set-language/", self.admin_view(i18n.set_language), name="ba_set_language"),
+            path("ba/chart-data/", self.admin_view(views.chart_data), name="ba_chart_data"),
+        ]
+        # Custom routes must precede the catch-all admin URLs.
+        return custom + super().get_urls()
+
+    def index(self, request, extra_context=None):
+        """Render the dashboard if enabled, else the stock app index."""
+        if not ba_conf("show_dashboard", True):
+            return super().index(request, extra_context=extra_context)
+
+        from .dashboard.registry import get_dashboard
+
+        dashboard = get_dashboard()
+        context = {
+            **self.each_context(request),
+            "title": self.index_title,
+            "dashboard": dashboard,
+            "widgets": dashboard.render(request),
+            **(extra_context or {}),
+        }
+        request.current_app = self.name
+        from django.template.response import TemplateResponse
+
+        return TemplateResponse(request, "admin/index.html", context)
+
+
+# A shared site instance. Host projects can either use this directly or build
+# their own. ``sites.py`` exposes its URLConf as ``urls``.
+site = BanglaAdminSite(name="bangla_admin")

django_bangla_admin-0.1.0/django_bangla_admin/apps.py

@@ -0,0 +1,14 @@
+from django.apps import AppConfig
+
+
+class BanglaAdminConfig(AppConfig):
+    name = "django_bangla_admin"
+    verbose_name = "Bangla Admin"
+    default_auto_field = "django.db.models.BigAutoField"
+
+    def ready(self):
+        # Validate/normalize the BANGLA_ADMIN setting early so misconfiguration
+        # surfaces at startup rather than on first request.
+        from .conf import ba_conf  # noqa: F401
+
+        ba_conf.reload()

django_bangla_admin-0.1.0/django_bangla_admin/conf.py

@@ -0,0 +1,67 @@
+"""Lazy, cached accessor for the merged BANGLA_ADMIN configuration.
+
+Usage::
+
+    from django_bangla_admin.conf import ba_conf
+    ba_conf("theme")            # -> "dark"
+    ba_conf("menu", default=[]) # -> resolved value or default
+    ba_conf.as_dict()           # -> full merged dict
+
+The merged config is the host project's ``settings.BANGLA_ADMIN`` deep-merged
+over :data:`django_bangla_admin.settings.DEFAULTS`.
+"""
+
+import copy
+
+from django.conf import settings
+from django.dispatch import receiver
+from django.test.signals import setting_changed
+
+from .settings import DEFAULTS
+
+
+def _deep_merge(base, override):
+    """Recursively merge ``override`` onto a copy of ``base``."""
+    result = copy.deepcopy(base)
+    for key, value in (override or {}).items():
+        if (
+            key in result
+            and isinstance(result[key], dict)
+            and isinstance(value, dict)
+        ):
+            result[key] = _deep_merge(result[key], value)
+        else:
+            result[key] = copy.deepcopy(value)
+    return result
+
+
+class _Conf:
+    """Callable config accessor with a memoized merged dict."""
+
+    _cache = None
+
+    def reload(self):
+        user = getattr(settings, "BANGLA_ADMIN", {}) or {}
+        if not isinstance(user, dict):
+            raise TypeError("BANGLA_ADMIN setting must be a dict.")
+        self._cache = _deep_merge(DEFAULTS, user)
+        return self._cache
+
+    def as_dict(self):
+        if self._cache is None:
+            self.reload()
+        return self._cache
+
+    def __call__(self, key, default=None):
+        data = self.as_dict()
+        return data.get(key, default)
+
+
+ba_conf = _Conf()
+
+
+@receiver(setting_changed)
+def _reload_on_setting_change(sender, setting, **kwargs):
+    # Keep config in sync when tests use override_settings(BANGLA_ADMIN=...).
+    if setting == "BANGLA_ADMIN":
+        ba_conf.reload()

django_bangla_admin-0.1.0/django_bangla_admin/context_processors.py

@@ -0,0 +1,25 @@
+"""Template context processor injecting Bangla-admin config, language, theme.
+
+Add ``"django_bangla_admin.context_processors.bangla_admin"`` to the template
+``context_processors`` so non-admin templates (and admin templates rendered
+outside ``each_context``) can read ``ba_*`` values.
+"""
+
+from django.utils import translation
+
+from .conf import ba_conf
+
+THEME_COOKIE = "ba_theme"
+
+
+def bangla_admin(request):
+    theme = request.COOKIES.get(THEME_COOKIE) or ba_conf("theme", "dark")
+    if theme not in ("dark", "light"):
+        theme = "dark"
+    lang = translation.get_language() or ba_conf("default_language", "bn")
+    return {
+        "ba": ba_conf.as_dict(),
+        "ba_theme": theme,
+        "ba_lang": lang,
+        "ba_is_htmx": request.headers.get("HX-Request") == "true",
+    }

django_bangla_admin-0.1.0/django_bangla_admin/dashboard/__init__.py

@@ -0,0 +1,5 @@
+"""Dashboard widget system."""
+
+from .base import ChartWidget, Dashboard, ListWidget, StatCard, Widget
+
+__all__ = ["Dashboard", "Widget", "StatCard", "ChartWidget", "ListWidget"]