Merge pull request #901 from jazzband/sample-project

Add A Sample Project

CONTRIBUTING.rst

@@ -43,6 +43,16 @@ django-taggit uses `tox <https://tox.readthedocs.io/>`_ to run tests:
 
     tox
 
+Running the sample application
+------------------------------
+
+There is a sample application in ``sample_taggit``. You can run it by doing the following:
+
+- Run migrations with ``sample_taggit/manage.py migrate``
+- Make yourself a superuser with ``sample_taggit/manage.py createsuperuser`` (this should let you use the admin with ease)
+- Launch the sample project itself with ``sample_taggit/manage.py runserver``
+
+
 Follow style conventions (black, flake8, isort)
 -----------------------------------------------
 

sample_taggit/admin.py

@@ -0,0 +1,5 @@
+from django.contrib import admin
+
+from .models import Post
+
+admin.site.register(Post)

sample_taggit/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for sample_taggit 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/5.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sample_taggit.settings")
+
+application = get_asgi_application()

sample_taggit/manage.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+from pathlib import Path
+
+
+def main():
+    """Run administrative tasks."""
+    # add this so that we can import from sample_taggit
+    sys.path.append(str(Path(__file__).resolve().parent.parent))
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sample_taggit.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()

sample_taggit/migrations/0001_initial.py

@@ -0,0 +1,44 @@
+# Generated by Django 5.0.6 on 2024-06-24 12:35
+
+from django.db import migrations, models
+
+import taggit.managers
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        (
+            "taggit",
+            "0006_rename_taggeditem_content_type_object_id_taggit_tagg_content_8fc721_idx",
+        ),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Post",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("title", models.CharField(max_length=200)),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        help_text="A comma-separated list of tags.",
+                        through="taggit.TaggedItem",
+                        to="taggit.Tag",
+                        verbose_name="Tags",
+                    ),
+                ),
+            ],
+        ),
+    ]

sample_taggit/models.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+from django.db import models
+
+from taggit.managers import TaggableManager
+
+
+class Post(models.Model):
+    title = models.CharField(max_length=200)
+    tags = TaggableManager(blank=True)

sample_taggit/settings.py

@@ -0,0 +1,125 @@
+"""
+Django settings for sample_taggit project.
+
+Generated by 'django-admin startproject' using Django 5.0.6.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.0/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/5.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-1$#3+wir_0n0&d#_f$35%b-fb_!f(8vzh8*a2x%ih*+j6*gih_"
+
+# 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",
+    "taggit",
+    "sample_taggit",
+]
+
+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 = "sample_taggit.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 = "sample_taggit.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.0/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.0/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/5.0/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/5.0/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.0/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

sample_taggit/templates/index.html

@@ -0,0 +1,24 @@
+<html>
+  <title>Sample Taggit App</title>
+  <body>
+    <h1>Sample Taggit App</h1>
+
+    <ul>
+      {% for post in posts %}
+      <li>
+        {{ post.title }}
+        <br/>
+        Tags:
+        {% for tag in post.tags.all %}
+        {{tag.name}},
+        {% empty %}
+        (None)
+        {% endfor %}
+      </li>
+      {% empty %}
+      <li>(No posts yet, go to the admin to create some)</li>
+      {% endfor %}
+    </ul>
+      <a href="/admin">Manage data in the admin</a>
+  </body>
+</html>

sample_taggit/urls.py

@@ -0,0 +1,23 @@
+"""
+URL configuration for sample_taggit project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.0/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import path
+
+from sample_taggit.views import index_view
+
+urlpatterns = [path("admin/", admin.site.urls), path("", index_view)]

sample_taggit/views.py

@@ -0,0 +1,7 @@
+from django.shortcuts import render
+
+from sample_taggit.models import Post
+
+
+def index_view(request):
+    return render(request, "index.html", {"posts": Post.objects.all()})

sample_taggit/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for sample_taggit 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/5.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sample_taggit.settings")
+
+application = get_wsgi_application()