Merge pull request #2 from CentreForDigitalHumanities/feature/django

Feature/django

.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Tests
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - 'develop'
+      - 'main'
+      - 'release/**'
+  pull_request:
+    branches:
+      - 'develop'
+      - 'main'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r requirements-dev.txt
+      - name: Lint with ruff
+        run: |
+          pip install ruff
+          ruff --output-format=github --target-version=py38 .
+      - name: Test with pytest
+        run: |
+          cp lidiabrowser/lidiabrowser/.env.dist lidiabrowser/lidiabrowser/.env
+          pytest lidiabrowser

.gitignore

@@ -1 +1,4 @@
 .tool-versions
+.env
+*.db
+__pycache__/

README.md

@@ -1,3 +1,33 @@
-# LIDIA: Linguistic Diagnostics explorer
+# LIDIA Browser: Linguistic Diagnostics explorer
 
 This project fetches bibliographic entries and annotations from the LinguisticDiagnostics Zotero group library, and allows to browse and search them.
+
+
+## Installation
+
+Install the dependencies:
+
+    pip install -r requirements.txt
+
+Create a file `lidiabrowser/lidiabrowser/.env` with your Zotero library and authentication details:
+
+```sh
+ZOTERO_LIBRARY_ID=12345
+# Library type is 'user' or 'group'
+ZOTERO_LIBRARY_TYPE=group
+ZOTERO_API_KEY=a1b2c3d
+```
+
+By default, LIDIA Browser is set to use SQLite3, so no database setup is necessary.
+
+
+## Usage
+
+To run on a local machine, use:
+
+```sh
+cd lidiabrowser
+python manage.py migrate
+python manage.py runserver
+```
+

lidiabrowser/.gitignore

@@ -0,0 +1 @@
+db.sqlite3

lidiabrowser/lidiabrowser/.env.dist

@@ -0,0 +1,5 @@
+# For information on how to find these values, see
+# https://github.com/urschrei/pyzotero
+ZOTERO_LIBRARY_ID=12345
+ZOTERO_LIBRARY_TYPE=user
+ZOTERO_API_KEY=a1b2c3d

lidiabrowser/lidiabrowser/asgi.py

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

lidiabrowser/lidiabrowser/settings.py

@@ -0,0 +1,154 @@
+"""
+Django settings for lidiabrowser project.
+
+Generated by 'django-admin startproject' using Django 4.2.6.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.2/ref/settings/
+"""
+
+from pathlib import Path
+import environ
+
+root = environ.Path(__file__)
+env = environ.Env()
+environ.Env.read_env()
+
+SITE_ROOT = root()
+
+# 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.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-m8_b*$)+y4!o3%-=$xf2kpiu6cqd16&0bekmw94^hfucpjzja&"
+
+# 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",
+    "sync.apps.SyncConfig",
+]
+
+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 = "lidiabrowser.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 = "lidiabrowser.wsgi.application"
+
+LOGGING = {
+    "version": 1,  # the dictConfig format version
+    "disable_existing_loggers": False,  # retain the default loggers
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+        },
+    },
+    "loggers": {
+        "": {
+            "handlers": ["console"],
+            "level": "INFO",
+        }
+    },
+}
+
+
+# Database
+# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.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/4.2/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.2/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+# LIDIA-specific settings
+
+ZOTERO_LIBRARY_ID = env.str("ZOTERO_LIBRARY_ID")
+ZOTERO_LIBRARY_TYPE = env.str("ZOTERO_LIBRARY_TYPE")
+ZOTERO_API_KEY = env.str("ZOTERO_API_KEY")

lidiabrowser/lidiabrowser/urls.py

@@ -0,0 +1,22 @@
+"""
+URL configuration for lidiabrowser project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.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),
+]

lidiabrowser/lidiabrowser/wsgi.py

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

lidiabrowser/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", "lidiabrowser.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()

lidiabrowser/pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = lidiabrowser.settings
+python_files = tests.py test_*.py *_tests.py

lidiabrowser/sync/admin.py

@@ -0,0 +1,20 @@
+from django.contrib import admin
+
+from .models import Annotation, Publication, Sync
+
+
+class AnnotationAdmin(admin.ModelAdmin):
+    pass
+
+
+class PublicationAdmin(admin.ModelAdmin):
+    pass
+
+
+class SyncAdmin(admin.ModelAdmin):
+    pass
+
+
+admin.site.register(Annotation, AnnotationAdmin)
+admin.site.register(Publication, PublicationAdmin)
+admin.site.register(Sync, SyncAdmin)

lidiabrowser/sync/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class SyncConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "sync"

lidiabrowser/sync/management/commands/sync.py

@@ -0,0 +1,10 @@
+from django.core.management.base import BaseCommand
+
+from sync.zoterosync import sync
+
+
+class Command(BaseCommand):
+    help = "Synchronize with data on the Zotero server"
+
+    def handle(self, *args, **options):
+        sync()