django-eadmin 0.0.1__tar.gz

django_eadmin-0.0.1/MANIFEST.in

@@ -0,0 +1,6 @@
+recursive-include eadmin/templates *.html
+recursive-include eadmin/static *
+include eadmin/py.typed
+include README.md
+include PYPI_README.md
+include THIRD_PARTY_NOTICES.md

django_eadmin-0.0.1/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: django-eadmin
+Version: 0.0.1
+Summary: A reusable Tailwind, HTMX, Alpine.js, and DaisyUI Django administration app.
+Author: EAdmin contributors
+License-Expression: LicenseRef-Proprietary
+Project-URL: Homepage, https://github.com/lqcodes/django-eadmin
+Project-URL: Source, https://github.com/lqcodes/django-eadmin
+Project-URL: Issues, https://github.com/lqcodes/django-eadmin/issues
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: Django<5.3,>=5.1
+
+# django-eadmin
+
+`django-eadmin` is a reusable, server-rendered Django administration interface
+using Tailwind CSS, DaisyUI, HTMX, and Alpine.js. It retains Django's built-in
+authentication, model permissions, forms, and audit-log semantics.
+
+## Requirements
+
+- Python 3.10+
+- Django 5.1 or 5.2
+- Django's `admin`, `auth`, `contenttypes`, `sessions`, `messages`, and
+  `staticfiles` applications
+
+## Install
+
+```bash
+python -m pip install django-eadmin
+```
+
+Add EAdmin before applications that register models:
+
+```python
+INSTALLED_APPS = [
+    "eadmin",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "articles",  # Contains articles/eadmin.py.
+]
+```
+
+Run the standard Django setup commands:
+
+```bash
+python manage.py migrate
+python manage.py createsuperuser
+```
+
+## Routes
+
+EAdmin follows Django Admin's familiar public API:
+
+```python
+from django.urls import path
+from eadmin import admin
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]
+```
+
+If native Django Admin must remain available, mount the two sites on different
+prefixes:
+
+```python
+from django.contrib import admin as django_admin
+from django.urls import path
+from eadmin import admin as eadmin_admin
+
+urlpatterns = [
+    path("admin/", eadmin_admin.site.urls),
+    path("django-admin/", django_admin.site.urls),
+]
+```
+
+## Register models
+
+Create an `eadmin.py` beside `models.py` in an installed application:
+
+```python
+from eadmin import admin
+from eadmin.registry import ModelAdmin
+from .models import Article
+
+admin.site.register(Article, ModelAdmin(
+    list_display=("title", "state", "updated_at"),
+    list_filter=("state",),
+    search_fields=("title",),
+    fields=("title", "state", "body", "tags"),
+))
+```
+
+EAdmin autodiscovers each installed application's `eadmin.py` at Django
+startup. It supports list columns, filtering, search, ordering, readonly
+fields, fieldsets, relationship widgets, actions, inlines, and custom model
+views.
+
+## Permissions
+
+EAdmin never grants access through its configuration. Users must be active,
+staff, and have Django's standard `view`, `add`, `change`, or `delete` model
+permissions. Superusers retain normal Django access. These checks apply to
+menus, lists, forms, object actions, bulk actions, and inline formsets.
+
+## Bundled browser dependencies
+
+All browser assets are included in the installed package; EAdmin makes no
+runtime CDN requests.
+
+| Dependency | Version |
+| --- | --- |
+| Tailwind CSS Play CDN | 3.4.17 |
+| DaisyUI | 4.12.24 |
+| HTMX | 2.0.4 |
+| Alpine.js | 3.17.4 |
+
+See the [source repository](https://github.com/lqcodes/django-eadmin) for
+source code and issue tracking.

django_eadmin-0.0.1/PYPI_README.md

@@ -0,0 +1,111 @@
+# django-eadmin
+
+`django-eadmin` is a reusable, server-rendered Django administration interface
+using Tailwind CSS, DaisyUI, HTMX, and Alpine.js. It retains Django's built-in
+authentication, model permissions, forms, and audit-log semantics.
+
+## Requirements
+
+- Python 3.10+
+- Django 5.1 or 5.2
+- Django's `admin`, `auth`, `contenttypes`, `sessions`, `messages`, and
+  `staticfiles` applications
+
+## Install
+
+```bash
+python -m pip install django-eadmin
+```
+
+Add EAdmin before applications that register models:
+
+```python
+INSTALLED_APPS = [
+    "eadmin",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "articles",  # Contains articles/eadmin.py.
+]
+```
+
+Run the standard Django setup commands:
+
+```bash
+python manage.py migrate
+python manage.py createsuperuser
+```
+
+## Routes
+
+EAdmin follows Django Admin's familiar public API:
+
+```python
+from django.urls import path
+from eadmin import admin
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]
+```
+
+If native Django Admin must remain available, mount the two sites on different
+prefixes:
+
+```python
+from django.contrib import admin as django_admin
+from django.urls import path
+from eadmin import admin as eadmin_admin
+
+urlpatterns = [
+    path("admin/", eadmin_admin.site.urls),
+    path("django-admin/", django_admin.site.urls),
+]
+```
+
+## Register models
+
+Create an `eadmin.py` beside `models.py` in an installed application:
+
+```python
+from eadmin import admin
+from eadmin.registry import ModelAdmin
+from .models import Article
+
+admin.site.register(Article, ModelAdmin(
+    list_display=("title", "state", "updated_at"),
+    list_filter=("state",),
+    search_fields=("title",),
+    fields=("title", "state", "body", "tags"),
+))
+```
+
+EAdmin autodiscovers each installed application's `eadmin.py` at Django
+startup. It supports list columns, filtering, search, ordering, readonly
+fields, fieldsets, relationship widgets, actions, inlines, and custom model
+views.
+
+## Permissions
+
+EAdmin never grants access through its configuration. Users must be active,
+staff, and have Django's standard `view`, `add`, `change`, or `delete` model
+permissions. Superusers retain normal Django access. These checks apply to
+menus, lists, forms, object actions, bulk actions, and inline formsets.
+
+## Bundled browser dependencies
+
+All browser assets are included in the installed package; EAdmin makes no
+runtime CDN requests.
+
+| Dependency | Version |
+| --- | --- |
+| Tailwind CSS Play CDN | 3.4.17 |
+| DaisyUI | 4.12.24 |
+| HTMX | 2.0.4 |
+| Alpine.js | 3.17.4 |
+
+See the [source repository](https://github.com/lqcodes/django-eadmin) for
+source code and issue tracking.

django_eadmin-0.0.1/README.md

@@ -0,0 +1,215 @@
+# django-eadmin
+
+`django-eadmin` is a reusable, server-rendered Django administration app built
+with Tailwind CSS, DaisyUI, HTMX, and Alpine.js. It uses Django's built-in
+authentication, model permissions, forms, and audit log semantics while
+providing a modern management UI.
+
+## Requirements
+
+- Python 3.10+
+- Django 5.1 or 5.2
+- A Django project with `django.contrib.auth`, `django.contrib.contenttypes`,
+  and `django.contrib.admin` installed
+
+## Install
+
+```bash
+python -m pip install django-eadmin
+```
+
+Add EAdmin **before the apps that register models**. No custom template loader
+or `context_processors` configuration is required:
+
+```python
+INSTALLED_APPS = [
+    "eadmin",
+    "django.contrib.admin",  # Keeps Django's native LogEntry audit trail.
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    # …other Django apps
+    "articles",  # This app contains articles/eadmin.py.
+]
+```
+
+`eadmin` automatically loads its `EAdminConfig`; the longer
+`"eadmin.apps.EAdminConfig"` form is not required.
+
+Run migrations and create a staff user as usual:
+
+```bash
+python manage.py migrate
+python manage.py createsuperuser
+```
+
+## Bundled frontend dependencies
+
+EAdmin bundles its browser dependencies inside the package. No Tailwind,
+DaisyUI, HTMX, or Alpine.js CDN request is made at runtime, so it works in
+offline and restricted-network deployments.
+
+| Dependency | Pinned version | Bundled file |
+| --- | --- | --- |
+| Tailwind CSS Play CDN | 3.4.17 | `eadmin/vendor/tailwindcss-play-3.4.17.js` |
+| DaisyUI | 4.12.24 | `eadmin/vendor/daisyui-4.12.24.min.css` |
+| HTMX | 2.0.4 | `eadmin/vendor/htmx-2.0.4.min.js` |
+| Alpine.js | 3.17.4 | `eadmin/vendor/alpinejs-3.17.4.min.js` |
+
+The assets and their MIT license notices are included in every wheel and
+source distribution. See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
+
+For package design decisions, release conventions, and the development record,
+see [docs/DEVELOPMENT_LOG.md](docs/DEVELOPMENT_LOG.md).
+
+The repository-scoped Codex skill for maintaining this package is available at
+[`.agents/skills/django-eadmin`](.agents/skills/django-eadmin/SKILL.md). It is
+automatically discovered after cloning the repository and is not distributed as
+Python runtime code.
+
+## Routes
+
+EAdmin intentionally follows Django Admin's familiar import and URL shape.
+To use EAdmin as the primary administration UI:
+
+```python
+from django.urls import path
+from eadmin import admin
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]
+```
+
+To keep both UIs during migration or debugging, use explicit aliases and
+different URL prefixes:
+
+```python
+from django.contrib import admin as django_admin
+from django.urls import path
+from eadmin import admin as eadmin_admin
+
+urlpatterns = [
+    path("admin/", eadmin_admin.site.urls),
+    path("django-admin/", django_admin.site.urls),
+]
+```
+
+Do not mount EAdmin and Django's built-in admin at the same prefix.
+
+## Register models
+
+Create an `eadmin.py` beside `models.py` in any installed Django app. EAdmin
+discovers it when Django starts, just as Django Admin discovers `admin.py`.
+
+### Basic registration
+
+```python
+from eadmin import admin
+from eadmin.registry import ModelAdmin
+from .models import Article
+
+admin.site.register(Article, ModelAdmin(
+    list_display=("title", "state", "updated_at"),
+    list_filter=("state",),
+    search_fields=("title",),
+    fields=("title", "state", "body", "tags"),
+))
+```
+
+### Complete configuration example
+
+```python
+from eadmin import admin
+from eadmin.registry import ModelAdmin, action, display
+from .models import Article
+
+
+@display(description="Status", ordering="state", renderer="tag", tag_tone="primary")
+def state_badge(article):
+    return article.get_state_display()
+
+
+@action(description="Mark selected articles as published", permissions=("change",))
+def mark_published(model_admin, request, queryset):
+    queryset.update(state=Article.State.PUBLISHED)
+
+
+admin.site.register(Article, ModelAdmin(
+    list_display=("title", "state_badge", "updated_at"),
+    display_methods={"state_badge": state_badge},
+    list_filter=("state", "author"),
+    search_fields=("title", "summary"),
+    ordering=("-updated_at",),
+    fields=("title", "slug", "summary", "body", "state", "author", "tags"),
+    readonly_fields=("slug",),
+    prepopulated_fields={"slug": ("title",)},
+    filter_horizontal=("tags",),
+    actions=(mark_published,),
+    menu_group="content",
+    menu_group_label="Content",
+    menu_group_icon="document-text",
+))
+```
+
+Use `InlineModelAdmin` in the `inlines` setting for related formsets. EAdmin
+supports list columns, filtering, search, ordering, readonly fields, grouped
+fieldsets, relationship widgets, bulk actions, inlines, and per-model custom
+views.
+
+## Permissions
+
+EAdmin never grants permissions on its own. A user must be active, staff, and
+hold Django's standard model permission: `view`, `add`, `change`, or `delete`.
+Superusers retain their normal unrestricted access. The same permission checks
+are applied to menus, lists, forms, object actions, bulk actions, and inline
+formsets; custom configuration hooks can only further restrict access.
+
+Assign users, groups, and permissions through Django Admin or an EAdmin
+registration of Django's auth models.
+
+## Configuration notes
+
+- Foreign key and one-to-one fields use a single-select widget by default.
+- Many-to-many fields use a multi-select widget by default.
+- `filter_horizontal` enables a transfer widget for selected many-to-many
+  fields; `raw_id_fields` and `autocomplete_fields` remain available for large
+  datasets.
+- EAdmin does not replace Django Admin. Keeping native Admin on a separate URL
+  is useful for migrations and emergency operations.
+
+## Development install
+
+From a checkout containing this package:
+
+```bash
+python -m pip install -e .
+```
+
+## Releases
+
+There are two release paths:
+
+- **Manual workflow run**: enter a target version and release notes. Leaving
+  the version blank automatically increments the patch version (for example,
+  `0.0.1` to `0.0.2`). Leaving notes blank generates them from commits since
+  the previous tag. The workflow updates `pyproject.toml`, writes
+  `CHANGELOG.md`, commits, tags, and creates a GitHub Release.
+- **Push a tag**: appropriate when version and changelog are maintained
+  locally. The `pyproject.toml` version must match the tag.
+
+To test the release pipeline without changing anything, run the workflow
+manually with **dry_run** enabled. It builds the package and runs `twine
+check`, but does not change the version, commit files, create a tag, upload to
+PyPI, or create a GitHub Release.
+
+For example, version `0.0.1` must be released with tag `v0.0.1`:
+
+```bash
+git tag v0.0.1
+git push origin v0.0.1
+```
+
+The workflow safely skips package files that already exist on PyPI, so
+re-running a completed release does not fail. Add the PyPI project token to
+the repository's Actions secrets as
+`PYPI_API_TOKEN`; it is never stored in this repository.

django_eadmin-0.0.1/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,12 @@
+# Third-party notices
+
+The following browser assets are distributed in `eadmin/static/eadmin/vendor/`
+so EAdmin works without runtime CDN requests. Each asset retains its upstream
+MIT license in the adjacent `LICENSE.*` file.
+
+| Dependency | Version | Asset |
+| --- | --- | --- |
+| Tailwind CSS Play CDN | 3.4.17 | `tailwindcss-play-3.4.17.js` |
+| DaisyUI | 4.12.24 | `daisyui-4.12.24.min.css` |
+| HTMX | 2.0.4 | `htmx-2.0.4.min.js` |
+| Alpine.js | 3.17.4 | `alpinejs-3.17.4.min.js` |

django_eadmin-0.0.1/django_eadmin.egg-info/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: django-eadmin
+Version: 0.0.1
+Summary: A reusable Tailwind, HTMX, Alpine.js, and DaisyUI Django administration app.
+Author: EAdmin contributors
+License-Expression: LicenseRef-Proprietary
+Project-URL: Homepage, https://github.com/lqcodes/django-eadmin
+Project-URL: Source, https://github.com/lqcodes/django-eadmin
+Project-URL: Issues, https://github.com/lqcodes/django-eadmin/issues
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: Django<5.3,>=5.1
+
+# django-eadmin
+
+`django-eadmin` is a reusable, server-rendered Django administration interface
+using Tailwind CSS, DaisyUI, HTMX, and Alpine.js. It retains Django's built-in
+authentication, model permissions, forms, and audit-log semantics.
+
+## Requirements
+
+- Python 3.10+
+- Django 5.1 or 5.2
+- Django's `admin`, `auth`, `contenttypes`, `sessions`, `messages`, and
+  `staticfiles` applications
+
+## Install
+
+```bash
+python -m pip install django-eadmin
+```
+
+Add EAdmin before applications that register models:
+
+```python
+INSTALLED_APPS = [
+    "eadmin",
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "articles",  # Contains articles/eadmin.py.
+]
+```
+
+Run the standard Django setup commands:
+
+```bash
+python manage.py migrate
+python manage.py createsuperuser
+```
+
+## Routes
+
+EAdmin follows Django Admin's familiar public API:
+
+```python
+from django.urls import path
+from eadmin import admin
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]
+```
+
+If native Django Admin must remain available, mount the two sites on different
+prefixes:
+
+```python
+from django.contrib import admin as django_admin
+from django.urls import path
+from eadmin import admin as eadmin_admin
+
+urlpatterns = [
+    path("admin/", eadmin_admin.site.urls),
+    path("django-admin/", django_admin.site.urls),
+]
+```
+
+## Register models
+
+Create an `eadmin.py` beside `models.py` in an installed application:
+
+```python
+from eadmin import admin
+from eadmin.registry import ModelAdmin
+from .models import Article
+
+admin.site.register(Article, ModelAdmin(
+    list_display=("title", "state", "updated_at"),
+    list_filter=("state",),
+    search_fields=("title",),
+    fields=("title", "state", "body", "tags"),
+))
+```
+
+EAdmin autodiscovers each installed application's `eadmin.py` at Django
+startup. It supports list columns, filtering, search, ordering, readonly
+fields, fieldsets, relationship widgets, actions, inlines, and custom model
+views.
+
+## Permissions
+
+EAdmin never grants access through its configuration. Users must be active,
+staff, and have Django's standard `view`, `add`, `change`, or `delete` model
+permissions. Superusers retain normal Django access. These checks apply to
+menus, lists, forms, object actions, bulk actions, and inline formsets.
+
+## Bundled browser dependencies
+
+All browser assets are included in the installed package; EAdmin makes no
+runtime CDN requests.
+
+| Dependency | Version |
+| --- | --- |
+| Tailwind CSS Play CDN | 3.4.17 |
+| DaisyUI | 4.12.24 |
+| HTMX | 2.0.4 |
+| Alpine.js | 3.17.4 |
+
+See the [source repository](https://github.com/lqcodes/django-eadmin) for
+source code and issue tracking.

django_eadmin-0.0.1/django_eadmin.egg-info/SOURCES.txt

@@ -0,0 +1,50 @@
+MANIFEST.in
+PYPI_README.md
+README.md
+THIRD_PARTY_NOTICES.md
+pyproject.toml
+django_eadmin.egg-info/PKG-INFO
+django_eadmin.egg-info/SOURCES.txt
+django_eadmin.egg-info/dependency_links.txt
+django_eadmin.egg-info/requires.txt
+django_eadmin.egg-info/top_level.txt
+eadmin/__init__.py
+eadmin/__init__.pyi
+eadmin/admin.py
+eadmin/apps.py
+eadmin/context_processors.py
+eadmin/forms.py
+eadmin/permissions.py
+eadmin/py.typed
+eadmin/registry.py
+eadmin/urls.py
+eadmin/views.py
+eadmin/static/eadmin/eadmin.css
+eadmin/static/eadmin/eadmin.js
+eadmin/static/eadmin/logo.svg
+eadmin/static/eadmin/vendor/LICENSE.alpinejs
+eadmin/static/eadmin/vendor/LICENSE.daisyui
+eadmin/static/eadmin/vendor/LICENSE.htmx
+eadmin/static/eadmin/vendor/LICENSE.tailwindcss
+eadmin/static/eadmin/vendor/alpinejs-3.17.4.min.js
+eadmin/static/eadmin/vendor/daisyui-4.12.24.min.css
+eadmin/static/eadmin/vendor/htmx-2.0.4.min.js
+eadmin/static/eadmin/vendor/tailwindcss-play-3.4.17.js
+eadmin/templates/eadmin/base.html
+eadmin/templates/eadmin/dashboard.html
+eadmin/templates/eadmin/login.html
+eadmin/templates/eadmin/model_detail.html
+eadmin/templates/eadmin/model_form.html
+eadmin/templates/eadmin/model_history.html
+eadmin/templates/eadmin/model_list.html
+eadmin/templates/eadmin/password_form.html
+eadmin/templates/eadmin/partials/object_table.html
+eadmin/templates/eadmin/widgets/autocomplete.html
+eadmin/templates/eadmin/widgets/datetime.html
+eadmin/templates/eadmin/widgets/multiselect.html
+eadmin/templates/eadmin/widgets/raw_id.html
+eadmin/templates/eadmin/widgets/select.html
+eadmin/templates/eadmin/widgets/transfer_select.html
+eadmin/templatetags/__init__.py
+eadmin/templatetags/eadmin.py
+eadmin/tests/__init__.py

django_eadmin-0.0.1/django_eadmin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_eadmin-0.0.1/django_eadmin.egg-info/requires.txt

@@ -0,0 +1 @@
+Django<5.3,>=5.1

django_eadmin-0.0.1/django_eadmin.egg-info/top_level.txt

@@ -0,0 +1 @@
+eadmin

django_eadmin-0.0.1/eadmin/__init__.py

@@ -0,0 +1,8 @@
+"""EAdmin: a standalone, HTMX-friendly Django management interface."""
+
+from . import admin as admin
+from .registry import site
+
+__version__ = "0.1.0"
+
+__all__ = ("admin", "site")

django_eadmin-0.0.1/eadmin/__init__.pyi

@@ -0,0 +1,9 @@
+"""Static public API for EAdmin."""
+
+from . import admin as admin
+from .registry import EAdminSite
+
+site: EAdminSite
+__version__: str
+
+__all__: tuple[str, ...]

django_eadmin-0.0.1/eadmin/admin.py

@@ -0,0 +1,11 @@
+"""Django-admin-compatible public entry point for EAdmin.
+
+Usage mirrors Django's familiar pattern::
+
+    from eadmin import admin
+    urlpatterns = [path("admin/", admin.site.urls)]
+"""
+
+from .registry import site
+
+__all__ = ("site",)