django-subadmin 3.2.3__tar.gz → 5.2.0__tar.gz

django_subadmin-5.2.0/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Django ${{ matrix.django }} / Python ${{ matrix.python }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - django: "5.2.0"
+            python: "3.10"
+            django_spec: "Django==5.2.0"
+          - django: "5.2.x (latest)"
+            python: "3.10"
+            django_spec: "Django>=5.2,<5.3"
+          - django: "5.2.x (latest)"
+            python: "3.14"
+            django_spec: "Django>=5.2,<5.3"
+          - django: "6.0.0"
+            python: "3.12"
+            django_spec: "Django==6.0.0"
+          - django: "6.0.x (latest)"
+            python: "3.12"
+            django_spec: "Django>=6.0,<6.1"
+          - django: "6.0.x (latest)"
+            python: "3.14"
+            django_spec: "Django>=6.0,<6.1"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install package and Django
+        env:
+          DJANGO_SPEC: ${{ matrix.django_spec }}
+        run: python -m pip install -e . "$DJANGO_SPEC"
+      - name: Run integration tests
+        run: python -m django test tests --settings=tests.settings
+
+  passed:
+    name: CI passed
+    needs: test
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - name: Require every test job to pass
+        env:
+          TEST_RESULT: ${{ needs.test.result }}
+        run: test "$TEST_RESULT" = success

django_subadmin-5.2.0/.github/workflows/publish.yml

@@ -0,0 +1,69 @@
+name: Build and publish to PyPI
+on:
+  push:
+    tags: ["5.2.*"]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.10"
+      - name: Install pypa/build
+        run: python3 -m pip install --upgrade build
+      - name: Build package
+        run: python3 -m build --sdist --wheel --outdir dist/ .
+      - name: Upload dist as artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: ./dist
+          if-no-files-found: error
+          retention-days: 3
+
+  pypi-publish:
+    needs: ['build']
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/django-subadmin
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifact as dist
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: pypi-publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Download distribution files
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+        run: gh release create "$GITHUB_REF_NAME" dist/* --verify-tag --notes-from-tag

{django-subadmin-3.2.3 → django_subadmin-5.2.0}/.github/workflows/publish_test.yml

@@ -1,16 +1,23 @@
 name: Build and publish to Test PyPI
 on: workflow_dispatch
 
+permissions:
+  contents: read
+
 jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+
   build:
+    needs: test
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v7
         with:
           python-version: "3.10"
       - name: Install pypa/build
@@ -18,10 +25,11 @@ jobs:
       - name: Build package
         run: python3 -m build --sdist --wheel --outdir dist/ .
       - name: Upload dist as artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v7
         with:
           name: dist
           path: ./dist
+          if-no-files-found: error
           retention-days: 1
 
   pypi-publish:
@@ -34,7 +42,10 @@ jobs:
       id-token: write
     steps:
       - name: Download artifact as dist
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
       - name: Publish package
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

django_subadmin-5.2.0/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: django-subadmin
+Version: 5.2.0
+Summary: A special kind of ModelAdmin that allows it to be nested within another ModelAdmin
+Author-email: Mitja Pagon <mitja@inueni.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/inueni/django-subadmin/
+Project-URL: Bug Tracker, https://github.com/inueni/django-subadmin/issues
+Project-URL: Changelog, https://github.com/inueni/django-subadmin/releases
+Keywords: django,admin,modeladmin,foreignkey,related field
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django<6.1,>=5.2
+Dynamic: license-file
+
+# django-subadmin
+
+`django-subadmin` lets a `ModelAdmin` live under another `ModelAdmin`. When
+related objects have outgrown an inline, a `SubAdmin` gives them their own list
+and change pages, with search, filters, and pagination scoped to a parent
+object. Subadmins can be nested several levels deep.
+
+## Compatibility
+
+| django-subadmin | Django | Python |
+| --- | --- | --- |
+| 5.2.x | 5.2, 6.0 | 3.10+ |
+| 3.2.x | 3.2, 4.x, 5.x | 3.6+ |
+
+The package version follows the oldest Django version supported by that line.
+The 5.2 release drops support for Django before 5.2 and Python before 3.10.
+
+## Installation
+
+```console
+pip install django-subadmin
+```
+
+Add `subadmin` to `INSTALLED_APPS` so Django can find its templates:
+
+```python
+INSTALLED_APPS = [
+    # Django's contrib apps and your own apps...
+    "subadmin",
+]
+```
+
+## Example
+
+The test app has a `Parent` model with related `Child` objects. Django's inline
+admin would put the children on the parent's form; a `SubAdmin` gives each
+parent its own child changelist instead.
+
+```python
+# models.py
+from django.db import models
+
+
+class Parent(models.Model):
+    name = models.CharField(max_length=100)
+
+
+class Child(models.Model):
+    parent = models.ForeignKey(Parent, on_delete=models.CASCADE)
+    name = models.CharField(max_length=100)
+```
+
+```python
+# admin.py
+from django.contrib import admin
+from subadmin import RootSubAdmin, SubAdmin
+
+from .models import Child, Parent
+
+
+class ChildAdmin(SubAdmin):
+    model = Child
+
+
+@admin.register(Parent)
+class ParentAdmin(RootSubAdmin):
+    subadmins = (ChildAdmin,)
+```
+
+Open a parent in the admin and follow the link to its child admin. The child
+pages show only records for that parent. The parent foreign key is set
+automatically when adding a child and omitted from the nested form.
+
+The [test app models](tests/testapp/models.py) and
+[admin configuration](tests/testapp/admin.py) also show deeper nesting. Their
+workflows are covered by [integration tests](tests/test_admin.py), which you
+can run from a source checkout with:
+
+```console
+python -m django test tests --settings=tests.settings
+```
+
+## Screenshots
+
+The parent change page links to its child admin.
+
+![Parent change page with a Children link](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/parent-change.png)
+
+The child changelist contains only that parent's children.
+
+![Child changelist scoped to Example parent](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/child-list.png)
+
+The child add form omits the parent foreign key, which is set automatically.
+
+![Child add form without a parent field](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/child-add.png)
+
+## Labels
+
+Set `subadmin_label` to change a subadmin link and its collection breadcrumbs
+without renaming the model:
+
+```python
+class ChildAdmin(SubAdmin):
+    model = Child
+    subadmin_label = "Members"
+```
+
+The default is the model's `verbose_name_plural`. Object breadcrumbs and other
+model names keep their usual Django wording. Override
+`get_subadmin_label(request)` if the label needs to vary by request.
+
+## Upgrading from 3.2
+
+Parent objects are now loaded through the parent admin's `get_object()` method,
+so custom `get_queryset()` filters affect nested pages. Each parent in the URL
+must also pass that admin's `has_view_or_change_permission(request, obj)` check.
+A parent hidden by the queryset returns 404; a visible parent without permission
+returns 403. Child permissions alone no longer grant access through a parent.
+
+If you need the previous direct model lookup while adapting a project, set:
+
+```python
+SUBADMIN_USE_DIRECT_PARENT_LOOKUP = True
+```
+
+This changes how parents are loaded, but does not skip the parent permission
+check.
+
+Custom overrides of `get_parent_instance()` and `get_subadmin_helper()` need to
+accept `request` as their first argument after `self`. Their signatures are now
+`get_parent_instance(self, request, parent_id)` and
+`get_subadmin_helper(self, request, view_args, object_id=None)`.
+
+`SubAdmin` wraps forms to validate parent-scoped fields. If you override
+`get_form()` or `get_changelist_form()`, call `super()` so that wrapping still
+runs.

django_subadmin-5.2.0/README.md

@@ -0,0 +1,136 @@
+# django-subadmin
+
+`django-subadmin` lets a `ModelAdmin` live under another `ModelAdmin`. When
+related objects have outgrown an inline, a `SubAdmin` gives them their own list
+and change pages, with search, filters, and pagination scoped to a parent
+object. Subadmins can be nested several levels deep.
+
+## Compatibility
+
+| django-subadmin | Django | Python |
+| --- | --- | --- |
+| 5.2.x | 5.2, 6.0 | 3.10+ |
+| 3.2.x | 3.2, 4.x, 5.x | 3.6+ |
+
+The package version follows the oldest Django version supported by that line.
+The 5.2 release drops support for Django before 5.2 and Python before 3.10.
+
+## Installation
+
+```console
+pip install django-subadmin
+```
+
+Add `subadmin` to `INSTALLED_APPS` so Django can find its templates:
+
+```python
+INSTALLED_APPS = [
+    # Django's contrib apps and your own apps...
+    "subadmin",
+]
+```
+
+## Example
+
+The test app has a `Parent` model with related `Child` objects. Django's inline
+admin would put the children on the parent's form; a `SubAdmin` gives each
+parent its own child changelist instead.
+
+```python
+# models.py
+from django.db import models
+
+
+class Parent(models.Model):
+    name = models.CharField(max_length=100)
+
+
+class Child(models.Model):
+    parent = models.ForeignKey(Parent, on_delete=models.CASCADE)
+    name = models.CharField(max_length=100)
+```
+
+```python
+# admin.py
+from django.contrib import admin
+from subadmin import RootSubAdmin, SubAdmin
+
+from .models import Child, Parent
+
+
+class ChildAdmin(SubAdmin):
+    model = Child
+
+
+@admin.register(Parent)
+class ParentAdmin(RootSubAdmin):
+    subadmins = (ChildAdmin,)
+```
+
+Open a parent in the admin and follow the link to its child admin. The child
+pages show only records for that parent. The parent foreign key is set
+automatically when adding a child and omitted from the nested form.
+
+The [test app models](tests/testapp/models.py) and
+[admin configuration](tests/testapp/admin.py) also show deeper nesting. Their
+workflows are covered by [integration tests](tests/test_admin.py), which you
+can run from a source checkout with:
+
+```console
+python -m django test tests --settings=tests.settings
+```
+
+## Screenshots
+
+The parent change page links to its child admin.
+
+![Parent change page with a Children link](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/parent-change.png)
+
+The child changelist contains only that parent's children.
+
+![Child changelist scoped to Example parent](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/child-list.png)
+
+The child add form omits the parent foreign key, which is set automatically.
+
+![Child add form without a parent field](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/child-add.png)
+
+## Labels
+
+Set `subadmin_label` to change a subadmin link and its collection breadcrumbs
+without renaming the model:
+
+```python
+class ChildAdmin(SubAdmin):
+    model = Child
+    subadmin_label = "Members"
+```
+
+The default is the model's `verbose_name_plural`. Object breadcrumbs and other
+model names keep their usual Django wording. Override
+`get_subadmin_label(request)` if the label needs to vary by request.
+
+## Upgrading from 3.2
+
+Parent objects are now loaded through the parent admin's `get_object()` method,
+so custom `get_queryset()` filters affect nested pages. Each parent in the URL
+must also pass that admin's `has_view_or_change_permission(request, obj)` check.
+A parent hidden by the queryset returns 404; a visible parent without permission
+returns 403. Child permissions alone no longer grant access through a parent.
+
+If you need the previous direct model lookup while adapting a project, set:
+
+```python
+SUBADMIN_USE_DIRECT_PARENT_LOOKUP = True
+```
+
+This changes how parents are loaded, but does not skip the parent permission
+check.
+
+Custom overrides of `get_parent_instance()` and `get_subadmin_helper()` need to
+accept `request` as their first argument after `self`. Their signatures are now
+`get_parent_instance(self, request, parent_id)` and
+`get_subadmin_helper(self, request, view_args, object_id=None)`.
+
+`SubAdmin` wraps forms to validate parent-scoped fields. If you override
+`get_form()` or `get_changelist_form()`, call `super()` so that wrapping still
+runs.

django_subadmin-5.2.0/django_subadmin.egg-info/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: django-subadmin
+Version: 5.2.0
+Summary: A special kind of ModelAdmin that allows it to be nested within another ModelAdmin
+Author-email: Mitja Pagon <mitja@inueni.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/inueni/django-subadmin/
+Project-URL: Bug Tracker, https://github.com/inueni/django-subadmin/issues
+Project-URL: Changelog, https://github.com/inueni/django-subadmin/releases
+Keywords: django,admin,modeladmin,foreignkey,related field
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django<6.1,>=5.2
+Dynamic: license-file
+
+# django-subadmin
+
+`django-subadmin` lets a `ModelAdmin` live under another `ModelAdmin`. When
+related objects have outgrown an inline, a `SubAdmin` gives them their own list
+and change pages, with search, filters, and pagination scoped to a parent
+object. Subadmins can be nested several levels deep.
+
+## Compatibility
+
+| django-subadmin | Django | Python |
+| --- | --- | --- |
+| 5.2.x | 5.2, 6.0 | 3.10+ |
+| 3.2.x | 3.2, 4.x, 5.x | 3.6+ |
+
+The package version follows the oldest Django version supported by that line.
+The 5.2 release drops support for Django before 5.2 and Python before 3.10.
+
+## Installation
+
+```console
+pip install django-subadmin
+```
+
+Add `subadmin` to `INSTALLED_APPS` so Django can find its templates:
+
+```python
+INSTALLED_APPS = [
+    # Django's contrib apps and your own apps...
+    "subadmin",
+]
+```
+
+## Example
+
+The test app has a `Parent` model with related `Child` objects. Django's inline
+admin would put the children on the parent's form; a `SubAdmin` gives each
+parent its own child changelist instead.
+
+```python
+# models.py
+from django.db import models
+
+
+class Parent(models.Model):
+    name = models.CharField(max_length=100)
+
+
+class Child(models.Model):
+    parent = models.ForeignKey(Parent, on_delete=models.CASCADE)
+    name = models.CharField(max_length=100)
+```
+
+```python
+# admin.py
+from django.contrib import admin
+from subadmin import RootSubAdmin, SubAdmin
+
+from .models import Child, Parent
+
+
+class ChildAdmin(SubAdmin):
+    model = Child
+
+
+@admin.register(Parent)
+class ParentAdmin(RootSubAdmin):
+    subadmins = (ChildAdmin,)
+```
+
+Open a parent in the admin and follow the link to its child admin. The child
+pages show only records for that parent. The parent foreign key is set
+automatically when adding a child and omitted from the nested form.
+
+The [test app models](tests/testapp/models.py) and
+[admin configuration](tests/testapp/admin.py) also show deeper nesting. Their
+workflows are covered by [integration tests](tests/test_admin.py), which you
+can run from a source checkout with:
+
+```console
+python -m django test tests --settings=tests.settings
+```
+
+## Screenshots
+
+The parent change page links to its child admin.
+
+![Parent change page with a Children link](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/parent-change.png)
+
+The child changelist contains only that parent's children.
+
+![Child changelist scoped to Example parent](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/child-list.png)
+
+The child add form omits the parent foreign key, which is set automatically.
+
+![Child add form without a parent field](https://raw.githubusercontent.com/inueni/django-subadmin/574123d0571a47b20190b6eb5b8b924983df7150/docs/images/child-add.png)
+
+## Labels
+
+Set `subadmin_label` to change a subadmin link and its collection breadcrumbs
+without renaming the model:
+
+```python
+class ChildAdmin(SubAdmin):
+    model = Child
+    subadmin_label = "Members"
+```
+
+The default is the model's `verbose_name_plural`. Object breadcrumbs and other
+model names keep their usual Django wording. Override
+`get_subadmin_label(request)` if the label needs to vary by request.
+
+## Upgrading from 3.2
+
+Parent objects are now loaded through the parent admin's `get_object()` method,
+so custom `get_queryset()` filters affect nested pages. Each parent in the URL
+must also pass that admin's `has_view_or_change_permission(request, obj)` check.
+A parent hidden by the queryset returns 404; a visible parent without permission
+returns 403. Child permissions alone no longer grant access through a parent.
+
+If you need the previous direct model lookup while adapting a project, set:
+
+```python
+SUBADMIN_USE_DIRECT_PARENT_LOOKUP = True
+```
+
+This changes how parents are loaded, but does not skip the parent permission
+check.
+
+Custom overrides of `get_parent_instance()` and `get_subadmin_helper()` need to
+accept `request` as their first argument after `self`. Their signatures are now
+`get_parent_instance(self, request, parent_id)` and
+`get_subadmin_helper(self, request, view_args, object_id=None)`.
+
+`SubAdmin` wraps forms to validate parent-scoped fields. If you override
+`get_form()` or `get_changelist_form()`, call `super()` so that wrapping still
+runs.

{django-subadmin-3.2.3 → django_subadmin-5.2.0}/django_subadmin.egg-info/SOURCES.txt

@@ -2,13 +2,24 @@
 LICENSE
 README.md
 pyproject.toml
+.github/workflows/ci.yml
 .github/workflows/publish.yml
 .github/workflows/publish_test.yml
 django_subadmin.egg-info/PKG-INFO
 django_subadmin.egg-info/SOURCES.txt
 django_subadmin.egg-info/dependency_links.txt
+django_subadmin.egg-info/requires.txt
+django_subadmin.egg-info/scm_file_list.json
+django_subadmin.egg-info/scm_version.json
 django_subadmin.egg-info/top_level.txt
+docs/images/child-add.png
+docs/images/child-list.png
+docs/images/parent-change.png
 subadmin/__init__.py
+subadmin/base.py
+subadmin/changelist.py
+subadmin/forms.py
+subadmin/helpers.py
 subadmin/templates/subadmin/breadcrumbs.html
 subadmin/templates/subadmin/change_form.html
 subadmin/templates/subadmin/change_list.html
@@ -18,4 +29,11 @@ subadmin/templates/subadmin/object_history.html
 subadmin/templates/subadmin/parent_change_form.html
 subadmin/templates/subadmin/submit_line.html
 subadmin/templatetags/__init__.py
-subadmin/templatetags/subadmin_tags.py
+subadmin/templatetags/subadmin_tags.py
+tests/__init__.py
+tests/settings.py
+tests/test_admin.py
+tests/urls.py
+tests/testapp/__init__.py
+tests/testapp/admin.py
+tests/testapp/models.py

django_subadmin-5.2.0/django_subadmin.egg-info/requires.txt

@@ -0,0 +1 @@
+Django<6.1,>=5.2