django-api-admin 1.2.3__tar.gz → 1.3.0__tar.gz

{django_api_admin-1.2.3 → django_api_admin-1.3.0}/PKG-INFO

@@ -1,23 +1,19 @@
 Metadata-Version: 2.4
 Name: django-api-admin
-Version: 1.2.3
+Version: 1.3.0
 Summary: A RESTful API implementation of django.contrib.admin, designed for writing custom frontends.
 Author: Muhammad Salah
 Author-email: Muhammad Salah <msbizzacc0unt@outlook.com>
 License-File: LICENSE
 License-File: LICENSE-DJANGO
-License-File: LICENSE-RESTFUL-ADMIN
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Dist: django
 Requires-Dist: djangorestframework
 Requires-Dist: drf-spectacular
-Requires-Dist: djangorestframework-simplejwt
-Requires-Dist: django-cors-headers ; extra == 'example'
-Requires-Dist: python-dotenv>=1.1.1 ; extra == 'example'
+Requires-Python: >=3.12
 Project-URL: Github, https://github.com/demon-bixia/django-api-admin
-Provides-Extra: example
 Description-Content-Type: text/markdown
 
 <a id="readme-top"></a>
@@ -41,7 +37,7 @@ Description-Content-Type: text/markdown
     <img src="assets/images/logo.png" alt="Logo" width="300" height="300">
   </a>
 
-  <h3 align="center">Django API Admin</h3>
+  <h1 align="center">Django API Admin</h1>
 
   <p align="center">
     A RESTful API implementation of django.contrib.admin, designed for writing custom frontends.
@@ -74,6 +70,8 @@ Description-Content-Type: text/markdown
       <ul>
         <li><a href="#prerequisites">Prerequisites</a></li>
         <li><a href="#installation">Installation</a></li>
+        <li><a href="#cors">CORS Configuration</a></li>
+        <li><a href="#authentication">Authentication</a></li>
       </ul>
     </li>
     <li><a href="#usage">Usage</a></li>
