From 1d0ef191c632c498bfe8a68ea18d6e8e507f5bf3 Mon Sep 17 00:00:00 2001 From: Charlotte Gaskell Date: Tue, 23 Dec 2025 17:24:53 +0000 Subject: [PATCH 1/2] chore: add pre-commit and pyproject configs --- .pre-commit-config.yaml | 15 ++++++++++++ pyproject.toml | 51 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 .pre-commit-config.yaml create mode 100644 pyproject.toml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..d6dd975 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,15 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: check-toml + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md] + + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.12.2 + hooks: + - id: ruff-check + - id: ruff-format diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..abda1a4 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,51 @@ +[project] +# This section contains metadata about your project. +# Don't forget to change the name, description, and authors to match your project! +name = "itpspapi" +description = "Server for ilo toki pi sitelen pona" +authors = [ + { name = "jan Kalote" } +] +version = "0.1.0" +readme = "README.md" +requires-python = ">=3.12" +dependencies = [ + "django~=6.0" +] + +[dependency-groups] +dev = [ + "pre-commit~=4.2.0", + "ruff~=0.12.2", +] + +[tool.ruff] +line-length = 119 +target-version = "py312" +fix = true + +[tool.ruff.lint] +select = ["ALL"] +ignore = [ + # Missing docstrings. + "D100", + "D104", + "D105", + "D106", + "D107", + # Docstring whitespace. + "D203", + "D213", + # Docstring punctuation. + "D415", + # Docstring quotes. + "D301", + # Builtins. + "A", + # Print statements. + "T20", + # TODOs. + "TD002", + "TD003", + "FIX", +] From 30fb85eeb8a20cbf771cd4c31454a53b8fd48849 Mon Sep 17 00:00:00 2001 From: Charlotte Gaskell Date: Tue, 23 Dec 2025 17:37:20 +0000 Subject: [PATCH 2/2] django: create project/app --- api/__init__.py | 0 api/admin.py | 1 + api/migrations/__init__.py | 0 api/models.py | 1 + api/tests.py | 1 + api/views.py | 1 + itpspapi/__init__.py | 0 itpspapi/asgi.py | 15 +++++ itpspapi/settings.py | 118 +++++++++++++++++++++++++++++++++++++ itpspapi/urls.py | 24 ++++++++ itpspapi/wsgi.py | 15 +++++ manage.py | 23 ++++++++ pyproject.toml | 3 + 13 files changed, 202 insertions(+) create mode 100644 api/__init__.py create mode 100644 api/admin.py create mode 100644 api/migrations/__init__.py create mode 100644 api/models.py create mode 100644 api/tests.py create mode 100644 api/views.py create mode 100644 itpspapi/__init__.py create mode 100644 itpspapi/asgi.py create mode 100644 itpspapi/settings.py create mode 100644 itpspapi/urls.py create mode 100644 itpspapi/wsgi.py create mode 100755 manage.py diff --git a/api/__init__.py b/api/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/api/admin.py b/api/admin.py new file mode 100644 index 0000000..846f6b4 --- /dev/null +++ b/api/admin.py @@ -0,0 +1 @@ +# Register your models here. diff --git a/api/migrations/__init__.py b/api/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/api/models.py b/api/models.py new file mode 100644 index 0000000..6b20219 --- /dev/null +++ b/api/models.py @@ -0,0 +1 @@ +# Create your models here. diff --git a/api/tests.py b/api/tests.py new file mode 100644 index 0000000..a39b155 --- /dev/null +++ b/api/tests.py @@ -0,0 +1 @@ +# Create your tests here. diff --git a/api/views.py b/api/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/api/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/itpspapi/__init__.py b/itpspapi/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/itpspapi/asgi.py b/itpspapi/asgi.py new file mode 100644 index 0000000..f16c96b --- /dev/null +++ b/itpspapi/asgi.py @@ -0,0 +1,15 @@ +"""ASGI config for itpspapi 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/6.0/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "itpspapi.settings") + +application = get_asgi_application() diff --git a/itpspapi/settings.py b/itpspapi/settings.py new file mode 100644 index 0000000..0c6a089 --- /dev/null +++ b/itpspapi/settings.py @@ -0,0 +1,118 @@ +"""Django settings for itpspapi project. + +Generated by 'django-admin startproject' using Django 6.0. + +For more information on this file, see +https://docs.djangoproject.com/en/6.0/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/6.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/6.0/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +# TODO: move this to a .env file or similar +SECRET_KEY = "django-insecure-hl9cg2riekk@(a8+-v7t!u6lwsd=%s_vyj*!3o8-i@$6&-69sp" # noqa: S105 + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS: list[str] = [] + + +# Application definition + +INSTALLED_APPS = [ + "django.contrib.admin", + "django.contrib.auth", + "django.contrib.contenttypes", + "django.contrib.sessions", + "django.contrib.messages", + "django.contrib.staticfiles", + "api", +] + +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 = "itpspapi.urls" + +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", + ], + }, + }, +] + +WSGI_APPLICATION = "itpspapi.wsgi.application" + + +# Database +# https://docs.djangoproject.com/en/6.0/ref/settings/#databases + +DATABASES = { + "default": { + "ENGINE": "django.db.backends.sqlite3", + "NAME": BASE_DIR / "db.sqlite3", + }, +} + + +# Password validation +# https://docs.djangoproject.com/en/6.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/6.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/6.0/howto/static-files/ + +STATIC_URL = "static/" diff --git a/itpspapi/urls.py b/itpspapi/urls.py new file mode 100644 index 0000000..8ebad68 --- /dev/null +++ b/itpspapi/urls.py @@ -0,0 +1,24 @@ +"""URL configuration for itpspapi project. + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/6.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 + +urlpatterns = [ + path("admin/", admin.site.urls), +] diff --git a/itpspapi/wsgi.py b/itpspapi/wsgi.py new file mode 100644 index 0000000..0c9764f --- /dev/null +++ b/itpspapi/wsgi.py @@ -0,0 +1,15 @@ +"""WSGI config for itpspapi 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/6.0/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "itpspapi.settings") + +application = get_wsgi_application() diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..c9a705f --- /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", "itpspapi.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 abda1a4..6b292db 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -49,3 +49,6 @@ ignore = [ "TD003", "FIX", ] +exclude = [ + "manage.py" +]