From 5270a773348bcdee50f1aa5e550bbabb2ede3f50 Mon Sep 17 00:00:00 2001 From: barneydobson Date: Wed, 23 Oct 2024 12:52:47 +0100 Subject: [PATCH] run startapp --- .pre-commit-config.yaml | 1 + docs/reference/SUMMARY.md | 1 + .../rse_competencies_toolkit/index.md | 1 + manage.py | 23 ++++ pyproject.toml | 2 +- rse_competencies_toolkit/__init__.py | 4 - rse_competencies_toolkit/__main__.py | 1 - rse_competencies_toolkit/asgi.py | 15 +++ rse_competencies_toolkit/settings.py | 122 ++++++++++++++++++ rse_competencies_toolkit/urls.py | 23 ++++ rse_competencies_toolkit/wsgi.py | 15 +++ tests/test_rse_competencies_toolkit.py | 8 -- 12 files changed, 202 insertions(+), 14 deletions(-) create mode 100644 docs/reference/SUMMARY.md create mode 100644 docs/reference/rse_competencies_toolkit/index.md create mode 100644 manage.py delete mode 100644 rse_competencies_toolkit/__main__.py create mode 100644 rse_competencies_toolkit/asgi.py create mode 100644 rse_competencies_toolkit/settings.py create mode 100644 rse_competencies_toolkit/urls.py create mode 100644 rse_competencies_toolkit/wsgi.py delete mode 100644 tests/test_rse_competencies_toolkit.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f88e4ed..baa37e1 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -13,6 +13,7 @@ repos: hooks: - id: pretty-format-yaml args: [--autofix, --indent, '2', --offset, '2'] + exclude: manage.py - repo: https://github.com/python-jsonschema/check-jsonschema rev: 0.28.3 hooks: diff --git a/docs/reference/SUMMARY.md b/docs/reference/SUMMARY.md new file mode 100644 index 0000000..09bdf11 --- /dev/null +++ b/docs/reference/SUMMARY.md @@ -0,0 +1 @@ +* [rse_competencies_toolkit](rse_competencies_toolkit\index.md) diff --git a/docs/reference/rse_competencies_toolkit/index.md b/docs/reference/rse_competencies_toolkit/index.md new file mode 100644 index 0000000..ff2a8e8 --- /dev/null +++ b/docs/reference/rse_competencies_toolkit/index.md @@ -0,0 +1 @@ +::: rse_competencies_toolkit diff --git a/manage.py b/manage.py new file mode 100644 index 0000000..23f1071 --- /dev/null +++ b/manage.py @@ -0,0 +1,23 @@ +#!/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", "rse_competencies_toolkit.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/pyproject.toml b/pyproject.toml index 4fa230b..349dcd9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,7 +41,7 @@ disallow_any_generics = true warn_unreachable = true warn_unused_ignores = true disallow_untyped_defs = true -exclude = [".venv/", "docs/"] +exclude = [".venv/", "docs/", "manage.py"] [[tool.mypy.overrides]] module = "tests.*" diff --git a/rse_competencies_toolkit/__init__.py b/rse_competencies_toolkit/__init__.py index 445926a..8b7dee2 100644 --- a/rse_competencies_toolkit/__init__.py +++ b/rse_competencies_toolkit/__init__.py @@ -1,5 +1 @@ """The main module for RSE Competencies Toolkit.""" - -from importlib.metadata import version - -__version__ = version(__name__) diff --git a/rse_competencies_toolkit/__main__.py b/rse_competencies_toolkit/__main__.py deleted file mode 100644 index 9b86509..0000000 --- a/rse_competencies_toolkit/__main__.py +++ /dev/null @@ -1 +0,0 @@ -"""The entry point for the RSE Competencies Toolkit program.""" diff --git a/rse_competencies_toolkit/asgi.py b/rse_competencies_toolkit/asgi.py new file mode 100644 index 0000000..bb4707b --- /dev/null +++ b/rse_competencies_toolkit/asgi.py @@ -0,0 +1,15 @@ +"""ASGI config for rse_competencies_toolkit 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", "rse_competencies_toolkit.settings") + +application = get_asgi_application() diff --git a/rse_competencies_toolkit/settings.py b/rse_competencies_toolkit/settings.py new file mode 100644 index 0000000..cde9001 --- /dev/null +++ b/rse_competencies_toolkit/settings.py @@ -0,0 +1,122 @@ +"""Django settings for rse_competencies_toolkit 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-!hv_9o)--3*m5m&gpk!z@*!20pn@jgbd8s7pw8@t8&%ect$3v%" + +# 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", +] + +ROOT_URLCONF = "rse_competencies_toolkit.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 = "rse_competencies_toolkit.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/rse_competencies_toolkit/urls.py b/rse_competencies_toolkit/urls.py new file mode 100644 index 0000000..b935dfb --- /dev/null +++ b/rse_competencies_toolkit/urls.py @@ -0,0 +1,23 @@ +"""URL configuration for rse_competencies_toolkit 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 + +urlpatterns = [ + path("admin/", admin.site.urls), +] diff --git a/rse_competencies_toolkit/wsgi.py b/rse_competencies_toolkit/wsgi.py new file mode 100644 index 0000000..a2e7f54 --- /dev/null +++ b/rse_competencies_toolkit/wsgi.py @@ -0,0 +1,15 @@ +"""WSGI config for rse_competencies_toolkit 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", "rse_competencies_toolkit.settings") + +application = get_wsgi_application() diff --git a/tests/test_rse_competencies_toolkit.py b/tests/test_rse_competencies_toolkit.py deleted file mode 100644 index 670c876..0000000 --- a/tests/test_rse_competencies_toolkit.py +++ /dev/null @@ -1,8 +0,0 @@ -"""Tests for the main module.""" - -from rse_competencies_toolkit import __version__ - - -def test_version(): - """Check that the version is acceptable.""" - assert __version__ == "0.1.0"