django-admin-applist-order 0.1.1a0__tar.gz

django_admin_applist_order-0.1.1a0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

django_admin_applist_order-0.1.1a0/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: django-admin-applist-order
+Version: 0.1.1a0
+Summary: 
+License-File: LICENSE
+Author: Alon Palgy
+Requires-Python: >=3.8
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: django (>=6.0.6,<7.0.0)
+Description-Content-Type: text/markdown
+
+# django-admin-applist-order
+
+Order the Django admin **app list** — the apps shown on the admin index, and
+the models within each app — from a single dict in your `settings.py`.
+
+It works through a middleware that post-processes the admin's response, so you
+**don't** need to swap your `AdminSite` or change any admin registration. Add
+one line to `MIDDLEWARE`, define the setting, done.
+
+## Install
+
+```bash
+pip install django-admin-applist-order
+```
+
+## Setup
+
+Add the middleware (this is the only required step):
+
+```python
+MIDDLEWARE = [
+    # ...
+    "django_admin_applist_order.middleware.AppListOrderMiddleware",
+]
+```
+
+## Usage
+
+Define `ADMIN_APPS_DISPLAY_ORDER` in `settings.py`. Keys are app labels (the
+app's folder name, e.g. `core`, `auth`).
+
+```python 
+ADMIN_APPS_DISPLAY_ORDER = {
+    "APP_NAME": ["MODEL1", "MODEL2", "MODEL3"],
+}
+```
+
+Behaviour:
+
+- **Apps** listed in the dict appear first, in dict order. Apps not listed
+  follow, sorted alphabetically by their display name.
+- **Models** listed for an app appear first, in that order, followed by any
+  unlisted models sorted alphabetically.
+- An **empty list** means "show all of this app's models, sorted alphabetically".
+- If the setting is missing or empty, the package does nothing.
+
+For example, ordering the blog app's models first, and then the auth app's models:
+
+```python
+ADMIN_APPS_DISPLAY_ORDER = {
+    "blog": ["Author", "Post"],  # these first, alphabetical order will show the rest of the blog app models
+    "auth": [],  # listed app, but all models will appear by  alphabetical
+}
+```
+
+## How it works
+
+Django builds the app list in the response context under `app_list` (the
+index page) and `available_apps` (the nav sidebar). The middleware reorders
+those lists in `process_template_response` according to your setting. Because
+it only touches the rendered context, it composes cleanly with a default
+`admin.site` or any custom `AdminSite`.

django_admin_applist_order-0.1.1a0/README.md

@@ -0,0 +1,62 @@
+# django-admin-applist-order
+
+Order the Django admin **app list** — the apps shown on the admin index, and
+the models within each app — from a single dict in your `settings.py`.
+
+It works through a middleware that post-processes the admin's response, so you
+**don't** need to swap your `AdminSite` or change any admin registration. Add
+one line to `MIDDLEWARE`, define the setting, done.
+
+## Install
+
+```bash
+pip install django-admin-applist-order
+```
+
+## Setup
+
+Add the middleware (this is the only required step):
+
+```python
+MIDDLEWARE = [
+    # ...
+    "django_admin_applist_order.middleware.AppListOrderMiddleware",
+]
+```
+
+## Usage
+
+Define `ADMIN_APPS_DISPLAY_ORDER` in `settings.py`. Keys are app labels (the
+app's folder name, e.g. `core`, `auth`).
+
+```python 
+ADMIN_APPS_DISPLAY_ORDER = {
+    "APP_NAME": ["MODEL1", "MODEL2", "MODEL3"],
+}
+```
+
+Behaviour:
+
+- **Apps** listed in the dict appear first, in dict order. Apps not listed
+  follow, sorted alphabetically by their display name.
+- **Models** listed for an app appear first, in that order, followed by any
+  unlisted models sorted alphabetically.
+- An **empty list** means "show all of this app's models, sorted alphabetically".
+- If the setting is missing or empty, the package does nothing.
+
+For example, ordering the blog app's models first, and then the auth app's models:
+
+```python
+ADMIN_APPS_DISPLAY_ORDER = {
+    "blog": ["Author", "Post"],  # these first, alphabetical order will show the rest of the blog app models
+    "auth": [],  # listed app, but all models will appear by  alphabetical
+}
+```
+
+## How it works
+
+Django builds the app list in the response context under `app_list` (the
+index page) and `available_apps` (the nav sidebar). The middleware reorders
+those lists in `process_template_response` according to your setting. Because
+it only touches the rendered context, it composes cleanly with a default
+`admin.site` or any custom `AdminSite`.

django_admin_applist_order-0.1.1a0/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "django-admin-applist-order"
+version = "0.1.1a0"
+description = ""
+authors = [
+    { name = "Alon Palgy" }
+]
+readme = "README.md"
+classifiers = [
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+requires-python = ">=3.8"
+dependencies = [
+    "django (>=6.0.6,<7.0.0)"
+]
+
+
+[tool.poetry]
+packages = [{ include = "django_admin_applist_order", from = "src" }]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+

django_admin_applist_order-0.1.1a0/src/django_admin_applist_order/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

django_admin_applist_order-0.1.1a0/src/django_admin_applist_order/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AdminApplistOrderConfig(AppConfig):
+    name = 'django_admin_applist_order'

django_admin_applist_order-0.1.1a0/src/django_admin_applist_order/middleware.py

@@ -0,0 +1,43 @@
+from django.conf import settings
+
+from .reorder import reorder_app_list
+
+# Context keys Django populates with the app list: the index page uses
+# ``app_list`` and the nav sidebar (each_context) uses ``available_apps``.
+_APP_LIST_KEYS = ("app_list", "available_apps")
+
+import logging
+logger = logging.getLogger(__name__)
+
+class AppListOrderMiddleware:
+    """Reorder the admin app list according to ``settings.ADMIN_APPS_DISPLAY_ORDER``.
+
+    This works by post-processing the admin's ``TemplateResponse`` context, so
+    it needs no changes to your ``AdminSite`` or to any admin registration.
+    Just add it to ``MIDDLEWARE`` and define the setting.
+
+    If the setting is missing or empty, the middleware is a no-op.
+    """
+
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        return self.get_response(request)
+
+    def process_template_response(self, request, response):
+        apps_order = getattr(settings, "ADMIN_APPS_DISPLAY_ORDER", None)
+        if not apps_order:
+            logger.debug("ADMIN_APPS_DISPLAY_ORDER not found in settings.py, skipping")
+            return response
+
+        context = getattr(response, "context_data", None)
+        if not context:
+            return response
+
+        for key in _APP_LIST_KEYS:
+            value = context.get(key)
+            if isinstance(value, list):
+                context[key] = reorder_app_list(value, apps_order)
+
+        return response

django_admin_applist_order-0.1.1a0/src/django_admin_applist_order/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

django_admin_applist_order-0.1.1a0/src/django_admin_applist_order/reorder.py

@@ -0,0 +1,64 @@
+"""Pure reordering logic, deliberately framework-free so it's easy to test.
+
+The functions here operate on the plain list-of-dicts structure Django builds
+for the admin index and nav sidebar. Each app dict has ``app_label``, ``name``
+and ``models``; each model dict has ``object_name`` and ``name``.
+"""
+
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def reorder_app_list(app_list, apps_order):
+    """Return a new app list ordered according to ``apps_order``.
+
+    ``apps_order`` is the ADMIN_APPS_DISPLAY_ORDER mapping::
+
+        {app_label: [ModelName, ...]}
+
+    Rules:
+      * Apps listed in the mapping come first, in mapping order.
+      * Apps not listed follow, sorted alphabetically by their display name.
+      * Within an app, models listed in the value come first (in that order),
+        followed by any unlisted models sorted alphabetically.
+      * An empty list for an app means "all models, sorted alphabetically".
+    """
+    app_dict = {app["app_label"]: app for app in app_list}
+
+    listed_labels = [label for label in apps_order if label in app_dict]
+    unlisted_labels = sorted(
+        (label for label in app_dict if label not in apps_order),
+        key=lambda label: app_dict[label]["name"].lower(),
+    )
+
+    ordered = [app_dict[label] for label in listed_labels]
+    ordered += [app_dict[label] for label in unlisted_labels]
+
+    for app in ordered:
+        _order_models(app, apps_order.get(app["app_label"], []))
+
+    return ordered
+
+
+def _order_models(app, model_order):
+    """Reorder ``app['models']`` in place according to ``model_order``."""
+    wanted = [name.lower() for name in model_order]
+
+    model_by_name = {model["object_name"].lower(): model for model in app["models"]}
+    listed = []
+    for name in wanted:
+        model = model_by_name.get(name)
+        if model is None:
+            logger.warning("model %r not found in app %r, skipping", name, app["app_label"])
+        else:
+            listed.append(model)
+    unlisted = sorted(
+        (
+            model
+            for model in app["models"]
+            if model["object_name"].lower() not in wanted
+        ),
+        key=lambda model: model["name"],
+    )
+    app["models"] = listed + unlisted

django_admin_applist_order-0.1.1a0/src/django_admin_applist_order/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

django_admin_applist_order-0.1.1a0/src/django_admin_applist_order/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.