From c635cd93302d1ded0266bd55d4025821892ea1a7 Mon Sep 17 00:00:00 2001 From: Keith Smith Date: Fri, 30 Oct 2026 15:56:58 -0600 Subject: [PATCH] Scaffold Django project and add first-run auth flow Sets up the Evection project structure: split settings supporting both SQLite and PostgreSQL via DATABASE_URL, Celery+Redis wiring, and the planned app layout (accounts, feeds, articles, rules, search, reader, pwa, core). Implements multi-user auth with a FreshRSS-style first-run setup wizard, login/logout, and admin-only user management, covered by automated tests. Co-Authored-By: Claude Sonnet 5 --- .env.example | 25 +++++ .gitignore | 13 +++ README.md | 29 ++++++ apps/__init__.py | 0 apps/accounts/__init__.py | 0 apps/accounts/admin.py | 9 ++ apps/accounts/apps.py | 6 ++ apps/accounts/forms.py | 30 ++++++ apps/accounts/middleware.py | 33 +++++++ apps/accounts/migrations/0001_initial.py | 119 +++++++++++++++++++++++ apps/accounts/migrations/__init__.py | 0 apps/accounts/models.py | 7 ++ apps/accounts/tests.py | 92 ++++++++++++++++++ apps/accounts/urls.py | 18 ++++ apps/accounts/views.py | 47 +++++++++ apps/articles/__init__.py | 0 apps/articles/admin.py | 1 + apps/articles/apps.py | 6 ++ apps/articles/migrations/__init__.py | 0 apps/articles/models.py | 1 + apps/articles/tests.py | 1 + apps/articles/views.py | 1 + apps/core/__init__.py | 0 apps/core/admin.py | 1 + apps/core/apps.py | 6 ++ apps/core/migrations/__init__.py | 0 apps/core/models.py | 1 + apps/core/tests.py | 1 + apps/core/views.py | 1 + apps/feeds/__init__.py | 0 apps/feeds/admin.py | 1 + apps/feeds/apps.py | 6 ++ apps/feeds/migrations/__init__.py | 0 apps/feeds/models.py | 1 + apps/feeds/tests.py | 1 + apps/feeds/views.py | 1 + apps/pwa/__init__.py | 0 apps/pwa/admin.py | 1 + apps/pwa/apps.py | 6 ++ apps/pwa/migrations/__init__.py | 0 apps/pwa/models.py | 1 + apps/pwa/tests.py | 1 + apps/pwa/views.py | 1 + apps/reader/__init__.py | 0 apps/reader/admin.py | 1 + apps/reader/apps.py | 6 ++ apps/reader/migrations/__init__.py | 0 apps/reader/models.py | 1 + apps/reader/tests.py | 1 + apps/reader/urls.py | 9 ++ apps/reader/views.py | 7 ++ apps/rules/__init__.py | 0 apps/rules/admin.py | 1 + apps/rules/apps.py | 6 ++ apps/rules/migrations/__init__.py | 0 apps/rules/models.py | 1 + apps/rules/tests.py | 1 + apps/rules/views.py | 1 + apps/search/__init__.py | 0 apps/search/admin.py | 1 + apps/search/apps.py | 6 ++ apps/search/migrations/__init__.py | 0 apps/search/models.py | 1 + apps/search/tests.py | 1 + apps/search/views.py | 1 + config/__init__.py | 3 + config/asgi.py | 16 +++ config/celery.py | 20 ++++ config/settings/__init__.py | 0 config/settings/base.py | 113 +++++++++++++++++++++ config/settings/dev.py | 4 + config/settings/prod.py | 11 +++ config/settings/test.py | 7 ++ config/urls.py | 8 ++ config/wsgi.py | 16 +++ manage.py | 23 +++++ pyproject.toml | 56 +++++++++++ static/css/base.css | 36 +++++++ templates/accounts/create_user.html | 10 ++ templates/accounts/login.html | 10 ++ templates/accounts/manage_users.html | 11 +++ templates/accounts/setup.html | 11 +++ templates/base.html | 22 +++++ templates/reader/stream.html | 7 ++ 84 files changed, 897 insertions(+) create mode 100644 .env.example create mode 100644 .gitignore create mode 100644 apps/__init__.py create mode 100644 apps/accounts/__init__.py create mode 100644 apps/accounts/admin.py create mode 100644 apps/accounts/apps.py create mode 100644 apps/accounts/forms.py create mode 100644 apps/accounts/middleware.py create mode 100644 apps/accounts/migrations/0001_initial.py create mode 100644 apps/accounts/migrations/__init__.py create mode 100644 apps/accounts/models.py create mode 100644 apps/accounts/tests.py create mode 100644 apps/accounts/urls.py create mode 100644 apps/accounts/views.py create mode 100644 apps/articles/__init__.py create mode 100644 apps/articles/admin.py create mode 100644 apps/articles/apps.py create mode 100644 apps/articles/migrations/__init__.py create mode 100644 apps/articles/models.py create mode 100644 apps/articles/tests.py create mode 100644 apps/articles/views.py create mode 100644 apps/core/__init__.py create mode 100644 apps/core/admin.py create mode 100644 apps/core/apps.py create mode 100644 apps/core/migrations/__init__.py create mode 100644 apps/core/models.py create mode 100644 apps/core/tests.py create mode 100644 apps/core/views.py create mode 100644 apps/feeds/__init__.py create mode 100644 apps/feeds/admin.py create mode 100644 apps/feeds/apps.py create mode 100644 apps/feeds/migrations/__init__.py create mode 100644 apps/feeds/models.py create mode 100644 apps/feeds/tests.py create mode 100644 apps/feeds/views.py create mode 100644 apps/pwa/__init__.py create mode 100644 apps/pwa/admin.py create mode 100644 apps/pwa/apps.py create mode 100644 apps/pwa/migrations/__init__.py create mode 100644 apps/pwa/models.py create mode 100644 apps/pwa/tests.py create mode 100644 apps/pwa/views.py create mode 100644 apps/reader/__init__.py create mode 100644 apps/reader/admin.py create mode 100644 apps/reader/apps.py create mode 100644 apps/reader/migrations/__init__.py create mode 100644 apps/reader/models.py create mode 100644 apps/reader/tests.py create mode 100644 apps/reader/urls.py create mode 100644 apps/reader/views.py create mode 100644 apps/rules/__init__.py create mode 100644 apps/rules/admin.py create mode 100644 apps/rules/apps.py create mode 100644 apps/rules/migrations/__init__.py create mode 100644 apps/rules/models.py create mode 100644 apps/rules/tests.py create mode 100644 apps/rules/views.py create mode 100644 apps/search/__init__.py create mode 100644 apps/search/admin.py create mode 100644 apps/search/apps.py create mode 100644 apps/search/migrations/__init__.py create mode 100644 apps/search/models.py create mode 100644 apps/search/tests.py create mode 100644 apps/search/views.py create mode 100644 config/__init__.py create mode 100644 config/asgi.py create mode 100644 config/celery.py create mode 100644 config/settings/__init__.py create mode 100644 config/settings/base.py create mode 100644 config/settings/dev.py create mode 100644 config/settings/prod.py create mode 100644 config/settings/test.py create mode 100644 config/urls.py create mode 100644 config/wsgi.py create mode 100755 manage.py create mode 100644 pyproject.toml create mode 100644 static/css/base.css create mode 100644 templates/accounts/create_user.html create mode 100644 templates/accounts/login.html create mode 100644 templates/accounts/manage_users.html create mode 100644 templates/accounts/setup.html create mode 100644 templates/base.html create mode 100644 templates/reader/stream.html diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..bd70411 --- /dev/null +++ b/.env.example @@ -0,0 +1,25 @@ +# Copy to .env and adjust for your environment. + +# A long, random, secret value — never commit your real one. +SECRET_KEY=change-me-to-a-long-random-value + +DEBUG=False +ALLOWED_HOSTS=localhost,127.0.0.1 + +# SQLite (default, zero-config): +DATABASE_URL=sqlite:///db.sqlite3 +# Postgres: +# DATABASE_URL=postgres://evection:password@localhost:5432/evection + +REDIS_URL=redis://localhost:6379/0 + +# Open account registration is off by default; the first account created via +# the setup wizard becomes the instance admin. +EVECTION_SIGNUP_ENABLED=False + +# Global floor for any feed's polling interval, in minutes. +EVECTION_MIN_FETCH_INTERVAL_MINUTES=15 + +# Bump this on deploys that change cached static assets to invalidate old +# service worker caches. +EVECTION_PWA_CACHE_VERSION=v1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..130a362 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +__pycache__/ +*.py[cod] +*.sqlite3 +.env +.venv/ +venv/ +staticfiles/ +media/ +*.egg-info/ +.pytest_cache/ +.ruff_cache/ +.coverage +htmlcov/ diff --git a/README.md b/README.md index e69de29..158bc6f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,29 @@ +# Evection + +A self-hosted RSS/Atom feed reader, in the spirit of FreshRSS, built in Python +(Django) instead of PHP. Installable as a PWA on mobile. + +Status: early scaffolding — auth and accounts are in place; feed fetching, +reading UI, search, rules, OPML, and the PWA layer are still to come. + +## Development setup + +```bash +python3 -m venv .venv +source .venv/bin/activate +pip install -e ".[dev]" +cp .env.example .env +python manage.py migrate +python manage.py runserver +``` + +Visit `http://localhost:8000/` — you'll land on the first-run setup wizard to +create the instance's admin account. + +## Tests + +```bash +pytest +ruff check . +black --check . +``` diff --git a/apps/__init__.py b/apps/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/accounts/__init__.py b/apps/accounts/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/accounts/admin.py b/apps/accounts/admin.py new file mode 100644 index 0000000..48bab6c --- /dev/null +++ b/apps/accounts/admin.py @@ -0,0 +1,9 @@ +from django.contrib import admin +from django.contrib.auth.admin import UserAdmin as DjangoUserAdmin + +from .models import User + + +@admin.register(User) +class UserAdmin(DjangoUserAdmin): + fieldsets = DjangoUserAdmin.fieldsets + (("Evection", {"fields": ("timezone",)}),) diff --git a/apps/accounts/apps.py b/apps/accounts/apps.py new file mode 100644 index 0000000..e3ceb5a --- /dev/null +++ b/apps/accounts/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class AccountsConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.accounts" diff --git a/apps/accounts/forms.py b/apps/accounts/forms.py new file mode 100644 index 0000000..0582737 --- /dev/null +++ b/apps/accounts/forms.py @@ -0,0 +1,30 @@ +from django import forms +from django.contrib.auth.forms import UsernameField + +from .models import User + + +class SetupForm(forms.ModelForm): + password = forms.CharField(widget=forms.PasswordInput, min_length=8) + password_confirm = forms.CharField(widget=forms.PasswordInput, min_length=8) + + class Meta: + model = User + fields = ["username", "email"] + field_classes = {"username": UsernameField} + + def clean(self): + cleaned_data = super().clean() + if cleaned_data.get("password") != cleaned_data.get("password_confirm"): + raise forms.ValidationError("Passwords do not match.") + return cleaned_data + + +class CreateUserForm(forms.ModelForm): + password = forms.CharField(widget=forms.PasswordInput, min_length=8) + + class Meta: + model = User + fields = ["username", "email", "is_staff"] + field_classes = {"username": UsernameField} + labels = {"is_staff": "Grant admin access"} diff --git a/apps/accounts/middleware.py b/apps/accounts/middleware.py new file mode 100644 index 0000000..f7c3feb --- /dev/null +++ b/apps/accounts/middleware.py @@ -0,0 +1,33 @@ +from django.conf import settings +from django.shortcuts import redirect +from django.urls import reverse + +from .models import User + +_SETUP_EXEMPT_PREFIXES = (settings.STATIC_URL,) + + +class SetupWizardMiddleware: + """Force every request to the first-run setup wizard until an account exists. + + Once any User row exists, /setup/ becomes unreachable again (see the + setup view), mirroring FreshRSS's one-time install wizard. The "a user + exists" check only ever flips false -> true for the lifetime of an + instance, so it's cached per-process after the first positive result to + avoid a query on every request. + """ + + _a_user_exists = False + + def __init__(self, get_response): + self.get_response = get_response + + def __call__(self, request): + path = request.path + if not path.startswith(_SETUP_EXEMPT_PREFIXES): + if not SetupWizardMiddleware._a_user_exists: + SetupWizardMiddleware._a_user_exists = User.objects.exists() + setup_url = reverse("accounts:setup") + if path != setup_url and not SetupWizardMiddleware._a_user_exists: + return redirect(setup_url) + return self.get_response(request) diff --git a/apps/accounts/migrations/0001_initial.py b/apps/accounts/migrations/0001_initial.py new file mode 100644 index 0000000..7b5e428 --- /dev/null +++ b/apps/accounts/migrations/0001_initial.py @@ -0,0 +1,119 @@ +# Generated by Django 5.2.18 on 2026-10-30 00:01 + +import django.contrib.auth.models +import django.contrib.auth.validators +import django.utils.timezone +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ("auth", "0012_alter_user_first_name_max_length"), + ] + + operations = [ + migrations.CreateModel( + name="User", + fields=[ + ( + "id", + models.BigAutoField( + 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=150, 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" + ), + ), + ("timezone", models.CharField(default="UTC", max_length=64)), + ("created_at", models.DateTimeField(auto_now_add=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()), + ], + ), + ] diff --git a/apps/accounts/migrations/__init__.py b/apps/accounts/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/accounts/models.py b/apps/accounts/models.py new file mode 100644 index 0000000..f68d6c6 --- /dev/null +++ b/apps/accounts/models.py @@ -0,0 +1,7 @@ +from django.contrib.auth.models import AbstractUser +from django.db import models + + +class User(AbstractUser): + timezone = models.CharField(max_length=64, default="UTC") + created_at = models.DateTimeField(auto_now_add=True) diff --git a/apps/accounts/tests.py b/apps/accounts/tests.py new file mode 100644 index 0000000..ecb9afa --- /dev/null +++ b/apps/accounts/tests.py @@ -0,0 +1,92 @@ +import pytest +from django.urls import reverse + +from .middleware import SetupWizardMiddleware +from .models import User + + +@pytest.fixture(autouse=True) +def _reset_setup_wizard_cache(): + SetupWizardMiddleware._a_user_exists = False + yield + SetupWizardMiddleware._a_user_exists = False + + +@pytest.mark.django_db +def test_root_redirects_to_setup_when_no_users_exist(client): + response = client.get("/", follow=False) + assert response.status_code == 302 + assert response.url == reverse("accounts:setup") + + +@pytest.mark.django_db +def test_setup_creates_admin_and_logs_in(client): + response = client.post( + reverse("accounts:setup"), + { + "username": "keith", + "email": "keith@example.com", + "password": "correct-horse-battery", + "password_confirm": "correct-horse-battery", + }, + ) + assert response.status_code == 302 + assert response.url == reverse("reader:stream") + + user = User.objects.get(username="keith") + assert user.is_staff + assert user.is_superuser + + stream_response = client.get(reverse("reader:stream")) + assert stream_response.status_code == 200 + + +@pytest.mark.django_db +def test_setup_is_unreachable_once_a_user_exists(client): + User.objects.create_user("existing", password="irrelevant") + + response = client.get(reverse("accounts:setup")) + assert response.status_code == 302 + assert response.url == reverse("accounts:login") + + +@pytest.mark.django_db +def test_setup_rejects_mismatched_passwords(client): + response = client.post( + reverse("accounts:setup"), + { + "username": "keith", + "email": "keith@example.com", + "password": "correct-horse-battery", + "password_confirm": "does-not-match", + }, + ) + assert response.status_code == 200 + assert not User.objects.exists() + + +@pytest.mark.django_db +def test_non_admin_cannot_manage_users(client): + User.objects.create_user("regular", password="pw-regular-123") + client.login(username="regular", password="pw-regular-123") + + response = client.get(reverse("accounts:manage_users")) + assert response.status_code == 302 # user_passes_test redirects non-staff + + +@pytest.mark.django_db +def test_admin_can_create_user(client): + admin = User.objects.create_user("admin", password="pw-admin-123", is_staff=True) + client.login(username="admin", password="pw-admin-123") + + response = client.post( + reverse("accounts:create_user"), + { + "username": "newperson", + "email": "newperson@example.com", + "password": "pw-newperson-123", + }, + ) + assert response.status_code == 302 + assert User.objects.filter(username="newperson").exists() + assert admin.pk # sanity: fixture user untouched diff --git a/apps/accounts/urls.py b/apps/accounts/urls.py new file mode 100644 index 0000000..650a52f --- /dev/null +++ b/apps/accounts/urls.py @@ -0,0 +1,18 @@ +from django.contrib.auth import views as auth_views +from django.urls import path + +from . import views + +app_name = "accounts" + +urlpatterns = [ + path("setup/", views.setup, name="setup"), + path( + "login/", + auth_views.LoginView.as_view(template_name="accounts/login.html"), + name="login", + ), + path("logout/", auth_views.LogoutView.as_view(), name="logout"), + path("users/", views.manage_users, name="manage_users"), + path("users/create/", views.create_user, name="create_user"), +] diff --git a/apps/accounts/views.py b/apps/accounts/views.py new file mode 100644 index 0000000..313189d --- /dev/null +++ b/apps/accounts/views.py @@ -0,0 +1,47 @@ +from django.contrib import messages +from django.contrib.auth import login +from django.contrib.auth.decorators import user_passes_test +from django.shortcuts import redirect, render + +from .forms import CreateUserForm, SetupForm +from .middleware import SetupWizardMiddleware +from .models import User + +is_admin = user_passes_test(lambda u: u.is_authenticated and u.is_staff) + + +def setup(request): + if User.objects.exists(): + return redirect("accounts:login") + + form = SetupForm(request.POST or None) + if request.method == "POST" and form.is_valid(): + user = form.save(commit=False) + user.set_password(form.cleaned_data["password"]) + user.is_staff = True + user.is_superuser = True + user.save() + SetupWizardMiddleware._a_user_exists = True + login(request, user) + messages.success(request, "Welcome to Evection! Your admin account is ready.") + return redirect("reader:stream") + + return render(request, "accounts/setup.html", {"form": form}) + + +@is_admin +def manage_users(request): + users = User.objects.order_by("username") + return render(request, "accounts/manage_users.html", {"users": users}) + + +@is_admin +def create_user(request): + form = CreateUserForm(request.POST or None) + if request.method == "POST" and form.is_valid(): + user = form.save(commit=False) + user.set_password(form.cleaned_data["password"]) + user.save() + messages.success(request, f"Account '{user.username}' created.") + return redirect("accounts:manage_users") + return render(request, "accounts/create_user.html", {"form": form}) diff --git a/apps/articles/__init__.py b/apps/articles/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/articles/admin.py b/apps/articles/admin.py new file mode 100644 index 0000000..846f6b4 --- /dev/null +++ b/apps/articles/admin.py @@ -0,0 +1 @@ +# Register your models here. diff --git a/apps/articles/apps.py b/apps/articles/apps.py new file mode 100644 index 0000000..c1eceb6 --- /dev/null +++ b/apps/articles/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class ArticlesConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.articles" diff --git a/apps/articles/migrations/__init__.py b/apps/articles/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/articles/models.py b/apps/articles/models.py new file mode 100644 index 0000000..6b20219 --- /dev/null +++ b/apps/articles/models.py @@ -0,0 +1 @@ +# Create your models here. diff --git a/apps/articles/tests.py b/apps/articles/tests.py new file mode 100644 index 0000000..a39b155 --- /dev/null +++ b/apps/articles/tests.py @@ -0,0 +1 @@ +# Create your tests here. diff --git a/apps/articles/views.py b/apps/articles/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/apps/articles/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/apps/core/__init__.py b/apps/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/core/admin.py b/apps/core/admin.py new file mode 100644 index 0000000..846f6b4 --- /dev/null +++ b/apps/core/admin.py @@ -0,0 +1 @@ +# Register your models here. diff --git a/apps/core/apps.py b/apps/core/apps.py new file mode 100644 index 0000000..ab0051e --- /dev/null +++ b/apps/core/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class CoreConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.core" diff --git a/apps/core/migrations/__init__.py b/apps/core/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/core/models.py b/apps/core/models.py new file mode 100644 index 0000000..6b20219 --- /dev/null +++ b/apps/core/models.py @@ -0,0 +1 @@ +# Create your models here. diff --git a/apps/core/tests.py b/apps/core/tests.py new file mode 100644 index 0000000..a39b155 --- /dev/null +++ b/apps/core/tests.py @@ -0,0 +1 @@ +# Create your tests here. diff --git a/apps/core/views.py b/apps/core/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/apps/core/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/apps/feeds/__init__.py b/apps/feeds/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/feeds/admin.py b/apps/feeds/admin.py new file mode 100644 index 0000000..846f6b4 --- /dev/null +++ b/apps/feeds/admin.py @@ -0,0 +1 @@ +# Register your models here. diff --git a/apps/feeds/apps.py b/apps/feeds/apps.py new file mode 100644 index 0000000..6ed6d05 --- /dev/null +++ b/apps/feeds/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class FeedsConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.feeds" diff --git a/apps/feeds/migrations/__init__.py b/apps/feeds/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/feeds/models.py b/apps/feeds/models.py new file mode 100644 index 0000000..6b20219 --- /dev/null +++ b/apps/feeds/models.py @@ -0,0 +1 @@ +# Create your models here. diff --git a/apps/feeds/tests.py b/apps/feeds/tests.py new file mode 100644 index 0000000..a39b155 --- /dev/null +++ b/apps/feeds/tests.py @@ -0,0 +1 @@ +# Create your tests here. diff --git a/apps/feeds/views.py b/apps/feeds/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/apps/feeds/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/apps/pwa/__init__.py b/apps/pwa/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/pwa/admin.py b/apps/pwa/admin.py new file mode 100644 index 0000000..846f6b4 --- /dev/null +++ b/apps/pwa/admin.py @@ -0,0 +1 @@ +# Register your models here. diff --git a/apps/pwa/apps.py b/apps/pwa/apps.py new file mode 100644 index 0000000..bf28928 --- /dev/null +++ b/apps/pwa/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class PwaConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.pwa" diff --git a/apps/pwa/migrations/__init__.py b/apps/pwa/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/pwa/models.py b/apps/pwa/models.py new file mode 100644 index 0000000..6b20219 --- /dev/null +++ b/apps/pwa/models.py @@ -0,0 +1 @@ +# Create your models here. diff --git a/apps/pwa/tests.py b/apps/pwa/tests.py new file mode 100644 index 0000000..a39b155 --- /dev/null +++ b/apps/pwa/tests.py @@ -0,0 +1 @@ +# Create your tests here. diff --git a/apps/pwa/views.py b/apps/pwa/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/apps/pwa/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/apps/reader/__init__.py b/apps/reader/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/reader/admin.py b/apps/reader/admin.py new file mode 100644 index 0000000..846f6b4 --- /dev/null +++ b/apps/reader/admin.py @@ -0,0 +1 @@ +# Register your models here. diff --git a/apps/reader/apps.py b/apps/reader/apps.py new file mode 100644 index 0000000..dd21c75 --- /dev/null +++ b/apps/reader/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class ReaderConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.reader" diff --git a/apps/reader/migrations/__init__.py b/apps/reader/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/reader/models.py b/apps/reader/models.py new file mode 100644 index 0000000..6b20219 --- /dev/null +++ b/apps/reader/models.py @@ -0,0 +1 @@ +# Create your models here. diff --git a/apps/reader/tests.py b/apps/reader/tests.py new file mode 100644 index 0000000..a39b155 --- /dev/null +++ b/apps/reader/tests.py @@ -0,0 +1 @@ +# Create your tests here. diff --git a/apps/reader/urls.py b/apps/reader/urls.py new file mode 100644 index 0000000..38c3b18 --- /dev/null +++ b/apps/reader/urls.py @@ -0,0 +1,9 @@ +from django.urls import path + +from . import views + +app_name = "reader" + +urlpatterns = [ + path("", views.stream, name="stream"), +] diff --git a/apps/reader/views.py b/apps/reader/views.py new file mode 100644 index 0000000..841d68e --- /dev/null +++ b/apps/reader/views.py @@ -0,0 +1,7 @@ +from django.contrib.auth.decorators import login_required +from django.shortcuts import render + + +@login_required +def stream(request): + return render(request, "reader/stream.html") diff --git a/apps/rules/__init__.py b/apps/rules/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/rules/admin.py b/apps/rules/admin.py new file mode 100644 index 0000000..846f6b4 --- /dev/null +++ b/apps/rules/admin.py @@ -0,0 +1 @@ +# Register your models here. diff --git a/apps/rules/apps.py b/apps/rules/apps.py new file mode 100644 index 0000000..76e9f35 --- /dev/null +++ b/apps/rules/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class RulesConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.rules" diff --git a/apps/rules/migrations/__init__.py b/apps/rules/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/rules/models.py b/apps/rules/models.py new file mode 100644 index 0000000..6b20219 --- /dev/null +++ b/apps/rules/models.py @@ -0,0 +1 @@ +# Create your models here. diff --git a/apps/rules/tests.py b/apps/rules/tests.py new file mode 100644 index 0000000..a39b155 --- /dev/null +++ b/apps/rules/tests.py @@ -0,0 +1 @@ +# Create your tests here. diff --git a/apps/rules/views.py b/apps/rules/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/apps/rules/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/apps/search/__init__.py b/apps/search/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/search/admin.py b/apps/search/admin.py new file mode 100644 index 0000000..846f6b4 --- /dev/null +++ b/apps/search/admin.py @@ -0,0 +1 @@ +# Register your models here. diff --git a/apps/search/apps.py b/apps/search/apps.py new file mode 100644 index 0000000..9815271 --- /dev/null +++ b/apps/search/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class SearchConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.search" diff --git a/apps/search/migrations/__init__.py b/apps/search/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/apps/search/models.py b/apps/search/models.py new file mode 100644 index 0000000..6b20219 --- /dev/null +++ b/apps/search/models.py @@ -0,0 +1 @@ +# Create your models here. diff --git a/apps/search/tests.py b/apps/search/tests.py new file mode 100644 index 0000000..a39b155 --- /dev/null +++ b/apps/search/tests.py @@ -0,0 +1 @@ +# Create your tests here. diff --git a/apps/search/views.py b/apps/search/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/apps/search/views.py @@ -0,0 +1 @@ +# Create your views here. diff --git a/config/__init__.py b/config/__init__.py new file mode 100644 index 0000000..53f4ccb --- /dev/null +++ b/config/__init__.py @@ -0,0 +1,3 @@ +from .celery import app as celery_app + +__all__ = ("celery_app",) diff --git a/config/asgi.py b/config/asgi.py new file mode 100644 index 0000000..7780c46 --- /dev/null +++ b/config/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for config 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.2/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.prod") + +application = get_asgi_application() diff --git a/config/celery.py b/config/celery.py new file mode 100644 index 0000000..487f488 --- /dev/null +++ b/config/celery.py @@ -0,0 +1,20 @@ +import os + +from celery import Celery +from celery.schedules import crontab + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.dev") + +app = Celery("evection") +app.config_from_object("django.conf:settings", namespace="CELERY") +app.autodiscover_tasks() + +# A single fixed-interval beat schedule drives all feed polling; per-feed +# fetch_interval_minutes is plain model data evaluated inside poll_due_feeds, +# not a separate beat entry per feed. +app.conf.beat_schedule = { + "poll-due-feeds": { + "task": "apps.feeds.tasks.poll_due_feeds", + "schedule": crontab(minute="*/1"), + }, +} diff --git a/config/settings/__init__.py b/config/settings/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/config/settings/base.py b/config/settings/base.py new file mode 100644 index 0000000..2ea64ec --- /dev/null +++ b/config/settings/base.py @@ -0,0 +1,113 @@ +""" +Base Django settings for Evection, shared by all environments. + +Environment-specific overrides live in dev.py / prod.py / test.py. +""" + +from pathlib import Path + +import environ + +BASE_DIR = Path(__file__).resolve().parent.parent.parent + +env = environ.Env() +env_file = BASE_DIR / ".env" +if env_file.exists(): + environ.Env.read_env(str(env_file)) + +SECRET_KEY = env.str("SECRET_KEY", default="django-insecure-change-me-in-production") +DEBUG = env.bool("DEBUG", default=False) +ALLOWED_HOSTS = env.list("ALLOWED_HOSTS", default=["localhost", "127.0.0.1"]) + +INSTALLED_APPS = [ + "django.contrib.admin", + "django.contrib.auth", + "django.contrib.contenttypes", + "django.contrib.sessions", + "django.contrib.messages", + "django.contrib.staticfiles", + # third-party + "django_htmx", + # Evection apps + "apps.core", + "apps.accounts", + "apps.feeds", + "apps.articles", + "apps.rules", + "apps.search", + "apps.reader", + "apps.pwa", +] + +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", + "django_htmx.middleware.HtmxMiddleware", + "apps.accounts.middleware.SetupWizardMiddleware", +] + +ROOT_URLCONF = "config.urls" + +TEMPLATES = [ + { + "BACKEND": "django.template.backends.django.DjangoTemplates", + "DIRS": [BASE_DIR / "templates"], + "APP_DIRS": True, + "OPTIONS": { + "context_processors": [ + "django.template.context_processors.request", + "django.contrib.auth.context_processors.auth", + "django.contrib.messages.context_processors.messages", + ], + }, + }, +] + +WSGI_APPLICATION = "config.wsgi.application" +ASGI_APPLICATION = "config.asgi.application" + +# Database — DATABASE_URL drives both SQLite and Postgres installs, e.g.: +# sqlite:///db.sqlite3 +# postgres://user:pass@host:5432/dbname +DATABASES = {"default": env.db_url("DATABASE_URL", default=f"sqlite:///{BASE_DIR / 'db.sqlite3'}")} + +AUTH_USER_MODEL = "accounts.User" + +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"}, +] + +LOGIN_URL = "accounts:login" +LOGIN_REDIRECT_URL = "reader:stream" +LOGOUT_REDIRECT_URL = "accounts:login" + +LANGUAGE_CODE = "en-us" +TIME_ZONE = "UTC" +USE_I18N = True +USE_TZ = True + +STATIC_URL = "static/" +STATICFILES_DIRS = [BASE_DIR / "static"] +STATIC_ROOT = BASE_DIR / "staticfiles" + +DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" + +# Evection-specific settings +EVECTION_SIGNUP_ENABLED = env.bool("EVECTION_SIGNUP_ENABLED", default=False) +EVECTION_MIN_FETCH_INTERVAL_MINUTES = env.int("EVECTION_MIN_FETCH_INTERVAL_MINUTES", default=15) +EVECTION_PWA_CACHE_VERSION = env.str("EVECTION_PWA_CACHE_VERSION", default="v1") + +# Celery +CELERY_BROKER_URL = env.str("REDIS_URL", default="redis://localhost:6379/0") +CELERY_RESULT_BACKEND = None +CELERY_TASK_SERIALIZER = "json" +CELERY_ACCEPT_CONTENT = ["json"] +CELERY_TIMEZONE = TIME_ZONE diff --git a/config/settings/dev.py b/config/settings/dev.py new file mode 100644 index 0000000..4e1e933 --- /dev/null +++ b/config/settings/dev.py @@ -0,0 +1,4 @@ +from .base import * # noqa: F403 + +DEBUG = True +ALLOWED_HOSTS = ["*"] diff --git a/config/settings/prod.py b/config/settings/prod.py new file mode 100644 index 0000000..da51a82 --- /dev/null +++ b/config/settings/prod.py @@ -0,0 +1,11 @@ +from .base import * # noqa: F403 +from .base import env + +DEBUG = False + +SECURE_SSL_REDIRECT = env.bool("SECURE_SSL_REDIRECT", default=True) +SESSION_COOKIE_SECURE = True +CSRF_COOKIE_SECURE = True +SECURE_HSTS_SECONDS = env.int("SECURE_HSTS_SECONDS", default=60 * 60 * 24 * 7) +SECURE_HSTS_INCLUDE_SUBDOMAINS = True +SECURE_PROXY_SSL_HEADER = ("HTTP_X_FORWARDED_PROTO", "https") diff --git a/config/settings/test.py b/config/settings/test.py new file mode 100644 index 0000000..54e27fe --- /dev/null +++ b/config/settings/test.py @@ -0,0 +1,7 @@ +from .base import * # noqa: F403 + +DEBUG = False +CELERY_TASK_ALWAYS_EAGER = True +CELERY_TASK_EAGER_PROPAGATES = True + +PASSWORD_HASHERS = ["django.contrib.auth.hashers.MD5PasswordHasher"] diff --git a/config/urls.py b/config/urls.py new file mode 100644 index 0000000..d52dd50 --- /dev/null +++ b/config/urls.py @@ -0,0 +1,8 @@ +from django.contrib import admin +from django.urls import include, path + +urlpatterns = [ + path("admin/", admin.site.urls), + path("", include("apps.accounts.urls")), + path("", include("apps.reader.urls")), +] diff --git a/config/wsgi.py b/config/wsgi.py new file mode 100644 index 0000000..7e0750d --- /dev/null +++ b/config/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for config 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.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.prod") + +application = get_wsgi_application() diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..d630389 --- /dev/null +++ b/manage.py @@ -0,0 +1,23 @@ +#!/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.dev") + 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/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..292254d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,56 @@ +[build-system] +requires = ["setuptools>=68"] +build-backend = "setuptools.build_meta" + +[project] +name = "evection" +version = "0.1.0" +description = "Self-hosted RSS/Atom feed reader, inspired by FreshRSS, built in Python/Django." +readme = "README.md" +requires-python = ">=3.11" +license = { text = "AGPL-3.0-or-later" } +dependencies = [ + "django>=5.0,<5.3", + "celery>=5.3,<6", + "redis>=5,<6", + "feedparser>=6.0,<7", + "requests>=2.31,<3", + "nh3>=0.2,<1", + "defusedxml>=0.7,<1", + "django-environ>=0.11,<1", + "django-htmx>=1.17,<2", + "psycopg[binary]>=3.1,<4", + "gunicorn>=21,<24", +] + +[project.optional-dependencies] +dev = [ + "pytest>=8,<9", + "pytest-django>=4.8,<5", + "factory_boy>=3.3,<4", + "responses>=0.25,<1", + "freezegun>=1.4,<2", + "ruff>=0.4", + "black>=24", +] + +[tool.setuptools] +py-modules = [] + +[tool.ruff] +line-length = 100 +target-version = "py311" +exclude = [".venv", "migrations"] + +[tool.ruff.lint] +select = ["E", "F", "I"] + +[tool.black] +line-length = 100 +target-version = ["py311", "py312"] +extend-exclude = "migrations" + +[tool.pytest.ini_options] +DJANGO_SETTINGS_MODULE = "config.settings.test" +python_files = ["test_*.py", "*_test.py", "tests.py"] +testpaths = ["apps"] diff --git a/static/css/base.css b/static/css/base.css new file mode 100644 index 0000000..cdec7b6 --- /dev/null +++ b/static/css/base.css @@ -0,0 +1,36 @@ +:root { + color-scheme: light dark; + font-family: system-ui, -apple-system, Segoe UI, Roboto, sans-serif; +} + +body { + margin: 0; + padding: 1rem; + max-width: 48rem; + margin-inline: auto; +} + +.messages { + list-style: none; + padding: 0; +} + +.message { + padding: 0.5rem 0.75rem; + border-radius: 0.375rem; + margin-bottom: 0.5rem; +} + +.message-success { background: #d1fae5; } +.message-error { background: #fee2e2; } + +form p { + display: flex; + flex-direction: column; + gap: 0.25rem; +} + +input, button { + font-size: 1rem; + padding: 0.5rem; +} diff --git a/templates/accounts/create_user.html b/templates/accounts/create_user.html new file mode 100644 index 0000000..9739055 --- /dev/null +++ b/templates/accounts/create_user.html @@ -0,0 +1,10 @@ +{% extends "base.html" %} +{% block title %}Create user — Evection{% endblock %} +{% block content %} +

