@django-stack/cli 0.0.0-stage → 0.1.0

package/package.json

@@ -1,6 +1,55 @@
 {
   "name": "@django-stack/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "The production-ready Django, batteries included stack. Create and manage DjangoStack projects: a Django backend, a frontend, Postgres and Docker Compose in one command.",
+  "license": "MIT",
+  "author": "Leon van der Grient",
+  "homepage": "https://github.com/dwarsbit/django-stack/tree/main/packages/cli#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dwarsbit/django-stack.git",
+    "directory": "packages/cli"
+  },
+  "bugs": "https://github.com/dwarsbit/django-stack/issues",
+  "keywords": [
+    "django",
+    "django-stack",
+    "headless-cms",
+    "jamstack"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "bin": {
+    "dstack": "./dist/bin.js"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@bomb.sh/tab": "^0.0.22",
+    "@clack/prompts": "^1.8.1",
+    "commander": "^15.0.0",
+    "picocolors": "^1.1.1"
+  },
+  "scripts": {
+    "build": "node scripts/copy-templates.mjs && tsdown",
+    "typecheck": "tsc --noEmit",
+    "test": "node scripts/copy-templates.mjs && vitest run"
+  }
 }

package/templates/backend/.dockerignore

@@ -0,0 +1,11 @@
+.venv
+__pycache__
+*.pyc
+.pytest_cache
+.ruff_cache
+media
+staticfiles
+db.sqlite3
+.env
+backups
+huey-stats.db*

package/templates/backend/Dockerfile

