diff --git a/ldvspec/__init__.py b/ldvspec/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/ldvspec/ldvspec/__init__.py b/ldvspec/ldvspec/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/ldvspec/ldvspec/asgi.py b/ldvspec/ldvspec/asgi.py new file mode 100644 index 0000000000000000000000000000000000000000..3d76f2617e34926ad6d1f91f7a3413b2bdcda4d2 --- /dev/null +++ b/ldvspec/ldvspec/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for ldvspec 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/4.0/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ldvspec.settings') + +application = get_asgi_application() diff --git a/ldvspec/ldvspec/settings/__init__.py b/ldvspec/ldvspec/settings/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/ldvspec/ldvspec/settings/base.py b/ldvspec/ldvspec/settings/base.py new file mode 100644 index 0000000000000000000000000000000000000000..f24ba27ab887470a24c7db922f447bfb7f81d450 --- /dev/null +++ b/ldvspec/ldvspec/settings/base.py @@ -0,0 +1,118 @@ +""" +Django settings for ldvspec project. + +Generated by 'django-admin startproject' using Django 4.0.6. + +For more information on this file, see +https://docs.djangoproject.com/en/4.0/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/4.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/4.0/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'django-insecure-2x)iay_r&tj0_d8+z0+kl7ii2oz#048sh^ebfo(q#wmimxob!_' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'lofardata', + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'rest_framework', + 'rest_framework.authtoken', + 'corsheaders', + 'django_filters', + 'django_extensions', +] + +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 = 'ldvspec.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 = 'ldvspec.wsgi.application' + + +# Password validation +# https://docs.djangoproject.com/en/4.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/4.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/4.0/howto/static-files/ + +STATIC_URL = 'static/' + +# Default primary key field type +# https://docs.djangoproject.com/en/4.0/ref/settings/#default-auto-field + +DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' diff --git a/ldvspec/ldvspec/settings/dev.py b/ldvspec/ldvspec/settings/dev.py new file mode 100644 index 0000000000000000000000000000000000000000..6abeb007aa13b0c07a87cc74e16db6af2fa4f1f3 --- /dev/null +++ b/ldvspec/ldvspec/settings/dev.py @@ -0,0 +1,24 @@ +from ldvspec.settings.base import * + +# SECURITY WARNING: don't run with debug turned on in production! +DEV = True +DEBUG = True + +ALLOWED_HOSTS = ["*"] +CORS_ORIGIN_ALLOW_ALL = True + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql_psycopg2', + 'USER': 'atdb_admin', + 'PASSWORD': 'atdb123', + 'NAME': 'ldv-spec-db', + 'HOST': 'localhost', + 'PORT': '5432', + }, +} + +# Password validation +# https://docs.djangoproject.com/en/1.10/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [] diff --git a/ldvspec/ldvspec/urls.py b/ldvspec/ldvspec/urls.py new file mode 100644 index 0000000000000000000000000000000000000000..50e17ceaf8ab1d38a69ab4f16f7f466dfb605471 --- /dev/null +++ b/ldvspec/ldvspec/urls.py @@ -0,0 +1,23 @@ +"""ldvspec URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/4.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 include, path + +urlpatterns = [ + path('ldvspec/', include('lofardata.urls')), + path('ldvspec/admin/', admin.site.urls), + path('ldvspec/api-auth/', include('rest_framework.urls')), +] diff --git a/ldvspec/ldvspec/wsgi.py b/ldvspec/ldvspec/wsgi.py new file mode 100644 index 0000000000000000000000000000000000000000..e7f6e4facdf56ef581782639ea2601c47a0b4cbe --- /dev/null +++ b/ldvspec/ldvspec/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for ldvspec 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/4.0/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ldvspec.settings') + +application = get_wsgi_application() diff --git a/ldvspec/lofardata/__init__.py b/ldvspec/lofardata/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/ldvspec/lofardata/admin.py b/ldvspec/lofardata/admin.py new file mode 100644 index 0000000000000000000000000000000000000000..8c38f3f3dad51e4585f3984282c2a4bec5349c1e --- /dev/null +++ b/ldvspec/lofardata/admin.py @@ -0,0 +1,3 @@ +from django.contrib import admin + +# Register your models here. diff --git a/ldvspec/lofardata/apps.py b/ldvspec/lofardata/apps.py new file mode 100644 index 0000000000000000000000000000000000000000..5b2482b0c974eca1de2d9e29db732e8b7f4ce50c --- /dev/null +++ b/ldvspec/lofardata/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class LofardataConfig(AppConfig): + default_auto_field = 'django.db.models.BigAutoField' + name = 'lofardata' diff --git a/ldvspec/lofardata/migrations/0001_initial.py b/ldvspec/lofardata/migrations/0001_initial.py new file mode 100644 index 0000000000000000000000000000000000000000..2dfafde3f52298c19c88ce3c77ce475e3c5a5f2d --- /dev/null +++ b/ldvspec/lofardata/migrations/0001_initial.py @@ -0,0 +1,21 @@ +# Generated by Django 3.1.4 on 2022-07-11 13:51 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='LofarData', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('sas_id', models.CharField(blank=True, max_length=15, null=True, verbose_name='SAS_ID')), + ], + ), + ] diff --git a/ldvspec/lofardata/migrations/__init__.py b/ldvspec/lofardata/migrations/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/ldvspec/lofardata/models.py b/ldvspec/lofardata/models.py new file mode 100644 index 0000000000000000000000000000000000000000..cece29fd462734113c3584f41e2366894fca4edd --- /dev/null +++ b/ldvspec/lofardata/models.py @@ -0,0 +1,7 @@ +from django.db import models + +class LofarData(models.Model): + sas_id = models.CharField(verbose_name="SAS_ID",max_length=15, blank=True, null=True) + + def __str__(self): + return self.sas_id \ No newline at end of file diff --git a/ldvspec/lofardata/serializers.py b/ldvspec/lofardata/serializers.py new file mode 100644 index 0000000000000000000000000000000000000000..aaf9229c414b1b20f901be87a5d9fa53618cd7a9 --- /dev/null +++ b/ldvspec/lofardata/serializers.py @@ -0,0 +1,8 @@ +from rest_framework import serializers +from .models import LofarData + +class LofarDataSerializer(serializers.ModelSerializer): + + class Meta: + model = LofarData + fields = "__all__" diff --git a/ldvspec/lofardata/tests.py b/ldvspec/lofardata/tests.py new file mode 100644 index 0000000000000000000000000000000000000000..7ce503c2dd97ba78597f6ff6e4393132753573f6 --- /dev/null +++ b/ldvspec/lofardata/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/ldvspec/lofardata/urls.py b/ldvspec/lofardata/urls.py new file mode 100644 index 0000000000000000000000000000000000000000..18cc447999c251adb9b22d80b883f67e78491699 --- /dev/null +++ b/ldvspec/lofardata/urls.py @@ -0,0 +1,17 @@ +from django.urls import include, path +from django.contrib.auth import views as auth_views +from rest_framework.authtoken import views as rest_auth_views + +from . import views + +urlpatterns = [ + + # authentication + path('accounts/', include('django.contrib.auth.urls')), + + # specialization of the above, with more control + path('login/', auth_views.LoginView.as_view(template_name='registration/login.html')), + + # REST API + path('lofardata/', views.LofarDataView.as_view(), name='lofardata'), +] \ No newline at end of file diff --git a/ldvspec/lofardata/views.py b/ldvspec/lofardata/views.py new file mode 100644 index 0000000000000000000000000000000000000000..0c72b35a2c10394efab069ef74e8572205e2b801 --- /dev/null +++ b/ldvspec/lofardata/views.py @@ -0,0 +1,41 @@ + +from django.http import HttpResponse + +from rest_framework import generics, pagination +from rest_framework.views import APIView + +import django_filters +from django_filters import rest_framework as filters + +from .models import LofarData +from .serializers import LofarDataSerializer + +# --- Filters --- +class LofarDataFilter(filters.FilterSet): + class Meta: + model = LofarData + + fields = { + 'sas_id': ['exact', 'icontains'], + } + +# --- GUI --- + +def index(request): + return HttpResponse("Welcome to LDV-specification.") + + +# --- REST API views --- + +class LofarDataView(generics.ListCreateAPIView): + """ + A pagination list of tasks, unsorted. + """ + model = LofarData + serializer_class = LofarDataSerializer + + queryset = LofarData.objects.all().order_by('sas_id') + + # using the Django Filter Backend - https://django-filter.readthedocs.io/en/latest/index.html + filter_backends = (filters.DjangoFilterBackend,) + filter_class = LofarDataFilter diff --git a/ldvspec/manage.py b/ldvspec/manage.py new file mode 100644 index 0000000000000000000000000000000000000000..110f50eed9bb0655751f09aeaca46b10b0507598 --- /dev/null +++ b/ldvspec/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', 'ldvspec.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/ldvspec/requirements/base.txt b/ldvspec/requirements/base.txt new file mode 100644 index 0000000000000000000000000000000000000000..ca98ca30be922a485eed90d2192e2edd9a155d1c --- /dev/null +++ b/ldvspec/requirements/base.txt @@ -0,0 +1,15 @@ +asgiref==3.5.2 +Django==3.1.4 +sqlparse==0.4.2 +tzdata==2022.1 + +djangorestframework==3.12.2 +django-filter==2.3.0 +psycopg2-binary==2.9.3 +django-cors-headers==3.6.0 +django-extensions==3.1.0 +django-bootstrap-pagination==1.7.0 +pytz==2022.1 +whitenoise==5.0.1 +six==1.15.0 +fontawesome-free==5.15.2 diff --git a/ldvspec/requirements/dev.txt b/ldvspec/requirements/dev.txt new file mode 100644 index 0000000000000000000000000000000000000000..a3e81b8dcf5c42c11a685e429d9e22bca56c471b --- /dev/null +++ b/ldvspec/requirements/dev.txt @@ -0,0 +1 @@ +-r base.txt diff --git a/ldvspec/requirements/prod.txt b/ldvspec/requirements/prod.txt new file mode 100644 index 0000000000000000000000000000000000000000..4979310ee089926391000bfac2e67433dd7593e4 --- /dev/null +++ b/ldvspec/requirements/prod.txt @@ -0,0 +1,2 @@ +-r base.txt +gunicorn==19.9.0