@@ -92,12 +90,12 @@ Description-Content-Type: text/markdown
 
 [![Product Name Screen Shot][product-screenshot]](https://github.com/demon-bixia/django-api-admin)
 
-The Django API Admin project is a RESTful API implementation of the `django.contrib.admin` module, designed to facilitate the creation of custom frontends. This project aims to provide developers with a robust and flexible API that mirrors the functionality of Django's built-in admin interface, allowing for seamless integration with modern web applications.
+Django API Admin is a RESTful API implementation of the `django.contrib.admin` application, designed to make it easy to create custom frontends. This project aims to provide developers with a flexible API that mirrors the functionality of Django's built-in admin interface, allowing for seamless integration with modern web client interfaces.
 
 ### Key Features:
 - **RESTful API**: Offers a comprehensive API for managing Django models, enabling developers to build custom administrative interfaces.
 - **Custom Frontends**: Designed to support the development of tailored frontends that meet specific project requirements.
-- **Extensible and Modular**: Build with the same django.contrib.admin API, allowing for easy customization and integration with existing Django projects.
+- **Extensible and Modular**: Build with the same `django.contrib.admin` API, allowing for easy customization and integration with existing Django projects.
 
 The project is continuously evolving, with new features and improvements being added regularly. Contributions from the community are highly encouraged to help expand and enhance the capabilities of this tool.
 
@@ -115,6 +113,8 @@ This section should list any major frameworks/libraries used to bootstrap your p
 
 * [![Django][Django]][Django-url]
 * [![DRF][Django REST framework]][DRF-url]
+* [![DRFSPD][DRF Spectacular]][DRFSPD-url]
+
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -129,13 +129,9 @@ To set up the project locally, follow these steps:
 
 Before you begin, ensure you have met the following requirements:
 
-- **Python 3.8+**: Make sure Python is installed on your machine. You can download it from [python.org](https://www.python.org/downloads/).
-
-- **pip**: Ensure you have pip installed for managing Python packages. It usually comes with Python installations.
+- **Python 3.12+**: Make sure Python is installed on your machine. You can download it from [python.org](https://www.python.org/downloads/).
 
-- **Virtual Environment**: It's recommended to use a virtual environment to manage dependencies. You can create one using `venv` or `virtualenv`.
-
-- **rest_framework**
+- **Django REST framework**
   ```sh
   pip install djangorestframework
   ```
@@ -143,18 +139,11 @@ Before you begin, ensure you have met the following requirements:
   ```sh
   pip install drf-spectacular
   ```
-- **djangorestframework-simplejwt**
-  ```sh
-  pip install djangorestframework-simplejwt
-  ```
-- **django-cors-headers**
-  ```sh
-  pip install django-cors-headers
-  ```
+
 
 ### Installation
 
-This guide will walk you through the steps to integrate `django-api-admin` into your Django project. Follow these instructions to get started.
+This section will walk you through the steps to install `django-api-admin` in your Django project. Follow these instructions to get started.
 
 1. **Install the Package**
    ```sh
@@ -177,16 +166,7 @@ This guide will walk you through the steps to integrate `django-api-admin` into
        'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
    }
    ```
-4. Add the urls of your client side applications to the `CORS_ORIGIN_WHITELIST`
-   ```py
-   # settings.py
-   CORS_ORIGIN_WHITELIST = (
-       'http://localhost',  # jest-dom test server
-       'http://localhost:3000',  # react developement server
-   )
-   CORS_ALLOW_CREDENTIALS = True
-   ```
-5. **Add the modify_schema hook** used to tag paths in the openapi schema  
+4. **Add the modify_schema hook** to improve the auto generated openAPI schema  
    ```py
    # settings.py
    SPECTACULAR_SETTINGS = {
@@ -199,6 +179,96 @@ This guide will walk you through the steps to integrate `django-api-admin` into
 
 Thats it you are now ready to register your models and implement your django admin frontend!
 
+### CORS Configuration
+
+If you plan to build a custom frontend in React.js or Vue.js then you might want to consider adding CORS configuration to your Django project. This will allow your frontend to make requests to your Django backend.
+
+1. Install **django-cors-headers** package
+  ```sh
+  pip install django-cors-headers
+  ```
+
+2. Add `corsheaders` to `INSTALLED_APPS` in your Django project's settings.py file (the order doesn't matter):
+   ```py
+   # settings.py
+   INSTALLED_APPS = [
+      'corsheaders',
+      # ...
+   ]
+   ```
+
+3. Add the urls of your client side applications to the `CORS_ORIGIN_WHITELIST`
+   ```py
+   # settings.py
+   CORS_ORIGIN_WHITELIST = (
+       'http://localhost',  # jest-dom test server
+       'http://localhost:3000',  # react development server
+   )
+   CORS_ALLOW_CREDENTIALS = True
+   ```
+
+Your client side application should now be able to make requests to your django backend!
+
+### Authentication
+
+Unlike `django.contrib.admin` this package doesn't include it's own authentication functionality. You will need implement authentication on your own, however the `django-api-admin` makes it very easy to add support for authentication frameworks that support `rest_framework`. This is how you can add `django-allauth` for instance:
+
+1. Install `django-allauth`
+   
+```sh
+pip install django-allauth
+```
+
+2. Configure `django-allauth` settings for your project
+
+```py
+# settings.py
+
+INSTALLED_APPS = [
+    # ...
+    'allauth',
+]
+
+MIDDLEWARE = [
+    # ...
+    'allauth.account.middleware.AccountMiddleware',
+    # ...
+]
+
+AUTHENTICATION_BACKENDS = [
+    'django.contrib.auth.backends.ModelBackend',
+    'allauth.account.auth_backends.AuthenticationBackend',
+]
+```
+
+3. Add the `authentication_classes` to an `APIAdminSite` subclass.
+
+```py
+from django_api_admin import APIAdminSite
+
+class AdminSite(APIAdminSite):
+    def get_authentication_classes(self):
+        from allauth.headless.contrib.rest_framework.authentication import XSessionTokenAuthentication
+
+        return [XSessionTokenAuthentication, authentication.SessionAuthentication]
+
+site = AdminSite()
+```
+
+
+4. include the `django-allauth` headless urls in your `urls.py` file.
+
+```python
+# urls.py
+urlpatterns = [
+    # ...
+    path("_allauth/", include("allauth.headless.urls")),
+]
+```
+
+Now, `django-api-admin` will use the provided `authentication_classes` for authenticating users.
+
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 
@@ -262,11 +332,8 @@ This section provides a simple example on how to use django-api-admin. If you're
 - [x] Rewrite django.contrib.admin as an API
 - [x] Add support for Bulk Actions
 - [x] Add OpenAPI documentation
-- [ ] Add a customizable dashboard
-- [ ] Oauth support
-- [ ] Multi-language Support
-    - [ ] Arabic
-    - [x] English
+- [ ] Add support for charts
+- [ ] Add support for global full-text search
 
 See the [open issues](https://github.com/demon-bixia/django-api-admin/issues) for a full list of proposed features (and known issues).
 
@@ -310,9 +377,9 @@ Distributed under the MIT License. See the `LICENSE` file  for more information.
 <!-- CONTACT -->
 ## Contact
 
-Muhammad Salah - [@demobixia](https://t.me/demonbixia) - msbizzaccount@outlook.com
+Muhammad Salah - [@daemobixia](https://t.me/demonbixia) - [msbizzaccount@gmail.com](mailto:[EMAIL_ADDRESS])
 
-Project Link: [https://github.com/demon-bixia/django-api-admin](https://github.com/demon-bixia/django-api-admin)
+Project Link: [https://github.com/demon-bixia/django-api-admin](https://github.com/daemon-bixia/django-api-admin)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -325,10 +392,7 @@ This section is dedicated to recognizing the valuable resources and contribution
 
 * [Django Web Framework](https://www.djangoproject.com/)
 * [Django Rest Framework](https://www.django-rest-framework.org/)
-* [Simple JWT](https://github.com/jazzband/djangorestframework-simplejwt/tree/master)
-* [Django Cors Headers](https://github.com/adamchainz/django-cors-headers)
 * [DRF Spectacular](https://github.com/tfranzel/drf-spectacular)
-* [Django Restful Admin](https://github.com/amirasaran/django-restful-admin)
 * [Best README Template](https://github.com/othneildrew/Best-README-Template)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -361,4 +425,7 @@ This section is dedicated to recognizing the valuable resources and contribution
 [DRF-url]: https://www.django-rest-framework.org/
 [Django REST framework]: https://img.shields.io/badge/django--rest--framework-3.12.4-green?style=for-the-badge&labelColor=333333&logo=django&logoColor=white&color=green
 
+[DRFSPD-url]: https://drf-spectacular.readthedocs.io/en/latest/
+[DRF Spectacular]: https://img.shields.io/badge/drf-spectacular-orange?style=for-the-badge&labelColor=333333&logo=django&logoColor=white&color=green
+
 [product-screenshot]: assets/images/screenshot.png

{django_api_admin-1.2.3 → django_api_admin-1.3.0}/README.md

@@ -19,7 +19,7 @@
     <img src="assets/images/logo.png" alt="Logo" width="300" height="300">
   </a>
 
-  <h3 align="center">Django API Admin</h3>
+  <h1 align="center">Django API Admin</h1>
 
   <p align="center">
     A RESTful API implementation of django.contrib.admin, designed for writing custom frontends.
@@ -52,6 +52,8 @@
       <ul>
         <li><a href="#prerequisites">Prerequisites</a></li>
         <li><a href="#installation">Installation</a></li>
+        <li><a href="#cors">CORS Configuration</a></li>
+        <li><a href="#authentication">Authentication</a></li>
       </ul>
     </li>
     <li><a href="#usage">Usage</a></li>
@@ -70,12 +72,12 @@
 
 [![Product Name Screen Shot][product-screenshot]](https://github.com/demon-bixia/django-api-admin)
 
-The Django API Admin project is a RESTful API implementation of the `django.contrib.admin` module, designed to facilitate the creation of custom frontends. This project aims to provide developers with a robust and flexible API that mirrors the functionality of Django's built-in admin interface, allowing for seamless integration with modern web applications.
+Django API Admin is a RESTful API implementation of the `django.contrib.admin` application, designed to make it easy to create custom frontends. This project aims to provide developers with a flexible API that mirrors the functionality of Django's built-in admin interface, allowing for seamless integration with modern web client interfaces.
 
 ### Key Features:
 - **RESTful API**: Offers a comprehensive API for managing Django models, enabling developers to build custom administrative interfaces.
 - **Custom Frontends**: Designed to support the development of tailored frontends that meet specific project requirements.
-- **Extensible and Modular**: Build with the same django.contrib.admin API, allowing for easy customization and integration with existing Django projects.
+- **Extensible and Modular**: Build with the same `django.contrib.admin` API, allowing for easy customization and integration with existing Django projects.
 
 The project is continuously evolving, with new features and improvements being added regularly. Contributions from the community are highly encouraged to help expand and enhance the capabilities of this tool.
 
@@ -93,6 +95,8 @@ This section should list any major frameworks/libraries used to bootstrap your p
 
 * [![Django][Django]][Django-url]
 * [![DRF][Django REST framework]][DRF-url]
+* [![DRFSPD][DRF Spectacular]][DRFSPD-url]
+
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -107,13 +111,9 @@ To set up the project locally, follow these steps:
 
 Before you begin, ensure you have met the following requirements:
 
-- **Python 3.8+**: Make sure Python is installed on your machine. You can download it from [python.org](https://www.python.org/downloads/).
-
-- **pip**: Ensure you have pip installed for managing Python packages. It usually comes with Python installations.
+- **Python 3.12+**: Make sure Python is installed on your machine. You can download it from [python.org](https://www.python.org/downloads/).
 
-- **Virtual Environment**: It's recommended to use a virtual environment to manage dependencies. You can create one using `venv` or `virtualenv`.
-
-- **rest_framework**
+- **Django REST framework**
   ```sh
   pip install djangorestframework
   ```
@@ -121,18 +121,11 @@ Before you begin, ensure you have met the following requirements:
   ```sh
   pip install drf-spectacular
   ```
-- **djangorestframework-simplejwt**
-  ```sh
-  pip install djangorestframework-simplejwt
-  ```
-- **django-cors-headers**
-  ```sh
-  pip install django-cors-headers
-  ```
+
 
 ### Installation
 
-This guide will walk you through the steps to integrate `django-api-admin` into your Django project. Follow these instructions to get started.
+This section will walk you through the steps to install `django-api-admin` in your Django project. Follow these instructions to get started.
 
 1. **Install the Package**
    ```sh
@@ -155,16 +148,7 @@ This guide will walk you through the steps to integrate `django-api-admin` into
        'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
    }
    ```
-4. Add the urls of your client side applications to the `CORS_ORIGIN_WHITELIST`
-   ```py
-   # settings.py
-   CORS_ORIGIN_WHITELIST = (
-       'http://localhost',  # jest-dom test server
-       'http://localhost:3000',  # react developement server
-   )
-   CORS_ALLOW_CREDENTIALS = True
-   ```
-5. **Add the modify_schema hook** used to tag paths in the openapi schema  
+4. **Add the modify_schema hook** to improve the auto generated openAPI schema  
    ```py
    # settings.py
    SPECTACULAR_SETTINGS = {
@@ -177,6 +161,96 @@ This guide will walk you through the steps to integrate `django-api-admin` into
 
 Thats it you are now ready to register your models and implement your django admin frontend!
 
+### CORS Configuration
+
+If you plan to build a custom frontend in React.js or Vue.js then you might want to consider adding CORS configuration to your Django project. This will allow your frontend to make requests to your Django backend.
+
+1. Install **django-cors-headers** package
+  ```sh
+  pip install django-cors-headers
+  ```
+
+2. Add `corsheaders` to `INSTALLED_APPS` in your Django project's settings.py file (the order doesn't matter):
+   ```py
+   # settings.py
+   INSTALLED_APPS = [
+      'corsheaders',
+      # ...
+   ]
+   ```
+
+3. Add the urls of your client side applications to the `CORS_ORIGIN_WHITELIST`
+   ```py
+   # settings.py
+   CORS_ORIGIN_WHITELIST = (
+       'http://localhost',  # jest-dom test server
+       'http://localhost:3000',  # react development server
+   )
+   CORS_ALLOW_CREDENTIALS = True
+   ```
+
+Your client side application should now be able to make requests to your django backend!
+
+### Authentication
+
+Unlike `django.contrib.admin` this package doesn't include it's own authentication functionality. You will need implement authentication on your own, however the `django-api-admin` makes it very easy to add support for authentication frameworks that support `rest_framework`. This is how you can add `django-allauth` for instance:
+
+1. Install `django-allauth`
+   
+```sh
+pip install django-allauth
+```
+
+2. Configure `django-allauth` settings for your project
+
+```py
+# settings.py
+
+INSTALLED_APPS = [
+    # ...
+    'allauth',
+]
+
+MIDDLEWARE = [
+    # ...
+    'allauth.account.middleware.AccountMiddleware',
+    # ...
+]
+
+AUTHENTICATION_BACKENDS = [
+    'django.contrib.auth.backends.ModelBackend',
+    'allauth.account.auth_backends.AuthenticationBackend',
+]
+```
+
+3. Add the `authentication_classes` to an `APIAdminSite` subclass.
+
+```py
+from django_api_admin import APIAdminSite
+
+class AdminSite(APIAdminSite):
+    def get_authentication_classes(self):
+        from allauth.headless.contrib.rest_framework.authentication import XSessionTokenAuthentication
+
+        return [XSessionTokenAuthentication, authentication.SessionAuthentication]
+
+site = AdminSite()
+```
+
+
+4. include the `django-allauth` headless urls in your `urls.py` file.
+
+```python
+# urls.py
+urlpatterns = [
+    # ...
+    path("_allauth/", include("allauth.headless.urls")),
+]
+```
+
+Now, `django-api-admin` will use the provided `authentication_classes` for authenticating users.
+
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 
@@ -240,11 +314,8 @@ This section provides a simple example on how to use django-api-admin. If you're
 - [x] Rewrite django.contrib.admin as an API
 - [x] Add support for Bulk Actions
 - [x] Add OpenAPI documentation
-- [ ] Add a customizable dashboard
-- [ ] Oauth support
-- [ ] Multi-language Support
-    - [ ] Arabic
-    - [x] English
+- [ ] Add support for charts
+- [ ] Add support for global full-text search
 
 See the [open issues](https://github.com/demon-bixia/django-api-admin/issues) for a full list of proposed features (and known issues).
 
@@ -288,9 +359,9 @@ Distributed under the MIT License. See the `LICENSE` file  for more information.
 <!-- CONTACT -->
 ## Contact
 
-Muhammad Salah - [@demobixia](https://t.me/demonbixia) - msbizzaccount@outlook.com
+Muhammad Salah - [@daemobixia](https://t.me/demonbixia) - [msbizzaccount@gmail.com](mailto:[EMAIL_ADDRESS])
 
-Project Link: [https://github.com/demon-bixia/django-api-admin](https://github.com/demon-bixia/django-api-admin)
+Project Link: [https://github.com/demon-bixia/django-api-admin](https://github.com/daemon-bixia/django-api-admin)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -303,10 +374,7 @@ This section is dedicated to recognizing the valuable resources and contribution
 
 * [Django Web Framework](https://www.djangoproject.com/)
 * [Django Rest Framework](https://www.django-rest-framework.org/)
-* [Simple JWT](https://github.com/jazzband/djangorestframework-simplejwt/tree/master)
-* [Django Cors Headers](https://github.com/adamchainz/django-cors-headers)
 * [DRF Spectacular](https://github.com/tfranzel/drf-spectacular)
-* [Django Restful Admin](https://github.com/amirasaran/django-restful-admin)
 * [Best README Template](https://github.com/othneildrew/Best-README-Template)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -339,4 +407,7 @@ This section is dedicated to recognizing the valuable resources and contribution
 [DRF-url]: https://www.django-rest-framework.org/
 [Django REST framework]: https://img.shields.io/badge/django--rest--framework-3.12.4-green?style=for-the-badge&labelColor=333333&logo=django&logoColor=white&color=green
 
+[DRFSPD-url]: https://drf-spectacular.readthedocs.io/en/latest/
+[DRF Spectacular]: https://img.shields.io/badge/drf-spectacular-orange?style=for-the-badge&labelColor=333333&logo=django&logoColor=white&color=green
+
 [product-screenshot]: assets/images/screenshot.png

django_api_admin-1.3.0/django_api_admin/API_DOCS.md

@@ -0,0 +1,22 @@
+## Introduction
+
+**Django API Admin** is a Django package that provides a powerful, RESTful API admin interface for your Django projects. 
+
+Key highlights include:
+- **A Modern Rewrite:** It is a complete rewrite of the standard `django.contrib.admin` package, built on top of the **Django Rest Framework (DRF)**.
+- **Frontend-First:** Specifically designed for developers building custom administrative front-ends using modern frameworks like **React**, **Vue**, and **Next.js**.
+- **Full Feature Parity:** It provides a RESTful interface to all default `django.contrib.admin` features out of the box.
+- **Extensible:** Easily customizable to add unique functionality tailored to your specific administrative needs.
+
+## Scope
+
+- **Core Support:** It natively supports the full suite of features found in the standard `django.contrib.admin` package.
+- **Unopinionated Auth:** To remain flexible, it does **not** include or enforce any default authentication method.
+- **Beyond a Mirror:** While it follows the patterns of the original admin, it is not strictly a mirror and may include enhanced features or different architectural choices that go beyond the standard Django admin.
+
+## Authentication
+
+Authentication is decoupled from the core package to give developers full control over their security stack.
+
+- **Developer Responsibility:** Implementation of authentication is left entirely to the developer within their specific project.
+- **Recommendation:** We highly recommend using [Django Allauth Headless](https://django-allauth.readthedocs.io/en/latest/headless.html) for a seamless, modern authentication experience that pairs perfectly with this package.

{django_api_admin-1.2.3 → django_api_admin-1.3.0}/django_api_admin/__init__.py

@@ -1,5 +1,16 @@
-from django.utils.module_loading import autodiscover_modules
+# -----------------------------------------------------------------------------
+# Portions of this file are from Django (https://www.djangoproject.com/)
+# Copyright (c) Django Software Foundation and individual contributors.
+# All rights reserved.
+# Licensed under the BSD 3-Clause License.
+#
+# Additional code copyright (c) 2021 Muhammad Salah
+# Licensed under the MIT License
+#
+# This file includes both Django code and your my own contributions.
+# -----------------------------------------------------------------------------
 
+from django_api_admin.utils.module_loading import autodiscover_modules
 from django_api_admin.decorators import action, display, register
 from django_api_admin.filters import (
     AllValuesFieldListFilter,
@@ -13,8 +24,7 @@ from django_api_admin.filters import (
     RelatedOnlyFieldListFilter,
     SimpleListFilter,
 )
-from django_api_admin.constants.vars import HORIZONTAL, VERTICAL
-from django_api_admin.admins.model_admin import APIModelAdmin
+from django_api_admin.admins.model_admin import APIModelAdmin, HORIZONTAL, VERTICAL
 from django_api_admin.admins.inline_admin import StackedInlineAPI, TabularInlineAPI
 from django_api_admin.sites import APIAdminSite, site
 

{django_api_admin-1.2.3 → django_api_admin-1.3.0}/django_api_admin/actions.py

@@ -9,19 +9,15 @@ from django_api_admin.utils.get_deleted_objects import get_deleted_objects
 from django_api_admin.decorators import action
 
 
-@action(
-    permissions=['delete'],
-    description=gettext_lazy('Delete selected %(verbose_name_plural)s')
-)
+@action(permissions=["delete"], description=gettext_lazy("Delete selected %(verbose_name_plural)s"))
 def delete_selected(modeladmin, request, queryset):
     """
     default api_admin action deletes the selected objects
     no confirmation page
     """
-    _deletable_objects, _model_count, perms_needed, _protected = get_deleted_objects(
-        queryset, request, modeladmin.admin_site)
+    _deletable_objects, _model_count, perms_needed, _protected = get_deleted_objects(queryset, request, modeladmin.admin_site)
 
-    # check the permissions
+    # Check the permissions
     if perms_needed:
         objects_name = model_ngettext(queryset)
         msg = _("Cannot delete %(name)s") % {"name": objects_name}
@@ -30,11 +26,9 @@ def delete_selected(modeladmin, request, queryset):
     # log the deletion of all the objects inside the queryset
     n = queryset.count()
     if n:
-        for obj in queryset:
-            modeladmin.log_deletion(request, obj, str(obj))
+        modeladmin.log_deletion(request, queryset)
 
-    # delete the queryset
-    queryset.delete()
-    msg = _("Successfully deleted %s %s.") % (
-        n, model_ngettext(modeladmin.opts, n))
-    return Response({'detail': msg}, status=status.HTTP_200_OK)
+    # Delete the queryset
+    modeladmin.delete_queryset(request, queryset)
+    msg = _("Successfully deleted %s %s.") % (n, model_ngettext(modeladmin.opts, n))
+    return Response({"detail": msg}, status=status.HTTP_200_OK)

{django_api_admin-1.2.3 → django_api_admin-1.3.0}/django_api_admin/admin_views/admin_site_views/app_index.py

@@ -3,10 +3,9 @@ from django.utils.translation import gettext_lazy as _
 from rest_framework.response import Response
 from rest_framework import status
 from rest_framework.exceptions import ParseError
-
 from rest_framework.views import APIView
 
-from drf_spectacular.utils import extend_schema, OpenApiResponse
+from drf_spectacular.utils import extend_schema, OpenApiResponse, OpenApiParameter
 
 from django_api_admin.serializers import AppIndexSerializer, AppSerializer
 from django_api_admin.openapi import CommonAPIResponses
@@ -14,24 +13,28 @@ from django_api_admin.openapi import CommonAPIResponses
 
 class AppIndexView(APIView):
     """
-    Lists models inside a given app.
+    Retrieve an app that has models registered in the admin site using `app_label`.
     """
+
     serializer_class = AppIndexSerializer
     permission_classes = []
     admin_site = None
 
     @extend_schema(
-        operation_id="app_index",
-        request=AppIndexSerializer,
-        responses={
-            200: OpenApiResponse(
-                response=AppSerializer,
-                description=_(
-                    "Successfully constructed the list of registered models")
+        operation_id="Get registered app details",
+        parameters=[
+            OpenApiParameter(
+                name="app_label",
+                type=str,
+                location=OpenApiParameter.PATH,
+                description=_("The label of the app to retrieve details for."),
             ),
+        ],
+        responses={
+            200: OpenApiResponse(response=AppSerializer, description=_("Application detail for the given `app_label`")),
             403: CommonAPIResponses.permission_denied(),
-            401: CommonAPIResponses.unauthorized()
-        }
+            401: CommonAPIResponses.unauthorized(),
+        },
     )
     def get(self, request, app_label):
         serializer = self.get_serializer(app_label)
@@ -41,23 +44,17 @@ class AppIndexView(APIView):
         app_dict = self.admin_site._build_app_dict(request, app_label)
 
         if not app_dict:
-            return Response({'detail': _('The requested admin page does not exist.')},
-                            status=status.HTTP_404_NOT_FOUND)
+            return Response({"detail": _("The requested admin page does not exist.")}, status=status.HTTP_404_NOT_FOUND)
 
         # Sort the models alphabetically within each app.
-        app_dict['models'].sort(key=lambda x: x['name'])
+        app_dict["models"].sort(key=lambda x: x["name"])
 
         data = {
-            'app_label': app_label,
-            'app': app_dict,
+            "app_label": app_label,
+            "app": app_dict,
         }
         return Response(data, status=status.HTTP_200_OK)
 
     def get_serializer(self, app_label):
-        registered_app_labels = {
-            model._meta.app_label for model in self.admin_site._registry.keys()
-        }
-        return AppIndexSerializer(
-            data={"app_label": app_label},
-            context={'registered_app_labels': registered_app_labels}
-        )
+        registered_app_labels = {model._meta.app_label for model in self.admin_site._registry.keys()}
+        return self.serializer_class(data={"app_label": app_label}, context={"registered_app_labels": registered_app_labels})