Project code for django markdown tutorial (#459)

* project code for django markdown tutorial

* sort import statements with isort

* move readme file

Author: robalford

django-markdown/README.md

@@ -0,0 +1,3 @@
+# How to Render Markdown in a Django Application
+
+This folder provides the code examples for the Real Python tutorial [How to Render Markdown in a Django Application](https://realpython.com/django-markdown/).

django-markdown/django_markdown/django_markdown/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for django_markdown 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", "django_markdown.settings")
+
+application = get_asgi_application()

django-markdown/django_markdown/django_markdown/asgi.py

@@ -0,0 +1,126 @@
+"""
+Django settings for django_markdown project.
+
+Generated by 'django-admin startproject' using Django 4.1.3.
+
+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 = (
+    "django-insecure-6ynx$w58$^0g8)y5)kv&bp0ryw9l%eq*x8lmv5+^@p6n54eu@$"
+)
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "django_markdown_app",
+]
+
+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 = "django_markdown.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 = "django_markdown.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/4.1/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# 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"

django-markdown/django_markdown/django_markdown/settings.py

@@ -0,0 +1,13 @@
+from django.contrib import admin
+from django.urls import path
+
+from django_markdown_app.views import markdown_content_view
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path(
+        "markdown-content/<slug:slug>/",
+        markdown_content_view,
+        name="markdown-content",
+    ),
+]

django-markdown/django_markdown/django_markdown/urls.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for django_markdown 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", "django_markdown.settings")
+
+application = get_wsgi_application()

django-markdown/django_markdown/django_markdown/wsgi.py

@@ -0,0 +1,10 @@
+from django.contrib import admin
+
+from .models import MarkdownContent
+
+
+class MarkdownContentAdmin(admin.ModelAdmin):
+    prepopulated_fields = {"slug": ["title"]}
+
+
+admin.site.register(MarkdownContent, MarkdownContentAdmin)

django-markdown/django_markdown/django_markdown_app/__init__.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class DjangoMarkdownAppConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "django_markdown_app"

django-markdown/django_markdown/django_markdown_app/admin.py

@@ -0,0 +1,20 @@
+import markdown
+from django.urls import reverse
+from markdown.inlinepatterns import LINK_RE, LinkInlineProcessor
+
+
+class SlugFieldLinkInlineProcessor(LinkInlineProcessor):
+    def getLink(self, data, index):
+        href, title, index, handled = super().getLink(data, index)
+        if href.startswith("slug"):
+            slug = href.split(":")[1]
+            relative_url = reverse("markdown-content", args=[slug])
+            href = relative_url
+        return href, title, index, handled
+
+
+class SlugFieldExtension(markdown.Extension):
+    def extendMarkdown(self, md, *args, **kwargs):
+        md.inlinePatterns.register(
+            SlugFieldLinkInlineProcessor(LINK_RE, md), "link", 160
+        )