From a863272c7e0980938b2b6c8dba709198b3eaa494 Mon Sep 17 00:00:00 2001 From: daniel Date: Sun, 27 Oct 2024 22:21:00 +0100 Subject: [PATCH] add simple example --- example/simple/manage.py | 22 ++++++ example/simple/simple/__init__.py | 0 example/simple/simple/asgi.py | 16 ++++ example/simple/simple/settings.py | 124 ++++++++++++++++++++++++++++++ example/simple/simple/urls.py | 24 ++++++ example/simple/simple/views.py | 12 +++ example/simple/simple/wsgi.py | 16 ++++ 7 files changed, 214 insertions(+) create mode 100755 example/simple/manage.py create mode 100644 example/simple/simple/__init__.py create mode 100644 example/simple/simple/asgi.py create mode 100644 example/simple/simple/settings.py create mode 100644 example/simple/simple/urls.py create mode 100644 example/simple/simple/views.py create mode 100644 example/simple/simple/wsgi.py diff --git a/example/simple/manage.py b/example/simple/manage.py new file mode 100755 index 0000000..2272c92 --- /dev/null +++ b/example/simple/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', 'simple.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() diff --git a/example/simple/simple/__init__.py b/example/simple/simple/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/example/simple/simple/asgi.py b/example/simple/simple/asgi.py new file mode 100644 index 0000000..b0b57af --- /dev/null +++ b/example/simple/simple/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for simple 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.1/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'simple.settings') + +application = get_asgi_application() diff --git a/example/simple/simple/settings.py b/example/simple/simple/settings.py new file mode 100644 index 0000000..daac0dc --- /dev/null +++ b/example/simple/simple/settings.py @@ -0,0 +1,124 @@ +""" +Django settings for simple project. + +Generated by 'django-admin startproject' using Django 5.1.2. + +For more information on this file, see +https://docs.djangoproject.com/en/5.1/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/5.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/5.1/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-0_!deorp-j4ng0d$4#jrwcbw#@#)a5qf)_wgxq%or7ic4v3euc' + +# 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', +] + +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', + 'django_signposting.middleware.SignpostingMiddleware', +] + +ROOT_URLCONF = 'simple.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 = 'simple.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/5.1/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + +# Password validation +# https://docs.djangoproject.com/en/5.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/5.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/5.1/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/example/simple/simple/urls.py b/example/simple/simple/urls.py new file mode 100644 index 0000000..7684e63 --- /dev/null +++ b/example/simple/simple/urls.py @@ -0,0 +1,24 @@ +""" +URL configuration for simple project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/5.1/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 . import views + +urlpatterns = [ + path("", views.my_view), +] diff --git a/example/simple/simple/views.py b/example/simple/simple/views.py new file mode 100644 index 0000000..f90b5ec --- /dev/null +++ b/example/simple/simple/views.py @@ -0,0 +1,12 @@ +from django.http import HttpResponse +from django_signposting.utils import add_signposts + +def my_view(request): + response = HttpResponse("Hello, world!") + + # Add signpostings as string + add_signposts(response, + type="https://schema.org/Dataset", + author="https://orcid.org/0000-0001-9447-460X") + + return response \ No newline at end of file diff --git a/example/simple/simple/wsgi.py b/example/simple/simple/wsgi.py new file mode 100644 index 0000000..278f6ac --- /dev/null +++ b/example/simple/simple/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for simple 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.1/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'simple.settings') + +application = get_wsgi_application()