@@ -0,0 +1,45 @@
+# syntax=docker/dockerfile:1
+
+# The backend image: Django, the API and the admin. The `dev` target runs
+# the development server with the source mounted; `prod` runs Gunicorn.
+FROM python:3.13-slim AS base
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    UV_COMPILE_BYTECODE=1 \
+    UV_LINK_MODE=copy \
+    UV_PROJECT_ENVIRONMENT=/venv \
+    PATH="/venv/bin:$PATH"
+COPY --from=ghcr.io/astral-sh/uv:0.11 /uv /bin/uv
+# The Postgres client, for the backups (pg_dump and pg_restore).
+RUN apt-get update \
+    && apt-get install --yes --no-install-recommends postgresql-client \
+    && rm -rf /var/lib/apt/lists/*
+RUN groupadd --system app && useradd --system --gid app --home-dir /app app
+WORKDIR /app
+
+FROM base AS deps
+COPY pyproject.toml uv.lock* ./
+COPY vendor/ vendor/
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --no-dev --no-install-project
+
+# Development runs as root, so files the container writes into the mounted
+# source (such as new migrations) work on every host. Production does not.
+FROM deps AS dev
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --no-install-project
+ENTRYPOINT ["/app/entrypoint.sh"]
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
+
+FROM base AS prod
+COPY --from=deps /venv /venv
+# The code is owned by root: the app user can read it, not change it.
+COPY . .
+RUN DJANGO_SECRET_KEY=collectstatic-only python manage.py collectstatic --noinput \
+    && mkdir -p /app/media /app/backups && chown -R app:app /app/media /app/backups
+USER app
+EXPOSE 8000
+HEALTHCHECK --interval=10s --timeout=5s --start-period=30s --retries=5 \
+    CMD python -c "import urllib.request; urllib.request.urlopen('http://localhost:8000/readyz', timeout=4)"
+ENTRYPOINT ["/app/entrypoint.sh"]
+CMD ["gunicorn", "config.asgi:application", "--worker-class", "uvicorn_worker.UvicornWorker", "--bind", "0.0.0.0:8000", "--workers", "3", "--access-logfile", "-", "--no-control-socket"]

package/templates/backend/config/asgi.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
+
+application = get_asgi_application()

package/templates/backend/config/settings.py

@@ -0,0 +1,87 @@
+"""
+Settings of the {{project_name}} backend.
+
+The environment-driven settings (secrets, database, cache, mail, hosts,
+storage) and the defaults for Django Headless and Django Content Studio
+come from ``django_stack.settings.configure``; see the variables in
+``.env.example`` at the project root. Settings below the call override it.
+"""
+
+from pathlib import Path
+
+import django_stack.settings
+
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+DJANGO_STACK = {
+    # Models anyone may create through the API, such as the contact form.
+    "PUBLIC_CREATE": ["content.formsubmission"],
+    # The apps export_content and import_content move between environments.
+    "CONTENT_APPS": ["content"],
+    # The function `manage.py seed_content` runs.
+    "SEED_CONTENT": "content.seed.seed",
+}
+
+django_stack.settings.configure(globals(), base_dir=BASE_DIR)
+
+INSTALLED_APPS = [
+    "django.contrib.admin",  # Content Studio records its activity log with it
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "rest_framework",
+    "huey.contrib.djhuey",
+    "huey.contrib.djhuey.stats",
+    "headless",
+    "content_studio",
+    "content_studio.media_library",
+    "content_studio.contrib.password_reset",
+    "django_stack",
+    "content",
+    # Last: builds the API routes once every model is exposed.
+    "headless.rest",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
+    "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 = "config.urls"
+WSGI_APPLICATION = "config.wsgi.application"
+ASGI_APPLICATION = "config.asgi.application"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+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"},
+]
+
+LANGUAGE_CODE = "en-us"
+TIME_ZONE = "UTC"
+USE_I18N = True
+USE_TZ = True

package/templates/backend/config/studio.py

@@ -0,0 +1,20 @@
+"""
+The Content Studio site of {{project_name}}: the admin at /admin/.
+CONTENT_STUDIO["ADMIN_SITE"] points here. See
+https://djangocontentstudio.org/docs/extensions for the hooks and extensions.
+"""
+
+from content_studio.admin import ContentStudioSite
+from content_studio.contrib.huey import HueyAdapter
+from content_studio.dashboard.tasks import TaskDashboard
+from content_studio.extensions import UserMenuLink
+
+
+class SiteStudio(ContentStudioSite):
+    extensions = [
+        TaskDashboard(adapter=HueyAdapter()),
+        UserMenuLink(url="/tasks/", label="Tasks", icon="ph-bold ph-queue"),
+    ]
+
+
+admin_site = SiteStudio()

package/templates/backend/config/urls.py

@@ -0,0 +1,9 @@
+from django.urls import include, path
+from django_stack.urls import media_urlpatterns
+
+urlpatterns = [
+    path("admin/", include("content_studio.urls")),
+    path("api/", include("headless.rest.urls")),
+    path("", include("django_stack.urls")),  # /healthz and /readyz
+    *media_urlpatterns(),  # uploaded files, in development only
+]

package/templates/backend/config/wsgi.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
+
+application = get_wsgi_application()

package/templates/backend/conftest.py

@@ -0,0 +1,7 @@
+import pytest
+
+
+@pytest.fixture(autouse=True)
+def _no_revalidate(settings):
+    """Tests never call the frontend."""
+    settings.DJANGO_STACK = {**settings.DJANGO_STACK, "REVALIDATE_URL": None}

package/templates/backend/content/admin.py

@@ -0,0 +1,107 @@
+"""
+The studios of the content models: how they look in Content Studio at
+/admin/. See https://djangocontentstudio.org/docs/registering-models.
+"""
+
+from content_studio import register
+from content_studio.admin import ModelStudio
+from content_studio.form import ActivityLog, Field, FormSet
+from django_stack.studio import PreviewButton
+
+from .models import Author, Category, FormSubmission, Menu, Page, Post, Redirect, SiteSettings, Tag
+
+# Components on more than one studio need their own component_id.
+PAGE_PREVIEW = PreviewButton(component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a01")
+POST_PREVIEW = PreviewButton(component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a02")
+PAGE_ACTIVITY = ActivityLog(component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a03")
+POST_ACTIVITY = ActivityLog(component_id="8d0f6a52-3c51-4a8e-9a2b-6f1f0c8f2a04")
+SEO = FormSet(
+    title="Search and sharing",
+    description="Leave empty to use the title and the site settings.",
+    fields=["seo_title", "seo_description", "share_image"],
+)
+
+
+@register(Page)
+class PageStudio(ModelStudio):
+    icon = "ph-bold ph-file-text"
+    table_display = ["title", "path", "status", "published_at"]
+    list_filter = ["status"]
+    search_fields = ["title", "path"]
+    ordering = ["path"]
+    prepopulated_fields = {"slug": ["title"]}
+    allow_duplication = True
+    edit_width = "wide"
+    edit_main = [
+        FormSet(title="Page", fields=["title", Field("slug", col_span=1), Field("parent", col_span=1)]),
+        FormSet(title="Body", fields=["body"]),
+        SEO,
+    ]
+    edit_sidebar = ["status", "published_at", PAGE_PREVIEW, "order", PAGE_ACTIVITY]
+
+
+@register(Post)
+class PostStudio(ModelStudio):
+    icon = "ph-bold ph-article"
+    table_display = ["title", "author", "status", "published_at"]
+    list_filter = ["status", "categories", "tags", "author"]
+    search_fields = ["title", "excerpt"]
+    ordering = ["-published_at"]
+    prepopulated_fields = {"slug": ["title"]}
+    allow_duplication = True
+    edit_width = "wide"
+    edit_main = [
+        FormSet(title="Post", fields=["title", "slug", "cover", "excerpt"]),
+        FormSet(title="Body", fields=["body"]),
+        SEO,
+    ]
+    edit_sidebar = ["status", "published_at", POST_PREVIEW, "author", "categories", "tags", POST_ACTIVITY]
+
+
+@register(Category, Tag)
+class TaxonomyStudio(ModelStudio):
+    icon = "ph-bold ph-tag"
+    table_display = ["name", "slug"]
+    search_fields = ["name"]
+    prepopulated_fields = {"slug": ["name"]}
+
+
+@register(Author)
+class AuthorStudio(ModelStudio):
+    icon = "ph-bold ph-user-circle"
+    table_display = ["name", "slug"]
+    search_fields = ["name"]
+    prepopulated_fields = {"slug": ["name"]}
+
+
+@register(Menu)
+class MenuStudio(ModelStudio):
+    icon = "ph-bold ph-list"
+    table_display = ["name", "slug"]
+    prepopulated_fields = {"slug": ["name"]}
+
+
+@register(SiteSettings)
+class SiteSettingsStudio(ModelStudio):
+    icon = "ph-bold ph-gear"
+    is_singleton = True
+    edit_main = [
+        FormSet(title="Site", fields=["site_name", "tagline", "logo", "home_page"]),
+        FormSet(title="Search and sharing", fields=["seo_description", "share_image"]),
+        FormSet(title="Footer", fields=["footer_text", "social_links"]),
+    ]
+
+
+@register(Redirect)
+class RedirectStudio(ModelStudio):
+    icon = "ph-bold ph-arrow-bend-up-right"
+    table_display = ["old_path", "new_path", "permanent"]
+    search_fields = ["old_path", "new_path"]
+
+
+@register(FormSubmission)
+class FormSubmissionStudio(ModelStudio):
+    icon = "ph-bold ph-envelope"
+    table_display = ["name", "email", "created_at"]
+    search_fields = ["name", "email", "message"]
+    ordering = ["-created_at"]

package/templates/backend/content/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ContentConfig(AppConfig):
+    name = "content"
+    verbose_name = "Content"

package/templates/backend/content/blocks.py

@@ -0,0 +1,51 @@
+"""
+The blocks editors build page and post bodies from. Add a block here, add
+it to a BlockField's ``blocks`` and render it in the frontend's block
+registry (``frontend/src/components/blocks``). Blocks need no migration.
+"""
+
+from content_studio.blocks import Block
+from content_studio.fields import HTMLField
+from content_studio.media_library.fields import MediaField
+from django.db import models
+
+
+class TextBlock(Block):
+    body = HTMLField()
+
+    class Meta:
+        description = "Rich text with headings, lists and links"
+        icon = "ph-bold ph-text-t"
+
+
+class ImageBlock(Block):
+    image = MediaField(file_type="image", blank=False)
+    caption = models.CharField(max_length=300, blank=True)
+
+    class Meta:
+        description = "An image from the media library"
+        icon = "ph-bold ph-image"
+
+
+class QuoteBlock(Block):
+    text = models.TextField()
+    attribution = models.CharField(max_length=200, blank=True)
+
+    class Meta:
+        description = "A quotation"
+        icon = "ph-bold ph-quotes"
+
+
+class CallToActionBlock(Block):
+    title = models.CharField(max_length=200)
+    text = models.TextField(blank=True)
+    button_label = models.CharField(max_length=60)
+    button_url = models.CharField(max_length=500, help_text="A path on the site, such as /contact, or a full URL.")
+
+    class Meta:
+        name = "call_to_action"
+        description = "A highlighted message with a button"
+        icon = "ph-bold ph-megaphone"
+
+
+BODY_BLOCKS = [TextBlock, ImageBlock, QuoteBlock, CallToActionBlock]