Remove python-dotenv dep. Bump django. Add django example. (#63)

docs/build.py

@@ -39,6 +39,12 @@ def read_cls_docstring(cls):
 
 def get_versions():
     return [
+        {
+            "version": "0.2.12",
+            "changes": [
+                "Remove python-dotenv dep. Bump django. Add django example.",
+            ],
+        },
         {
             "version": "0.2.11",
             "changes": [
@@ -111,72 +117,6 @@ def get_versions():
                 "Update packages. Use vite instead obsolete react-scripts.",
             ],
         },
-        {
-            "version": "0.1.41",
-            "changes": [
-                "Fixed bug with datetime. Added verbose name logic for models and inlines. Updated frontend libraries.",
-            ],
-        },
-        {
-            "version": "0.1.40",
-            "changes": [
-                "Added RUFF linter. Cleaned up code. Removed pydantic dependency.",
-            ],
-        },
-        {
-            "version": "0.1.39",
-            "changes": [
-                "Bug fixes.",
-            ],
-        },
-        {
-            "version": "0.1.38",
-            "changes": [
-                "Bug fixes.",
-            ],
-        },
-        {
-            "version": "0.1.37",
-            "changes": [
-                "Bug fixes.",
-            ],
-        },
-        {
-            "version": "0.1.36",
-            "changes": [
-                "Added autogeneration of documentation and examples.",
-            ],
-        },
-        {
-            "version": "0.1.35",
-            "changes": [
-                "Added DashboardWidgetAdmin class and charts for dashboard.",
-            ],
-        },
-        {
-            "version": "0.1.34",
-            "changes": [
-                "Added SlugInput, EmailInput, PhoneInput, UrlInput, JsonTextArea widget types.",
-            ],
-        },
-        {
-            "version": "0.1.33",
-            "changes": [
-                "Added list_display_widths parameter.",
-            ],
-        },
-        {
-            "version": "0.1.32",
-            "changes": [
-                "Added Upload widget type.",
-            ],
-        },
-        {
-            "version": "0.1.31",
-            "changes": [
-                "Added PasswordInput widget type.",
-            ],
-        },
     ]
 
 

examples/django_djangoorm/Makefile

@@ -0,0 +1,10 @@
+all: install run
+
+.PHONY: fastapi
+run:
+	poetry run python manage.py migrate
+	poetry run python manage.py runserver
+
+.PHONY: install
+install:
+	poetry install

examples/django_djangoorm/README.md

@@ -0,0 +1,12 @@
+## Django + Django ORM Example
+
+- Uses in-memory SQLite 3 instance
+- Creates "admin/admin" superuser
+- Setup env variables in __init__.py
+
+```bash
+make install  # Creates virtualenv with Poetry
+make run      # Runs fastapi dev
+```
+
+So open `http://127.0.0.1:8000/admin/` and have a fun!

examples/django_djangoorm/__init__.py

@@ -0,0 +1,9 @@
+import os
+import sys
+from pathlib import Path
+
+os.environ["ADMIN_USER_MODEL"] = "User"
+os.environ["ADMIN_USER_MODEL_USERNAME_FIELD"] = "username"
+os.environ["ADMIN_SECRET_KEY"] = "secret"
+
+sys.path.append(str(Path(__file__).resolve().parent))

examples/django_djangoorm/dev/asgi.py

@@ -0,0 +1,15 @@
+"""
+ASGI config for dev project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dev.settings")
+application = get_asgi_application()

examples/django_djangoorm/dev/settings.py

@@ -0,0 +1,139 @@
+"""
+Django settings for dev project.
+
+Generated by 'django-admin startproject' using Django 4.1.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.1/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "test"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = False
+
+ALLOWED_HOSTS = ["*"]
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "orm",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "dev.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "dev.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/4.1/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": ":sharedmemory:",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.1/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.1/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+# Logging
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": True,
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+        },
+    },
+    "root": {
+        "handlers": ["console"],
+        "level": "ERROR",
+    },
+}

examples/django_djangoorm/dev/urls.py

@@ -0,0 +1,8 @@
+from django.urls import path
+
+from fastadmin import get_django_admin_urls as get_admin_urls
+from fastadmin.settings import settings
+
+urlpatterns = [
+    path(f"{settings.ADMIN_PREFIX}/", get_admin_urls()),
+]

examples/django_djangoorm/dev/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for dev project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dev.settings")
+
+application = get_wsgi_application()

examples/django_djangoorm/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dev.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

examples/django_djangoorm/orm/__init__.py

@@ -0,0 +1,5 @@
+import os
+
+os.environ["ADMIN_USER_MODEL"] = "User"
+os.environ["ADMIN_USER_MODEL_USERNAME_FIELD"] = "username"
+os.environ["ADMIN_SECRET_KEY"] = "secret"

examples/django_djangoorm/orm/apps.py

@@ -0,0 +1,14 @@
+from django.apps import AppConfig
+
+
+class OrmConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "orm"
+
+    def ready(self):
+        try:
+            from orm.models import User
+
+            User.objects.update_or_create(username="admin", password="admin", is_superuser=True)
+        except Exception:  # noqa: BLE001, S110
+            pass