Create user

+
+ {% csrf_token %} + {{ form.as_p }} + +
+{% endblock %} diff --git a/templates/accounts/login.html b/templates/accounts/login.html new file mode 100644 index 0000000..751dc23 --- /dev/null +++ b/templates/accounts/login.html @@ -0,0 +1,10 @@ +{% extends "base.html" %} +{% block title %}Log in — Evection{% endblock %} +{% block content %} +

Log in

+
+ {% csrf_token %} + {{ form.as_p }} + +
+{% endblock %} diff --git a/templates/accounts/manage_users.html b/templates/accounts/manage_users.html new file mode 100644 index 0000000..1017b8d --- /dev/null +++ b/templates/accounts/manage_users.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} +{% block title %}Manage users — Evection{% endblock %} +{% block content %} +

Users

+

Create user

+ +{% endblock %} diff --git a/templates/accounts/setup.html b/templates/accounts/setup.html new file mode 100644 index 0000000..5374542 --- /dev/null +++ b/templates/accounts/setup.html @@ -0,0 +1,11 @@ +{% extends "base.html" %} +{% block title %}Set up Evection{% endblock %} +{% block content %} +

Welcome to Evection

+

Create the first admin account for this instance.

+
+ {% csrf_token %} + {{ form.as_p }} + +
+{% endblock %} diff --git a/templates/base.html b/templates/base.html new file mode 100644 index 0000000..8c965ae --- /dev/null +++ b/templates/base.html @@ -0,0 +1,22 @@ +{% load static %} + + + + + + {% block title %}Evection{% endblock %} + + + + {% if messages %} + + {% endif %} +
+ {% block content %}{% endblock %} +
+ + diff --git a/templates/reader/stream.html b/templates/reader/stream.html new file mode 100644 index 0000000..65ac2bc --- /dev/null +++ b/templates/reader/stream.html @@ -0,0 +1,7 @@ +{% extends "base.html" %} +{% block title %}Stream — Evection{% endblock %} +{% block content %} +

Your stream

+

No feeds yet. The reading UI lands in a later milestone.

+

Log out

+{% endblock %}