Basic app structure

.gitignore

@@ -0,0 +1,3 @@
+/venv
+*.pyc
+*.swp

fedireads/migrations/0001_initial.py

@@ -0,0 +1,97 @@
+# Generated by Django 2.0.13 on 2020-01-25 06:23
+
+from django.conf import settings
+import django.contrib.auth.models
+import django.contrib.auth.validators
+import django.contrib.postgres.fields.jsonb
+from django.db import migrations, models
+import django.db.models.deletion
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0009_alter_user_last_name_max_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='User',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('password', models.CharField(max_length=128, verbose_name='password')),
+                ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
+                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
+                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')),
+                ('first_name', models.CharField(blank=True, max_length=30, verbose_name='first name')),
+                ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')),
+                ('email', models.EmailField(blank=True, max_length=254, verbose_name='email address')),
+                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('private_key', models.CharField(max_length=255)),
+                ('public_key', models.CharField(max_length=255)),
+                ('webfinger', django.contrib.postgres.fields.jsonb.JSONField(max_length=255)),
+                ('actor', django.contrib.postgres.fields.jsonb.JSONField(max_length=255)),
+                ('apikey', models.CharField(max_length=255)),
+                ('followers', models.CharField(max_length=255)),
+                ('messages', models.CharField(max_length=255)),
+                ('created_date', models.DateTimeField()),
+                ('updated_date', models.DateTimeField(blank=True, null=True)),
+                ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.Group', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.Permission', verbose_name='user permissions')),
+            ],
+            options={
+                'verbose_name': 'user',
+                'verbose_name_plural': 'users',
+                'abstract': False,
+            },
+            managers=[
+                ('objects', django.contrib.auth.models.UserManager()),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Book',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('openlibary_key', models.CharField(max_length=255)),
+                ('data', django.contrib.postgres.fields.jsonb.JSONField()),
+                ('added_date', models.DateTimeField()),
+                ('updated_date', models.DateTimeField(blank=True, null=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Review',
+            fields=[
+                ('name', models.CharField(max_length=255)),
+                ('content', django.contrib.postgres.fields.jsonb.JSONField(max_length=5000)),
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('star_rating', models.IntegerField(default=0)),
+                ('author', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL)),
+                ('book', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='fedireads.Book')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+        migrations.CreateModel(
+            name='Shelf',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=100)),
+                ('editable', models.BooleanField(default=True)),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='ShelfBooks',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('book', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='fedireads.Book')),
+                ('shelf', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='fedireads.Shelf')),
+            ],
+        ),
+    ]

fedireads/models.py

@@ -0,0 +1,56 @@
+''' database schema for the whole dang thing '''
+from django.db import models
+from django.contrib.auth.models import AbstractUser
+from django.contrib.postgres.fields import JSONField
+
+class User(AbstractUser):
+    ''' a user who wants to read books '''
+    private_key = models.CharField(max_length=255)
+    public_key = models.CharField(max_length=255)
+    webfinger = JSONField(max_length=255)
+    actor = JSONField(max_length=255, blank=True, null=True)
+    api_key = models.CharField(max_length=255, blank=True, null=True)
+    followers = models.CharField(max_length=255, blank=True, null=True)
+    messages = models.CharField(max_length=255, blank=True, null=True)
+    created_date = models.DateTimeField()
+    updated_date = models.DateTimeField(blank=True, null=True)
+
+
+class Message(models.Model):
+    ''' any kind of user post, incl. reviews, replies, and status updates '''
+    id = models.AutoField(primary_key=True)
+    author = models.ForeignKey('User', on_delete=models.PROTECT)
+    name = models.CharField(max_length=255)
+    content = JSONField(max_length=5000)
+
+    class Meta:
+        abstract = True
+
+
+class Review(Message):
+    id = models.AutoField(primary_key=True)
+    book = models.ForeignKey('Book', on_delete=models.PROTECT)
+    star_rating = models.IntegerField(default=0)
+
+
+class Shelf(models.Model):
+    id = models.AutoField(primary_key=True)
+    name = models.CharField(max_length=100)
+    user = models.ForeignKey('User', on_delete=models.PROTECT)
+    editable = models.BooleanField(default=True)
+
+
+class Book(models.Model):
+    ''' a non-canonical copy from open library '''
+    id = models.AutoField(primary_key=True)
+    openlibary_key = models.CharField(max_length=255)
+    data = JSONField()
+    added_date = models.DateTimeField()
+    updated_date = models.DateTimeField(blank=True, null=True)
+
+
+class ShelfBooks(models.Model):
+    ''' many to many join table '''
+    id = models.AutoField(primary_key=True)
+    shelf = models.ForeignKey('Shelf', on_delete=models.PROTECT)
+    book = models.ForeignKey('Book', on_delete=models.PROTECT)

fedireads/settings.py

@@ -0,0 +1,126 @@
+"""
+Django settings for fedireads project.
+
+Generated by 'django-admin startproject' using Django 2.0.13.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.0/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/2.0/ref/settings/
+"""
+
+import os
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = '7(2w1sedok=aznpq)ta1mc4i%4h=xx@hxwx*o57ctsuml0x%fr'
+
+# 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',
+    'fedireads',
+]
+
+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 = 'fedireads.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 = 'fedireads.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/2.0/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql_psycopg2',
+        'NAME': 'fedireads',
+        'USER': 'fedireads',
+        'PASSWORD': 'fedireads',
+        'HOST': '',
+        'PORT': 5432
+    }
+}
+
+AUTH_USER_MODEL = 'fedireads.User'
+
+# Password validation
+# https://docs.djangoproject.com/en/2.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/2.0/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/2.0/howto/static-files/
+
+STATIC_URL = '/static/'

fedireads/urls.py

@@ -0,0 +1,24 @@
+"""fedireads URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/2.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
+from fedireads import views
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+    path('api/', views.api),
+    path('webfinger/', views.webfinger),
+]

fedireads/views.py

@@ -0,0 +1,11 @@
+from django.contrib.auth.decorators import login_required
+
+@login_required
+def account_page(request):
+    return 'hi'
+
+def webfinger(request):
+    return 'hello'
+
+def api(request):
+    return 'hey'

fedireads/wsgi.py

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

manage.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "fedireads.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)

requirements.txt

@@ -0,0 +1,3 @@
+cryptography==2.8
+Django==2.0.13
+psycopg2==2.8.4