Merge pull request #91 from smzkw/examples

Add a example project for testing and showcase

.github/workflows/test-examples-proj1.yml

@@ -0,0 +1,56 @@
+name: Test examples/proj1
+
+on:
+  push:
+    paths:
+      - 'examples/proj1/*'
+  pull_request:
+    paths:
+      - 'examples/proj1/*'
+
+jobs:
+  build:
+    name: build (Python ${{ matrix.python-version }}, Django ${{ matrix.django-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      max-parallel: 5
+      matrix:
+        python-version: ['3.10']
+        django-version: ['2.2', '3.1', '3.2']
+        include:
+          - django-version: 'main'
+            python-version: '3.10'
+
+    services:
+      postgres:
+        image: postgres:9.6-alpine
+        env:
+          POSTGRES_USER: test
+          POSTGRES_PASSWORD: test
+          POSTGRES_DB: test
+        ports:
+          - 5432:5432
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      working-directory: examples/proj1
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install -r requirements.txt
+        python -m pip install psycopg2-binary
+
+    - name: tests
+      working-directory: examples/proj1
+      env:
+        ENV_FILE: .env.psql
+      run: |
+        python manage.py makemigrations testapp
+        python manage.py sqlmigrate testapp 0001

.gitignore

@@ -10,3 +10,5 @@ dist/
 doc/_build/
 .coverage
 coverage.xml
+**/.env
+examples/**/migrations/*

examples/proj1/.env.psql

@@ -0,0 +1,2 @@
+DATABASE_URL=redshift://test:test@localhost:5432/test
+SECRET_KEY=django-insecure-key

examples/proj1/.env.sample

@@ -0,0 +1,2 @@
+DATABASE_URL=redshift://user:password@<cluster>.<slug>.<region>.redshift.amazonaws.com:5439/<name>?DISABLE_SERVER_SIDE_CURSORS=True
+SECRET_KEY=django-insecure-key

examples/proj1/config/asgi.py

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

examples/proj1/config/settings.py

@@ -0,0 +1,136 @@
+"""
+Django settings for proj1 project.
+
+Generated by 'django-admin startproject' using Django 3.2.12.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/ref/settings/
+"""
+from pathlib import Path
+import environ
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+env = environ.Env(
+    # set casting, default value
+    DEBUG=(bool, False)
+)
+if env('ENV_FILE', default=None):
+    # Take environment variables from specified file
+    env.read_env(env('ENV_FILE'))
+elif (BASE_DIR/'.env').is_file():
+    # Take environment variables from .env file
+    environ.Env.read_env(BASE_DIR/'.env')
+else:
+    pass  # use environment variable without .env file
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = env('SECRET_KEY')
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = env('DEBUG')
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+
+    'testapp',
+]
+
+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 = 'config.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 = 'config.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+DATABASES = {
+    'default': env.db(),
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.2/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/3.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.2/howto/static-files/
+
+STATIC_URL = '/static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'

examples/proj1/config/urls.py

@@ -0,0 +1,21 @@
+"""proj1 URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.2/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),
+]

examples/proj1/config/wsgi.py

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

examples/proj1/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '3.1'
+
+services:
+  db:
+    image: postgres:9.6-alpine
+    restart: always    
+    environment:
+      POSTGRES_USER: test
+      POSTGRES_PASSWORD: test
+      POSTGRES_DB: test
+    ports:
+      - 5432:5432

examples/proj1/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', 'config.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()

examples/proj1/requirements.txt

@@ -0,0 +1,3 @@
+Django<4
+django-environ==0.8.1
+-e ../..

examples/proj1/testapp/models.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+from django.db import models
+
+from django_redshift_backend.base import DistKey
+
+
+class TestModel(models.Model):
+    ctime = models.DateTimeField()
+    text = models.TextField()
+    uuid = models.UUIDField()
+
+
+class TestReferencedModel(models.Model):
+    pass
+
+
+class TestModelWithMetaKeys(models.Model):
+    name = models.CharField(max_length=100)
+    age = models.IntegerField()
+    created_at = models.DateTimeField()
+    fk = models.ForeignKey(TestReferencedModel, on_delete=models.CASCADE)
+
+    class Meta:
+        indexes = [DistKey(fields=['fk'])]
+        ordering = ['created_at', '-id']
+
+
+class TestParentModel(models.Model):
+    age = models.IntegerField()
+
+
+class TestChildModel(models.Model):
+    parent = models.ForeignKey(TestParentModel, on_delete=models.CASCADE)
+    age = models.IntegerField()