From 64857f724af03e256817166545ecdffc34884011 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 6 Dec 2023 23:30:01 +0000 Subject: [PATCH] Bootstrap a testing project --- .gitignore | 176 +++++++++++++++++++++++++++++++++ content/core.page/test.yaml | 2 + manage.py | 22 +++++ requirements.txt | 2 + yamdl_content/__init__.py | 0 yamdl_content/asgi.py | 16 +++ yamdl_content/core/__init__.py | 0 yamdl_content/core/models.py | 8 ++ yamdl_content/settings.py | 128 ++++++++++++++++++++++++ yamdl_content/urls.py | 20 ++++ yamdl_content/wsgi.py | 16 +++ 11 files changed, 390 insertions(+) create mode 100644 .gitignore create mode 100644 content/core.page/test.yaml create mode 100755 manage.py create mode 100644 requirements.txt create mode 100644 yamdl_content/__init__.py create mode 100644 yamdl_content/asgi.py create mode 100644 yamdl_content/core/__init__.py create mode 100644 yamdl_content/core/models.py create mode 100644 yamdl_content/settings.py create mode 100644 yamdl_content/urls.py create mode 100644 yamdl_content/wsgi.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ad4a1f1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,176 @@ +# Created by https://www.toptal.com/developers/gitignore/api/python +# Edit at https://www.toptal.com/developers/gitignore?templates=python + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +### Python Patch ### +# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration +poetry.toml + +# ruff +.ruff_cache/ + +# LSP config files +pyrightconfig.json + +# End of https://www.toptal.com/developers/gitignore/api/python diff --git a/content/core.page/test.yaml b/content/core.page/test.yaml new file mode 100644 index 0000000..90260bb --- /dev/null +++ b/content/core.page/test.yaml @@ -0,0 +1,2 @@ +- title: Foo + content: bar diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..e013ed8 --- /dev/null +++ b/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', 'yamdl_content.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/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f1d0673 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +django +git+https://github.com/andrewgodwin/yamdl diff --git a/yamdl_content/__init__.py b/yamdl_content/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/yamdl_content/asgi.py b/yamdl_content/asgi.py new file mode 100644 index 0000000..42b9200 --- /dev/null +++ b/yamdl_content/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for yamdl_content 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', 'yamdl_content.settings') + +application = get_asgi_application() diff --git a/yamdl_content/core/__init__.py b/yamdl_content/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/yamdl_content/core/models.py b/yamdl_content/core/models.py new file mode 100644 index 0000000..2a5904a --- /dev/null +++ b/yamdl_content/core/models.py @@ -0,0 +1,8 @@ +from django.db import models + +class Page(models.Model): + __yamdl__ = True + + title = models.CharField(max_length=255) + + content = models.TextField() diff --git a/yamdl_content/settings.py b/yamdl_content/settings.py new file mode 100644 index 0000000..8dad8f9 --- /dev/null +++ b/yamdl_content/settings.py @@ -0,0 +1,128 @@ +""" +Django settings for yamdl_content project. + +Generated by 'django-admin startproject' using Django 5.0. + +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-13rey)pheg9^%jtworn_&3wl&$-l%40uza0!ijva+l$n5umuz3' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.messages', + 'django.contrib.staticfiles', + "yamdl", + "yamdl_content.core" +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'yamdl_content.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 = 'yamdl_content.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/5.0/ref/settings/#databases + +DATABASES = { + 'yamdl': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': 'file:yamdl-db?mode=memory&cache=shared', + } +} + +DATABASES["default"] = DATABASES["yamdl"] + +YAMDL_DIRECTORIES = [ + BASE_DIR / "content", +] + +# 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' + +DATABASE_ROUTERS = [ + "yamdl.router.YamdlRouter", +] diff --git a/yamdl_content/urls.py b/yamdl_content/urls.py new file mode 100644 index 0000000..a1e4c73 --- /dev/null +++ b/yamdl_content/urls.py @@ -0,0 +1,20 @@ +""" +URL configuration for yamdl_content 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.urls import path + +urlpatterns = [ +] diff --git a/yamdl_content/wsgi.py b/yamdl_content/wsgi.py new file mode 100644 index 0000000..a459130 --- /dev/null +++ b/yamdl_content/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for yamdl_content 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', 'yamdl_content.settings') + +application = get_wsgi_application()