From 3b5b301e42daa0f59c9555d2e930ae6c90a54c0d Mon Sep 17 00:00:00 2001 From: "Marko (Hermes Implementer)" Date: Tue, 26 May 2026 00:50:06 +0000 Subject: [PATCH] feat: bookmarks and notes management - Backend: Django REST Framework API with Bookmark and Note models - ViewSets with user-scoped querysets and select_related for N+1 prevention - Create/List/Detail/Update/Delete endpoints - Batch delete operations - Unique constraint on user+book+page for bookmarks - IsOwner permission class for object-level access control - Full serializer validation (page > 0, non-empty content, duplicate check) - 30+ pytest-django tests covering CRUD, auth, filtering, edge cases - Frontend: React TypeScript components - AnnotationsContext with useReducer for state management - BookmarkList, NoteList, AddAnnotationForm, AnnotationsDashboard - Inline note editing with immediate save - Batch delete support - API client with JWT auto-refresh interceptors - Paginated query hook for infinite scroll support - Responsive CSS with loading/empty states - Infrastructure: Django project with custom User model, JWT auth, CORS - PostgreSQL database models with proper FK and indexes - Django admin configuration for all models --- README.md | 38 + api/Dockerfile | 18 + api/books/__init__.py | 0 api/books/admin.py | 20 + api/books/apps.py | 6 + api/books/management/__init__.py | 1 + api/books/management/commands/__init__.py | 1 + api/books/management/commands/seed_books.py | 134 +++ api/books/migrations/0001_initial.py | 56 ++ api/books/migrations/__init__.py | 1 + api/books/models.py | 111 +++ api/books/serializers.py | 136 +++ api/books/urls.py | 15 + api/books/views.py | 88 ++ api/manage.py | 21 + api/project/__init__.py | 0 api/project/settings.py | 109 +++ api/project/urls.py | 7 + api/project/wsgi.py | 6 + api/pyproject.toml | 21 + api/uv.lock | 290 +++++++ backend/.env.example | 8 + backend/apps/__init__.py | 0 backend/apps/annotations/__init__.py | 0 backend/apps/annotations/admin.py | 19 + backend/apps/annotations/apps.py | 7 + backend/apps/annotations/models.py | 84 ++ backend/apps/annotations/permissions.py | 8 + backend/apps/annotations/serializers.py | 108 +++ backend/apps/annotations/tests.py | 331 ++++++++ backend/apps/annotations/urls.py | 12 + backend/apps/annotations/views.py | 93 +++ backend/apps/books/__init__.py | 0 backend/apps/books/admin.py | 9 + backend/apps/books/apps.py | 7 + backend/apps/books/models.py | 21 + backend/apps/books/serializers.py | 28 + backend/apps/books/urls.py | 11 + backend/apps/books/views.py | 24 + backend/apps/users/__init__.py | 0 backend/apps/users/admin.py | 11 + backend/apps/users/apps.py | 7 + backend/apps/users/models.py | 13 + backend/apps/users/urls.py | 8 + backend/config/django.py | 153 ++++ backend/config/settings.py | 42 + backend/config/urls.py | 9 + backend/config/wsgi.py | 7 + backend/manage.py | 23 + backend/pytest.ini | 8 + backend/requirements.txt | 14 + docker-compose.yml | 52 ++ frontend/index.html | 12 + frontend/package.json | 30 + frontend/src/api/annotations.ts | 96 +++ frontend/src/api/client.ts | 67 ++ .../annotations/AddAnnotationForm.tsx | 120 +++ .../annotations/AnnotationsDashboard.tsx | 109 +++ .../components/annotations/BookmarkList.tsx | 87 ++ .../annotations/BookmarksNotesPage.tsx | 23 + .../src/components/annotations/NoteList.tsx | 148 ++++ frontend/src/components/annotations/index.ts | 4 + frontend/src/components/layout/Layout.tsx | 27 + frontend/src/components/layout/index.ts | 1 + frontend/src/context/AnnotationsContext.tsx | 277 +++++++ frontend/src/hooks/index.ts | 1 + frontend/src/hooks/usePaginatedQuery.ts | 69 ++ frontend/src/main.tsx | 53 ++ frontend/src/styles.css | 429 ++++++++++ frontend/src/types/__tests__/types.test.ts | 10 + frontend/src/types/index.ts | 95 +++ frontend/tsconfig.json | 25 + frontend/vite-env.d.ts | 1 + frontend/vite.config.ts | 21 + frontend/vitest.config.ts | 18 + package.json | 12 + web/index.html | 16 + web/package.json | 23 + web/src/App.css | 515 ++++++++++++ web/src/App.tsx | 46 ++ web/src/api/books.ts | 58 ++ web/src/components/BookDetail.tsx | 91 ++ web/src/components/BookFilters.tsx | 110 +++ web/src/components/BookList.tsx | 111 +++ web/src/components/SearchBar.tsx | 57 ++ web/src/main.tsx | 12 + web/src/pages/BookDetailPage.tsx | 63 ++ web/src/pages/LibraryPage.tsx | 147 ++++ web/src/types.ts | 52 ++ web/src/types/book.ts | 36 + web/src/vite-env.d.ts | 9 + web/tsconfig.json | 24 + web/vite.config.ts | 11 + yarn.lock | 774 ++++++++++++++++++ 94 files changed, 6086 insertions(+) create mode 100644 README.md create mode 100644 api/Dockerfile create mode 100644 api/books/__init__.py create mode 100644 api/books/admin.py create mode 100644 api/books/apps.py create mode 100644 api/books/management/__init__.py create mode 100644 api/books/management/commands/__init__.py create mode 100644 api/books/management/commands/seed_books.py create mode 100644 api/books/migrations/0001_initial.py create mode 100644 api/books/migrations/__init__.py create mode 100644 api/books/models.py create mode 100644 api/books/serializers.py create mode 100644 api/books/urls.py create mode 100644 api/books/views.py create mode 100644 api/manage.py create mode 100644 api/project/__init__.py create mode 100644 api/project/settings.py create mode 100644 api/project/urls.py create mode 100644 api/project/wsgi.py create mode 100644 api/pyproject.toml create mode 100644 api/uv.lock create mode 100644 backend/.env.example create mode 100644 backend/apps/__init__.py create mode 100644 backend/apps/annotations/__init__.py create mode 100644 backend/apps/annotations/admin.py create mode 100644 backend/apps/annotations/apps.py create mode 100644 backend/apps/annotations/models.py create mode 100644 backend/apps/annotations/permissions.py create mode 100644 backend/apps/annotations/serializers.py create mode 100644 backend/apps/annotations/tests.py create mode 100644 backend/apps/annotations/urls.py create mode 100644 backend/apps/annotations/views.py create mode 100644 backend/apps/books/__init__.py create mode 100644 backend/apps/books/admin.py create mode 100644 backend/apps/books/apps.py create mode 100644 backend/apps/books/models.py create mode 100644 backend/apps/books/serializers.py create mode 100644 backend/apps/books/urls.py create mode 100644 backend/apps/books/views.py create mode 100644 backend/apps/users/__init__.py create mode 100644 backend/apps/users/admin.py create mode 100644 backend/apps/users/apps.py create mode 100644 backend/apps/users/models.py create mode 100644 backend/apps/users/urls.py create mode 100644 backend/config/django.py create mode 100644 backend/config/settings.py create mode 100644 backend/config/urls.py create mode 100644 backend/config/wsgi.py create mode 100644 backend/manage.py create mode 100644 backend/pytest.ini create mode 100644 backend/requirements.txt create mode 100644 docker-compose.yml create mode 100644 frontend/index.html create mode 100644 frontend/package.json create mode 100644 frontend/src/api/annotations.ts create mode 100644 frontend/src/api/client.ts create mode 100644 frontend/src/components/annotations/AddAnnotationForm.tsx create mode 100644 frontend/src/components/annotations/AnnotationsDashboard.tsx create mode 100644 frontend/src/components/annotations/BookmarkList.tsx create mode 100644 frontend/src/components/annotations/BookmarksNotesPage.tsx create mode 100644 frontend/src/components/annotations/NoteList.tsx create mode 100644 frontend/src/components/annotations/index.ts create mode 100644 frontend/src/components/layout/Layout.tsx create mode 100644 frontend/src/components/layout/index.ts create mode 100644 frontend/src/context/AnnotationsContext.tsx create mode 100644 frontend/src/hooks/index.ts create mode 100644 frontend/src/hooks/usePaginatedQuery.ts create mode 100644 frontend/src/main.tsx create mode 100644 frontend/src/styles.css create mode 100644 frontend/src/types/__tests__/types.test.ts create mode 100644 frontend/src/types/index.ts create mode 100644 frontend/tsconfig.json create mode 100644 frontend/vite-env.d.ts create mode 100644 frontend/vite.config.ts create mode 100644 frontend/vitest.config.ts create mode 100644 package.json create mode 100644 web/index.html create mode 100644 web/package.json create mode 100644 web/src/App.css create mode 100644 web/src/App.tsx create mode 100644 web/src/api/books.ts create mode 100644 web/src/components/BookDetail.tsx create mode 100644 web/src/components/BookFilters.tsx create mode 100644 web/src/components/BookList.tsx create mode 100644 web/src/components/SearchBar.tsx create mode 100644 web/src/main.tsx create mode 100644 web/src/pages/BookDetailPage.tsx create mode 100644 web/src/pages/LibraryPage.tsx create mode 100644 web/src/types.ts create mode 100644 web/src/types/book.ts create mode 100644 web/src/vite-env.d.ts create mode 100644 web/tsconfig.json create mode 100644 web/vite.config.ts create mode 100644 yarn.lock diff --git a/README.md b/README.md new file mode 100644 index 0000000..dbf85cd --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Cloud Reader + +A full-stack cloud-based e-book reader application with cross-device synchronization. + +## Architecture + +- **Backend**: Django 5.x + Django REST Framework +- **Frontend**: React with TypeScript +- **Database**: PostgreSQL +- **Monorepo**: Yarn workspaces + +## Getting Started + +### Prerequisites +- Python 3.12+ +- Node.js 20+ +- PostgreSQL 15+ + +### Backend Setup +```bash +cd backend +python -m venv .venv +source .venv/bin/activate +pip install -r requirements.txt +python manage.py migrate +python manage.py runserver +``` + +### Frontend Setup +```bash +cd frontend +yarn install +yarn dev +``` + +## Projects + +See [Gitea Issues](https://gitea-dev.codescripters.org/crisleo-hermes/cloud-reader/issues) for the full roadmap. \ No newline at end of file diff --git a/api/Dockerfile b/api/Dockerfile new file mode 100644 index 0000000..67f5823 --- /dev/null +++ b/api/Dockerfile @@ -0,0 +1,18 @@ +FROM python:3.12-slim + +WORKDIR /app + +RUN apt-get update && apt-get install -y --no-install-recommends \ + libpq-dev gcc && \ + rm -rf /var/lib/apt/lists/* + +COPY pyproject.toml ./ +RUN pip install uv && uv sync --frozen + +COPY . . + +RUN mkdir -p media + +EXPOSE 8000 + +CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"] \ No newline at end of file diff --git a/api/books/__init__.py b/api/books/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/api/books/admin.py b/api/books/admin.py new file mode 100644 index 0000000..810af01 --- /dev/null +++ b/api/books/admin.py @@ -0,0 +1,20 @@ +from django.contrib import admin + +from books.models import Book, ReadingProgress, ReadingSettings + + +@admin.register(Book) +class BookAdmin(admin.ModelAdmin): + list_display = ["title", "author", "user", "created_at"] + list_filter = ["created_at", "user"] + search_fields = ["title", "author"] + + +@admin.register(ReadingProgress) +class ReadingProgressAdmin(admin.ModelAdmin): + list_display = ["book", "user", "current_position", "updated_at"] + + +@admin.register(ReadingSettings) +class ReadingSettingsAdmin(admin.ModelAdmin): + list_display = ["user", "font_size", "font_style", "background_color"] \ No newline at end of file diff --git a/api/books/apps.py b/api/books/apps.py new file mode 100644 index 0000000..a36e8ef --- /dev/null +++ b/api/books/apps.py @@ -0,0 +1,6 @@ +from django.apps import AppConfig + + +class BooksConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "books" \ No newline at end of file diff --git a/api/books/management/__init__.py b/api/books/management/__init__.py new file mode 100644 index 0000000..a693ec4 --- /dev/null +++ b/api/books/management/__init__.py @@ -0,0 +1 @@ +# management/__init__.py \ No newline at end of file diff --git a/api/books/management/commands/__init__.py b/api/books/management/commands/__init__.py new file mode 100644 index 0000000..61f42e0 --- /dev/null +++ b/api/books/management/commands/__init__.py @@ -0,0 +1 @@ +# management/commands/__init__.py \ No newline at end of file diff --git a/api/books/management/commands/seed_books.py b/api/books/management/commands/seed_books.py new file mode 100644 index 0000000..7d94c32 --- /dev/null +++ b/api/books/management/commands/seed_books.py @@ -0,0 +1,134 @@ +""" +Management command to seed sample book data for development and testing. +""" +from __future__ import annotations + +from typing import Any + +from django.core.management.base import BaseCommand + +from books.models import Book, ReadingStatus + +SAMPLE_BOOKS: list[dict[str, Any]] = [ + { + "title": "The Great Gatsby", + "author": "F. Scott Fitzgerald", + "genre": "Classic Literature", + "description": "A story of the mysteriously wealthy Jay Gatsby and his love for the beautiful Daisy Buchanan.", + "reading_status": ReadingStatus.FINISHED, + }, + { + "title": "To Kill a Mockingbird", + "author": "Harper Lee", + "genre": "Classic Literature", + "description": "The unforgettable novel of a childhood in a sleepy Southern town and the crisis of conscience that rocked it.", + "reading_status": ReadingStatus.FINISHED, + }, + { + "title": "1984", + "author": "George Orwell", + "genre": "Science Fiction", + "description": "A dystopian social science fiction novel and cautionary tale about the future of totalitarianism.", + "reading_status": ReadingStatus.READING, + }, + { + "title": "Dune", + "author": "Frank Herbert", + "genre": "Science Fiction", + "description": "Set on the desert planet Arrakis, it is one of the world's best-selling science fiction novels.", + "reading_status": ReadingStatus.FINISHED, + }, + { + "title": "The Hobbit", + "author": "J.R.R. Tolkien", + "genre": "Fantasy", + "description": "Bilbo Baggins is swept into a quest to reclaim the lost Dwarf Kingdom of Erebor from the fearsome dragon Smaug.", + "reading_status": ReadingStatus.FINISHED, + }, + { + "title": "Pride and Prejudice", + "author": "Jane Austen", + "genre": "Romance", + "description": "A romantic novel of manners that follows the character development of Elizabeth Bennet.", + "reading_status": ReadingStatus.WANT_TO_READ, + }, + { + "title": "The Martian", + "author": "Andy Weir", + "genre": "Science Fiction", + "description": "An astronaut becomes stranded alone on Mars and must find a way to signal that he is alive.", + "reading_status": ReadingStatus.READING, + }, + { + "title": "The Catcher in the Rye", + "author": "J.D. Salinger", + "genre": "Classic Literature", + "description": "The story of Holden Caulfield's experiences in New York City after being expelled from prep school.", + "reading_status": ReadingStatus.DNF, + }, + { + "title": "The Alchemist", + "author": "Paulo Coelho", + "genre": "Philosophy", + "description": "A young Andalusian shepherd follows his dream to find treasure at the Egyptian pyramids.", + "reading_status": ReadingStatus.WANT_TO_READ, + }, + { + "title": "Neuromancer", + "author": "William Gibson", + "genre": "Science Fiction", + "description": "The novel that launched the cyberpunk genre, following washed-up computer hacker Henry Case.", + "reading_status": ReadingStatus.FINISHED, + }, + { + "title": "The Name of the Wind", + "author": "Patrick Rothfuss", + "genre": "Fantasy", + "description": "The tale of the magically gifted young man who grows to be the most notorious wizard his world has ever seen.", + "reading_status": ReadingStatus.READING, + }, + { + "title": "Gone Girl", + "author": "Gillian Flynn", + "genre": "Thriller", + "description": "A mystery thriller about a wife's disappearance on the day of her fifth wedding anniversary.", + "reading_status": ReadingStatus.FINISHED, + }, + { + "title": "Sapiens", + "author": "Yuval Noah Harari", + "genre": "Non-Fiction", + "description": "A brief history of humankind, exploring how biology and history have defined us.", + "reading_status": ReadingStatus.FINISHED, + }, + { + "title": "The Road", + "author": "Cormac McCarthy", + "genre": "Post-Apocalyptic", + "description": "A father and his young son walk alone through burned America heading toward the coast.", + "reading_status": ReadingStatus.WANT_TO_READ, + }, + { + "title": "The Three-Body Problem", + "author": "Cixin Liu", + "genre": "Science Fiction", + "description": "The first novel in the Remembrance of Earth's Past trilogy, a blend of physics and alien contact.", + "reading_status": ReadingStatus.READING, + }, +] + + +class Command(BaseCommand): + """Seed the database with sample books.""" + + help = "Seeds the database with sample books for development and testing." + + def handle(self, *args: Any, **options: Any) -> str | None: + for i, book_data in enumerate(SAMPLE_BOOKS): + Book.objects.get_or_create( + title=book_data["title"], + author=book_data["author"], + defaults=book_data, + ) + count = Book.objects.count() + self.stdout.write(self.style.SUCCESS(f"Seeded {count} books into the database.")) \ No newline at end of file diff --git a/api/books/migrations/0001_initial.py b/api/books/migrations/0001_initial.py new file mode 100644 index 0000000..f8a620f --- /dev/null +++ b/api/books/migrations/0001_initial.py @@ -0,0 +1,56 @@ +import django.db.models.deletion +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies: list = [] + + operations = [ + migrations.CreateModel( + name="Book", + fields=[ + ( + "id", + models.BigAutoField( + auto_created=True, + primary_key=True, + serialize=False, + verbose_name="ID", + ), + ), + ("title", models.CharField(db_index=True, max_length=500)), + ("author", models.CharField(db_index=True, max_length=300)), + ("genre", models.CharField(db_index=True, max_length=100)), + ("description", models.TextField(blank=True, default="")), + ( + "reading_status", + models.CharField( + choices=[ + ("want_to_read", "Want to Read"), + ("reading", "Reading"), + ("finished", "Finished"), + ("dnf", "Did Not Finish"), + ], + db_index=True, + default="want_to_read", + max_length=20, + ), + ), + ("cover_url", models.URLField(blank=True, default="")), + ("created_at", models.DateTimeField(auto_now_add=True)), + ("updated_at", models.DateTimeField(auto_now=True)), + ], + options={ + "ordering": ["title"], + "indexes": [ + models.Index( + fields=["title", "author", "genre"], + name="books_book_title_2cc25e_idx", + ) + ], + }, + ), + ] \ No newline at end of file diff --git a/api/books/migrations/__init__.py b/api/books/migrations/__init__.py new file mode 100644 index 0000000..f55c8b5 --- /dev/null +++ b/api/books/migrations/__init__.py @@ -0,0 +1 @@ +# migrations/__init__.py \ No newline at end of file diff --git a/api/books/models.py b/api/books/models.py new file mode 100644 index 0000000..797aac6 --- /dev/null +++ b/api/books/models.py @@ -0,0 +1,111 @@ +from enum import StrEnum +from pathlib import Path + +from django.conf import settings +from django.core.validators import FileExtensionValidator +from django.db import models +from django.db.models.signals import post_delete +from django.dispatch import receiver + + +class FontStyle(StrEnum): + SANS_SERIF = "sans-serif" + SERIF = "serif" + MONOSPACE = "monospace" + + +class BackgroundColor(StrEnum): + WHITE = "#ffffff" + SEPIA = "#f4e4c1" + DARK = "#1a1a2e" + GREEN = "#c7edcc" + + +class Book(models.Model): + user = models.ForeignKey( + settings.AUTH_USER_MODEL, + on_delete=models.CASCADE, + related_name="books", + ) + title = models.CharField(max_length=512) + author = models.CharField(max_length=256, blank=True, default="") + file = models.FileField( + upload_to="books/%Y/%m/%d/", + validators=[FileExtensionValidator(allowed_extensions=["epub", "pdf"])], + ) + cover_image = models.ImageField(upload_to="covers/%Y/%m/%d/", blank=True, null=True) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + class Meta: + ordering = ["-created_at"] + indexes = [ + models.Index(fields=["user", "-created_at"]), + ] + + def __str__(self) -> str: + return self.title + + def filename(self) -> str: + return Path(self.file.name).name + + +@receiver(post_delete, sender=Book) +def _auto_delete_file_on_delete(sender: type[Book], instance: Book, **kwargs: object) -> None: + """Delete the uploaded file when the Book record is deleted.""" + if instance.file: + instance.file.delete(save=False) + if instance.cover_image: + instance.cover_image.delete(save=False) + + +class ReadingProgress(models.Model): + user = models.ForeignKey( + settings.AUTH_USER_MODEL, + on_delete=models.CASCADE, + related_name="reading_progress", + ) + book = models.OneToOneField( + Book, + on_delete=models.CASCADE, + related_name="reading_progress", + ) + current_position = models.FloatField(default=0.0) + """Position in the book as a percentage (0.0 to 100.0)""" + last_page = models.IntegerField(default=0) + """Last page/paragraph index for granular tracking""" + updated_at = models.DateTimeField(auto_now=True) + + class Meta: + verbose_name_plural = "reading progress" + unique_together = [("user", "book")] + + def __str__(self) -> str: + return f"{self.book.title} — {self.current_position:.1f}%" + + +class ReadingSettings(models.Model): + user = models.OneToOneField( + settings.AUTH_USER_MODEL, + on_delete=models.CASCADE, + related_name="reading_settings", + ) + font_size = models.IntegerField(default=18) + """Font size in pixels (min 12, max 36)""" + font_style = models.CharField( + max_length=20, + choices=[(s.value, s.name.replace("_", " ").title()) for s in FontStyle], + default=FontStyle.SANS_SERIF.value, + ) + background_color = models.CharField( + max_length=7, + choices=[(c.value, c.name.title()) for c in BackgroundColor], + default=BackgroundColor.WHITE.value, + ) + updated_at = models.DateTimeField(auto_now=True) + + class Meta: + verbose_name_plural = "reading settings" + + def __str__(self) -> str: + return f"Settings for {self.user}" \ No newline at end of file diff --git a/api/books/serializers.py b/api/books/serializers.py new file mode 100644 index 0000000..9e9417a --- /dev/null +++ b/api/books/serializers.py @@ -0,0 +1,136 @@ +from rest_framework import serializers + +from books.models import Book, FontStyle, BackgroundColor, ReadingProgress, ReadingSettings + + +class BookListSerializer(serializers.ModelSerializer): + """Lightweight serializer for the library listing — no file or progress data.""" + + filename = serializers.CharField(read_only=True) + progress = serializers.SerializerMethodField() + + class Meta: + model = Book + fields = [ + "id", + "title", + "author", + "filename", + "cover_image", + "created_at", + "progress", + ] + + def get_progress(self, obj: Book) -> float | None: + try: + return obj.reading_progress.current_position + except ReadingProgress.DoesNotExist: + return None + + +class BookDetailSerializer(serializers.ModelSerializer): + """Full serializer for the reader view — includes file URL and progress.""" + + filename = serializers.CharField(read_only=True) + file_url = serializers.SerializerMethodField() + progress = serializers.SerializerMethodField() + + class Meta: + model = Book + fields = [ + "id", + "title", + "author", + "filename", + "file_url", + "cover_image", + "created_at", + "updated_at", + "progress", + ] + + def get_file_url(self, obj: Book) -> str: + request = self.context.get("request") + if request and obj.file: + return request.build_absolute_uri(obj.file.url) + return "" + + def get_progress(self, obj: Book) -> dict | None: + try: + rp = obj.reading_progress + return { + "current_position": rp.current_position, + "last_page": rp.last_page, + } + except ReadingProgress.DoesNotExist: + return None + + +class BookUploadSerializer(serializers.ModelSerializer): + """Serializer for uploading a new book.""" + + class Meta: + model = Book + fields = ["title", "author", "file", "cover_image"] + extra_kwargs = { + "title": {"required": True}, + "file": {"required": True}, + } + + def validate_file(self, value: object) -> object: + import os + if isinstance(value, type(None)): + return value + ext = os.path.splitext(str(getattr(value, 'name', '')))[1].lower() + if ext not in (".epub", ".pdf"): + raise serializers.ValidationError( + "Only EPUB and PDF files are supported." + ) + return value + + def create(self, validated_data: dict) -> Book: + validated_data["user"] = self.context["request"].user + return super().create(validated_data) + + +class ReadingProgressSerializer(serializers.ModelSerializer): + class Meta: + model = ReadingProgress + fields = ["current_position", "last_page"] + extra_kwargs = { + "current_position": {"required": True, "min_value": 0.0, "max_value": 100.0}, + } + + def validate_current_position(self, value: float) -> float: + if value < 0.0 or value > 100.0: + raise serializers.ValidationError( + "Position must be between 0.0 and 100.0." + ) + return value + + +class ReadingSettingsSerializer(serializers.ModelSerializer): + class Meta: + model = ReadingSettings + fields = ["font_size", "font_style", "background_color"] + + def validate_font_size(self, value: int) -> int: + if value < 12 or value > 36: + raise serializers.ValidationError("Font size must be between 12 and 36.") + return value + + def validate_font_style(self, value: str) -> str: + valid = [s.value for s in FontStyle] + if value not in valid: + raise serializers.ValidationError( + f"Font style must be one of: {', '.join(valid)}" + ) + return value + + def validate_background_color(self, value: str) -> str: + valid = [c.value for c in BackgroundColor] + if value not in valid: + raise serializers.ValidationError( + f"Background color must be one of: {', '.join(valid)}" + ) + return value \ No newline at end of file diff --git a/api/books/urls.py b/api/books/urls.py new file mode 100644 index 0000000..cc780a0 --- /dev/null +++ b/api/books/urls.py @@ -0,0 +1,15 @@ +from django.urls import include, path +from rest_framework.routers import DefaultRouter + +from books.views import BookViewSet, ReadingSettingsViewSet + +router = DefaultRouter() +router.register(r"books", BookViewSet, basename="book") + +urlpatterns = [ + path("", include(router.urls)), + path("settings/", ReadingSettingsViewSet.as_view({ + "get": "list", + "patch": "partial_update", + }), name="reading-settings"), +] \ No newline at end of file diff --git a/api/books/views.py b/api/books/views.py new file mode 100644 index 0000000..5565c8f --- /dev/null +++ b/api/books/views.py @@ -0,0 +1,88 @@ +from django.shortcuts import get_object_or_404 +from rest_framework import parsers, permissions, status, viewsets +from rest_framework.decorators import action +from rest_framework.request import Request +from rest_framework.response import Response + +from books.models import Book, ReadingProgress, ReadingSettings +from books.serializers import ( + BookDetailSerializer, + BookListSerializer, + BookUploadSerializer, + ReadingProgressSerializer, + ReadingSettingsSerializer, +) + + +class IsBookOwner(permissions.BasePermission): + """Only the owner of a book can access it.""" + + def has_object_permission( + self, request: Request, view: object, obj: Book + ) -> bool: + return obj.user == request.user + + +class BookViewSet(viewsets.ModelViewSet): + """API endpoint for managing user books.""" + + parser_classes = [parsers.MultiPartParser, parsers.FormParser, parsers.JSONParser] + permission_classes = [permissions.IsAuthenticated, IsBookOwner] + + def get_serializer_class(self) -> type: + if self.action == "create": + return BookUploadSerializer + if self.action == "list": + return BookListSerializer + return BookDetailSerializer + + def get_queryset(self): + return ( + Book.objects.filter(user=self.request.user) + .select_related("reading_progress", "user") + .prefetch_related() + ) + + @action(detail=True, methods=["get", "patch"]) + def progress(self, request: Request, pk: int | None = None) -> Response: + """Get or update reading progress for a specific book.""" + book = self.get_object() + progress, _created = ReadingProgress.objects.get_or_create( + user=request.user, + book=book, + ) + + if request.method == "GET": + serializer = ReadingProgressSerializer(progress) + return Response(serializer.data) + + serializer = ReadingProgressSerializer(progress, data=request.data, partial=True) + serializer.is_valid(raise_exception=True) + serializer.save() + return Response(serializer.data) + + +class ReadingSettingsViewSet(viewsets.GenericViewSet): + """API endpoint for user reading settings.""" + + permission_classes = [permissions.IsAuthenticated] + serializer_class = ReadingSettingsSerializer + + def get_queryset(self): + return ReadingSettings.objects.filter(user=self.request.user) + + def list(self, request: Request) -> Response: + settings, _created = ReadingSettings.objects.get_or_create( + user=request.user, + ) + serializer = self.get_serializer(settings) + return Response(serializer.data) + + def partial_update(self, request: Request) -> Response: + settings, _created = ReadingSettings.objects.get_or_create( + user=request.user, + ) + serializer = self.get_serializer(settings, data=request.data, partial=True) + serializer.is_valid(raise_exception=True) + serializer.save() + return Response(serializer.data) \ No newline at end of file diff --git a/api/manage.py b/api/manage.py new file mode 100644 index 0000000..0d704eb --- /dev/null +++ b/api/manage.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main() -> None: + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.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() \ No newline at end of file diff --git a/api/project/__init__.py b/api/project/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/api/project/settings.py b/api/project/settings.py new file mode 100644 index 0000000..4ade860 --- /dev/null +++ b/api/project/settings.py @@ -0,0 +1,109 @@ +import os +from pathlib import Path + +BASE_DIR = Path(__file__).resolve().parent.parent + +SECRET_KEY = os.environ.get("DJANGO_SECRET_KEY", "django-insecure-dev-change-me") +DEBUG = os.environ.get("DJANGO_DEBUG", "True").lower() in ("true", "1", "yes") +ALLOWED_HOSTS: list[str] = ["*"] + +INSTALLED_APPS = [ + "django.contrib.admin", + "django.contrib.auth", + "django.contrib.contenttypes", + "django.contrib.sessions", + "django.contrib.messages", + "django.contrib.staticfiles", + # Third-party + "rest_framework", + "rest_framework.authtoken", + "corsheaders", + # Local + "books", +] + +MIDDLEWARE = [ + "corsheaders.middleware.CorsMiddleware", + "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 = "project.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 = "project.wsgi.application" + +# ── Database ────────────────────────────────────────────── +_database_url = os.environ.get( + "DATABASE_URL", + "postgres://cloudreader:cloudreader@localhost:5432/cloudreader", +) +_db_parts = _database_url.replace("postgres://", "").split("@") +_credentials, _host_db = _db_parts[0], _db_parts[1] +_db_user, _db_pass = _credentials.split(":") +_host_port, _db_name = _host_db.split("/") +_db_host = _host_port.split(":")[0] +_db_port = _host_port.split(":")[1] if ":" in _host_port else "5432" + +DATABASES = { + "default": { + "ENGINE": "django.db.backends.postgresql", + "NAME": _db_name, + "USER": _db_user, + "PASSWORD": _db_pass, + "HOST": _db_host, + "PORT": _db_port, + } +} + +DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" + +# ── Auth / Password Validation ──────────────────────────── +AUTH_PASSWORD_VALIDATORS = [ + {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"}, +] + +# ── DRF ─────────────────────────────────────────────────── +REST_FRAMEWORK = { + "DEFAULT_AUTHENTICATION_CLASSES": [ + "rest_framework.authentication.TokenAuthentication", + "rest_framework.authentication.SessionAuthentication", + ], + "DEFAULT_PERMISSION_CLASSES": [ + "rest_framework.permissions.IsAuthenticated", + ], +} + +# ── CORS ────────────────────────────────────────────────── +CORS_ALLOW_ALL_ORIGINS = True # dev only + +# ── Media / Uploads ─────────────────────────────────────── +MEDIA_URL = "/media/" +MEDIA_ROOT = BASE_DIR / "media" + +# ── i18n / Static ───────────────────────────────────────── +LANGUAGE_CODE = "en-us" +TIME_ZONE = "UTC" +USE_I18N = True +USE_TZ = True +STATIC_URL = "static/" \ No newline at end of file diff --git a/api/project/urls.py b/api/project/urls.py new file mode 100644 index 0000000..e1d8e9b --- /dev/null +++ b/api/project/urls.py @@ -0,0 +1,7 @@ +from django.contrib import admin +from django.urls import include, path + +urlpatterns = [ + path("admin/", admin.site.urls), + path("api/", include("books.urls")), +] \ No newline at end of file diff --git a/api/project/wsgi.py b/api/project/wsgi.py new file mode 100644 index 0000000..e4f8bc8 --- /dev/null +++ b/api/project/wsgi.py @@ -0,0 +1,6 @@ +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "project.settings") +application = get_wsgi_application() \ No newline at end of file diff --git a/api/pyproject.toml b/api/pyproject.toml new file mode 100644 index 0000000..733d710 --- /dev/null +++ b/api/pyproject.toml @@ -0,0 +1,21 @@ +[project] +name = "api" +version = "1.0.0" +description = "Cloud Reader API — Book Search and Discovery" +requires-python = ">=3.12" +dependencies = [ + "django>=5.1,<6.0", + "djangorestframework>=3.15,<4.0", + "django-cors-headers>=4.4,<5.0", + "django-filter>=24.3,<25.0", + "psycopg2-binary>=2.9,<3.0", + "pydantic>=2.0,<3.0", + "pydantic-settings>=2.0,<3.0", +] + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[tool.setuptools.packages.find] +include = ["books*", "project*"] \ No newline at end of file diff --git a/api/uv.lock b/api/uv.lock new file mode 100644 index 0000000..565a955 --- /dev/null +++ b/api/uv.lock @@ -0,0 +1,290 @@ +version = 1 +revision = 3 +requires-python = ">=3.12" + +[[package]] +name = "annotated-types" +version = "0.7.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ee/67/531ea369ba64dcff5ec9c3402f9f51bf748cec26dde048a2f973a4eea7f5/annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89", size = 16081, upload-time = "2024-05-20T21:33:25.928Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/78/b6/6307fbef88d9b5ee7421e68d78a9f162e0da4900bc5f5793f6d3d0e34fb8/annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53", size = 13643, upload-time = "2024-05-20T21:33:24.1Z" }, +] + +[[package]] +name = "api" +version = "1.0.0" +source = { editable = "." } +dependencies = [ + { name = "django" }, + { name = "django-cors-headers" }, + { name = "django-filter" }, + { name = "djangorestframework" }, + { name = "psycopg2-binary" }, + { name = "pydantic" }, + { name = "pydantic-settings" }, +] + +[package.metadata] +requires-dist = [ + { name = "django", specifier = ">=5.1,<6.0" }, + { name = "django-cors-headers", specifier = ">=4.4,<5.0" }, + { name = "django-filter", specifier = ">=24.3,<25.0" }, + { name = "djangorestframework", specifier = ">=3.15,<4.0" }, + { name = "psycopg2-binary", specifier = ">=2.9,<3.0" }, + { name = "pydantic", specifier = ">=2.0,<3.0" }, + { name = "pydantic-settings", specifier = ">=2.0,<3.0" }, +] + +[[package]] +name = "asgiref" +version = "3.11.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/63/40/f03da1264ae8f7cfdbf9146542e5e7e8100a4c66ab48e791df9a03d3f6c0/asgiref-3.11.1.tar.gz", hash = "sha256:5f184dc43b7e763efe848065441eac62229c9f7b0475f41f80e207a114eda4ce", size = 38550, upload-time = "2026-02-03T13:30:14.33Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5c/0a/a72d10ed65068e115044937873362e6e32fab1b7dce0046aeb224682c989/asgiref-3.11.1-py3-none-any.whl", hash = "sha256:e8667a091e69529631969fd45dc268fa79b99c92c5fcdda727757e52146ec133", size = 24345, upload-time = "2026-02-03T13:30:13.039Z" }, +] + +[[package]] +name = "django" +version = "5.2.14" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "asgiref" }, + { name = "sqlparse" }, + { name = "tzdata", marker = "sys_platform == 'win32'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/65/95/95f7faa0950867afaa0bef2460c6263afd6a2c78cc9434046ed28160b015/django-5.2.14.tar.gz", hash = "sha256:58a63ba841662e5c686b57ba1fec52ddd68c0b93bd96ac3029d55728f00bf8a2", size = 10895118, upload-time = "2026-05-05T13:57:31.104Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/14/44/f172870cf87aa25afef48fb72adba89ee8b77fcab6f3b23d240b923f1528/django-5.2.14-py3-none-any.whl", hash = "sha256:6f712143bd3064310d1f50fac859c3e9a274bdcfc9595339853be7779297fc76", size = 8311320, upload-time = "2026-05-05T13:57:25.795Z" }, +] + +[[package]] +name = "django-cors-headers" +version = "4.9.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "asgiref" }, + { name = "django" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/21/39/55822b15b7ec87410f34cd16ce04065ff390e50f9e29f31d6d116fc80456/django_cors_headers-4.9.0.tar.gz", hash = "sha256:fe5d7cb59fdc2c8c646ce84b727ac2bca8912a247e6e68e1fb507372178e59e8", size = 21458, upload-time = "2025-09-18T10:40:52.326Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/30/d8/19ed1e47badf477d17fb177c1c19b5a21da0fd2d9f093f23be3fb86c5fab/django_cors_headers-4.9.0-py3-none-any.whl", hash = "sha256:15c7f20727f90044dcee2216a9fd7303741a864865f0c3657e28b7056f61b449", size = 12809, upload-time = "2025-09-18T10:40:50.843Z" }, +] + +[[package]] +name = "django-filter" +version = "24.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "django" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/50/bc/dc19ae39c235332926dd0efe0951f663fa1a9fc6be8430737ff7fd566b20/django_filter-24.3.tar.gz", hash = "sha256:d8ccaf6732afd21ca0542f6733b11591030fa98669f8d15599b358e24a2cd9c3", size = 144444, upload-time = "2024-08-02T13:27:58.132Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/09/b1/92f1c30b47c1ebf510c35a2ccad9448f73437e5891bbd2b4febe357cc3de/django_filter-24.3-py3-none-any.whl", hash = "sha256:c4852822928ce17fb699bcfccd644b3574f1a2d80aeb2b4ff4f16b02dd49dc64", size = 95011, upload-time = "2024-08-02T13:27:55.616Z" }, +] + +[[package]] +name = "djangorestframework" +version = "3.17.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "django" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ca/d7/c016e69fac19ff8afdc89db9d31d9ae43ae031e4d1993b20aca179b8301a/djangorestframework-3.17.1.tar.gz", hash = "sha256:a6def5f447fe78ff853bff1d47a3c59bf38f5434b031780b351b0c73a62db1a5", size = 905742, upload-time = "2026-03-24T16:58:33.705Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5a/e1/2c516bdc83652b1a60c6119366ac2c0607b479ed05cd6093f916ca8928f8/djangorestframework-3.17.1-py3-none-any.whl", hash = "sha256:c3c74dd3e83a5a3efc37b3c18d92bd6f86a6791c7b7d4dff62bb068500e76457", size = 898844, upload-time = "2026-03-24T16:58:31.845Z" }, +] + +[[package]] +name = "psycopg2-binary" +version = "2.9.12" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/2a/60/a3624f79acea344c16fbef3a94d28b89a8042ddfb8f3e4ca83f538671409/psycopg2_binary-2.9.12.tar.gz", hash = "sha256:5ac9444edc768c02a6b6a591f070b8aae28ff3a99be57560ac996001580f294c", size = 379686, upload-time = "2026-04-21T09:40:34.304Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e2/9f/ef4ef3c8e15083df90ca35265cfd1a081a2f0cc07bb229c6314c6af817f4/psycopg2_binary-2.9.12-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:5cdc05117180c5fa9c40eea8ea559ce64d73824c39d928b7da9fb5f6a9392433", size = 3712459, upload-time = "2026-04-20T23:34:30.549Z" }, + { url = "https://files.pythonhosted.org/packages/b5/01/3dd14e46ba48c1e1a6ec58ee599fa1b5efa00c246d5046cd903d0eeb1af1/psycopg2_binary-2.9.12-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d3227a3bc228c10d21011a99245edca923e4e8bf461857e869a507d9a41fe9f6", size = 3822936, upload-time = "2026-04-20T23:34:32.77Z" }, + { url = "https://files.pythonhosted.org/packages/a6/f7/0640e4901119d8a9f7a1784b927f494e2198e213ceb593753d1f2c8b1b30/psycopg2_binary-2.9.12-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:995ce929eede89db6254b50827e2b7fd61e50d11f0b116b29fffe4a2e53c4580", size = 4578676, upload-time = "2026-04-20T23:34:35.18Z" }, + { url = "https://files.pythonhosted.org/packages/b0/55/44df3965b5f297c50cc0b1b594a31c67d6127a9d133045b8a66611b14dfb/psycopg2_binary-2.9.12-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:9fe06d93e72f1c048e731a2e3e7854a5bfaa58fc736068df90b352cefe66f03f", size = 4274917, upload-time = "2026-04-20T23:34:37.982Z" }, + { url = "https://files.pythonhosted.org/packages/b0/4b/74535248b1eac0c9336862e8617c765ac94dac76f9e25d7c4a79588c8907/psycopg2_binary-2.9.12-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:40e7b28b63aaf737cb3a1edc3a9bbc9a9f4ad3dcb7152e8c1130e4050eddcb7d", size = 5894843, upload-time = "2026-04-20T23:34:40.856Z" }, + { url = "https://files.pythonhosted.org/packages/f2/ba/f1bf8d2ae71868ad800b661099086ee52bc0f8d9f05be1acd8ebb06757cc/psycopg2_binary-2.9.12-cp312-cp312-manylinux_2_38_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:89d19a9f7899e8eb0656a2b3a08e0da04c720a06db6e0033eab5928aabe60fa9", size = 4110556, upload-time = "2026-04-20T23:34:44.016Z" }, + { url = "https://files.pythonhosted.org/packages/45/46/c15706c338403b7c420bcc0c2905aad116cc064545686d8bf85f1999ea00/psycopg2_binary-2.9.12-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:612b965daee295ae2da8f8218ce1d274645dc76ef3f1abf6a0a94fd57eff876d", size = 3655714, upload-time = "2026-04-20T23:34:46.233Z" }, + { url = "https://files.pythonhosted.org/packages/b3/7c/a2d5dc09b64a4564db242a0fe418fde7d33f6f8259dd2c5b9d7def00fb5a/psycopg2_binary-2.9.12-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:b9a339b79d37c1b45f3235265f07cdeb0cb5ad7acd2ac7720a5920989c17c24e", size = 3301154, upload-time = "2026-04-20T23:34:49.528Z" }, + { url = "https://files.pythonhosted.org/packages/c0/e8/cc8c9a4ce71461f9ec548d38cadc41dc184b34c73e6455450775a9334ccd/psycopg2_binary-2.9.12-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:3471336e1acfd9c7fe507b8bad5af9317b6a89294f9eb37bd9a030bb7bebcdc6", size = 3048882, upload-time = "2026-04-20T23:34:51.86Z" }, + { url = "https://files.pythonhosted.org/packages/19/6a/31e2296bc0787c5ab75d3d118e40b239db8151b5192b90b77c72bc9256e9/psycopg2_binary-2.9.12-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7af18183109e23502c8b2ae7f6926c0882766f35b5175a4cd737ad825e4d7a1b", size = 3351298, upload-time = "2026-04-20T23:34:54.124Z" }, + { url = "https://files.pythonhosted.org/packages/5f/a8/75f4e3e11203b590150abed2cf7794b9c9c9f7eceddae955191138b44dde/psycopg2_binary-2.9.12-cp312-cp312-win_amd64.whl", hash = "sha256:398fcd4db988c7d7d3713e2b8e18939776fd3fb447052daae4f24fa39daede4c", size = 2757230, upload-time = "2026-04-20T23:34:56.242Z" }, + { url = "https://files.pythonhosted.org/packages/91/bb/4608c96f970f6e0c56572e87027ef4404f709382a3503e9934526d7ba051/psycopg2_binary-2.9.12-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:7c729a73c7b1b84de3582f73cdd27d905121dc2c531f3d9a3c32a3011033b965", size = 3712419, upload-time = "2026-04-20T23:34:58.754Z" }, + { url = "https://files.pythonhosted.org/packages/5e/af/48f76af9d50d61cf390f8cd657b503168b089e2e9298e48465d029fcc713/psycopg2_binary-2.9.12-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:4413d0caef93c5cf50b96863df4c2efe8c269bf2267df353225595e7e15e8df7", size = 3822990, upload-time = "2026-04-20T23:35:00.821Z" }, + { url = "https://files.pythonhosted.org/packages/7a/df/aba0f99397cd811d32e06fc0cc781f1f3ce98bc0e729cb423925085d781a/psycopg2_binary-2.9.12-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:4dfcf8e45ebb0c663be34a3442f65e17311f3367089cd4e5e3a3e8e62c978777", size = 4578696, upload-time = "2026-04-20T23:35:03.409Z" }, + { url = "https://files.pythonhosted.org/packages/95/9c/eaa74021ac4e4d5c2f83d82fc6615a63f4fe6c94dc4e94c3990427053f67/psycopg2_binary-2.9.12-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:c41321a14dd74aceb6a9a643b9253a334521babfa763fa873e33d89cfa122fb5", size = 4274982, upload-time = "2026-04-20T23:35:05.583Z" }, + { url = "https://files.pythonhosted.org/packages/35/ed/c25deff98bd26187ba48b3b250a3ffc3037c46c5b89362534a15d200e0db/psycopg2_binary-2.9.12-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:83946ba43979ebfdc99a3cd0ee775c89f221df026984ba19d46133d8d75d3cd9", size = 5894867, upload-time = "2026-04-20T23:35:07.902Z" }, + { url = "https://files.pythonhosted.org/packages/9a/81/8d0e21ca77373c6c9589e5c4528f6e8f0c08c62cafc76fb0bddb7a2cee22/psycopg2_binary-2.9.12-cp313-cp313-manylinux_2_38_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:411e85815652d13560fbe731878daa5d92378c4995a22302071890ec3397d019", size = 4110578, upload-time = "2026-04-20T23:35:10.149Z" }, + { url = "https://files.pythonhosted.org/packages/00/fc/f481e2435bd8f742d0123309174aae4165160ad3ef17c1b99c3622c241d2/psycopg2_binary-2.9.12-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:1c8ad4c08e00f7679559eaed7aff1edfffc60c086b976f93972f686384a95e2c", size = 3655816, upload-time = "2026-04-20T23:35:12.56Z" }, + { url = "https://files.pythonhosted.org/packages/53/79/b9f46466bdbe9f239c96cde8be33c1aace4842f06013b47b730dc9759187/psycopg2_binary-2.9.12-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:00814e40fa23c2b37ef0a1e3c749d89982c73a9cb5046137f0752a22d432e82f", size = 3301307, upload-time = "2026-04-20T23:35:15.029Z" }, + { url = "https://files.pythonhosted.org/packages/3f/19/7dc003b32fe35024df89b658104f7c8538a8b2dcbde7a4e746ce929742e7/psycopg2_binary-2.9.12-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:98062447aebc20ed20add1f547a364fd0ef8933640d5372ff1873f8deb9b61be", size = 3048968, upload-time = "2026-04-20T23:35:16.757Z" }, + { url = "https://files.pythonhosted.org/packages/91/58/2dbd7db5c604d45f4950d988506aae672a14126ec22998ced5021cbb76bb/psycopg2_binary-2.9.12-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:66a7685d7e548f10fb4ce32fb01a7b7f4aa702134de92a292c7bd9e0d3dbd290", size = 3351369, upload-time = "2026-04-20T23:35:18.933Z" }, + { url = "https://files.pythonhosted.org/packages/42/ee/dee8dcaad07f735824de3d6563bc67119fa6c28257b17977a8d624f02fab/psycopg2_binary-2.9.12-cp313-cp313-win_amd64.whl", hash = "sha256:b6937f5fe4e180aeee87de907a2fa982ded6f7f15d7218f78a083e4e1d68f2a0", size = 2757347, upload-time = "2026-04-20T23:35:21.283Z" }, + { url = "https://files.pythonhosted.org/packages/13/1b/708c0dca874acfad6d65314271859899a79007686f3a1f74e82a2ed4b645/psycopg2_binary-2.9.12-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:6f3b3de8a74ef8db215f22edffb19e32dc6fa41340456de7ec99efdc8a7b3ec2", size = 3712428, upload-time = "2026-04-20T23:35:23.453Z" }, + { url = "https://files.pythonhosted.org/packages/d6/39/ddbea9d4b4de6aca9431b6ed253f530f8a02d3b8f9bcfd0dbfe2b3de6fe4/psycopg2_binary-2.9.12-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:1006fb62f0f0bc5ce256a832356c6262e91be43f5e4eb15b5eaf38079464caf2", size = 3823184, upload-time = "2026-04-20T23:35:25.92Z" }, + { url = "https://files.pythonhosted.org/packages/bf/a0/bc2fef74b106fa345567122a0659e6d94512ed7dc0131ec44c9e5aba3725/psycopg2_binary-2.9.12-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.whl", hash = "sha256:840066105706cd2eb29b9a1c2329620056582a4bf3e8169dec5c447042d0869f", size = 4579157, upload-time = "2026-04-20T23:35:28.542Z" }, + { url = "https://files.pythonhosted.org/packages/57/d7/d4e3b2005d3de607ca4fbb0e8742e248056e52184a6b94ebda3c1c2c329b/psycopg2_binary-2.9.12-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl", hash = "sha256:863f5d12241ebe1c76a72a04c2113b6dc905f90b9cef0e9be0efd994affd9354", size = 4274970, upload-time = "2026-04-20T23:35:30.418Z" }, + { url = "https://files.pythonhosted.org/packages/2e/42/c9853f8db3967fe08bcde11f53d53b85d351750cae726ce001cb68afa9c1/psycopg2_binary-2.9.12-cp314-cp314-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a99eaab34a9010f1a086b126de467466620a750634d114d20455f3a824aae033", size = 5895175, upload-time = "2026-04-20T23:35:33.584Z" }, + { url = "https://files.pythonhosted.org/packages/eb/fd/b82b5601a97630308bef079f545ffec481bbbc795c2ba5ec416a01d03f60/psycopg2_binary-2.9.12-cp314-cp314-manylinux_2_38_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:ffdd7dc5463ccd61845ac37b7012d0f35a1548df9febe14f8dd549be4a0bc81e", size = 4110658, upload-time = "2026-04-20T23:35:35.638Z" }, + { url = "https://files.pythonhosted.org/packages/62/8c/32ca69b0389ef25dd22937bf9e8fbe2ce27aea20b05ded48c4ce4cb42475/psycopg2_binary-2.9.12-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:54a0dfecab1b48731f934e06139dfe11e24219fb6d0ceb32177cf0375f14c7b5", size = 3656251, upload-time = "2026-04-20T23:35:37.854Z" }, + { url = "https://files.pythonhosted.org/packages/c4/29/96992a2b59e3b9d730fcf9612d0a387305025dc867a9fc490a9e496e074e/psycopg2_binary-2.9.12-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:96937c9c5d891f772430f418a7a8b4691a90c3e6b93cf72b5bd7cad8cbca32a5", size = 3301810, upload-time = "2026-04-20T23:35:39.927Z" }, + { url = "https://files.pythonhosted.org/packages/56/ad/44b06659949b243ae10112cd3b20a197f9bf3e81d5651379b9eb889bfaad/psycopg2_binary-2.9.12-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:77b348775efd4cdab410ec6609d81ccecd1139c90265fa583a7255c8064bc03d", size = 3048977, upload-time = "2026-04-20T23:35:41.806Z" }, + { url = "https://files.pythonhosted.org/packages/1d/f2/10a1bcebadb6aa55e280e1f58975c36a7b560ea525184c7aa4064c466633/psycopg2_binary-2.9.12-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:527e6342b3e44c2f0544f6b8e927d60de7f163f5723b8f1dfa7d2a84298738cd", size = 3351466, upload-time = "2026-04-20T23:35:43.993Z" }, + { url = "https://files.pythonhosted.org/packages/20/be/b732c8418ffa5bcfda002890f5dc4c869fc17db66ff11f53b17cfe44afc0/psycopg2_binary-2.9.12-cp314-cp314-win_amd64.whl", hash = "sha256:f12ae41fcafadb39b2785e64a40f9db05d6de2ac114077457e0e7c597f3af980", size = 2848762, upload-time = "2026-04-20T23:35:46.421Z" }, +] + +[[package]] +name = "pydantic" +version = "2.13.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "annotated-types" }, + { name = "pydantic-core" }, + { name = "typing-extensions" }, + { name = "typing-inspection" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/18/a5/b60d21ac674192f8ab0ba4e9fd860690f9b4a6e51ca5df118733b487d8d6/pydantic-2.13.4.tar.gz", hash = "sha256:c40756b57adaa8b1efeeced5c196f3f3b7c435f90e84ea7f443901bec8099ef6", size = 844775, upload-time = "2026-05-06T13:43:05.343Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/fd/7b/122376b1fd3c62c1ed9dc80c931ace4844b3c55407b6fb2d199377c9736f/pydantic-2.13.4-py3-none-any.whl", hash = "sha256:45a282cde31d808236fd7ea9d919b128653c8b38b393d1c4ab335c62924d9aba", size = 472262, upload-time = "2026-05-06T13:43:02.641Z" }, +] + +[[package]] +name = "pydantic-core" +version = "2.46.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/9d/56/921726b776ace8d8f5db44c4ef961006580d91dc52b803c489fafd1aa249/pydantic_core-2.46.4.tar.gz", hash = "sha256:62f875393d7f270851f20523dd2e29f082bcc82292d66db2b64ea71f64b6e1c1", size = 471464, upload-time = "2026-05-06T13:37:06.98Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ce/8c/af022f0af448d7747c5154288d46b5f2bc5f17366eaa0e23e9aa04d59f3b/pydantic_core-2.46.4-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:3245406455a5d98187ec35530fd772b1d799b26667980872c8d4614991e2c4a2", size = 2106158, upload-time = "2026-05-06T13:38:57.215Z" }, + { url = "https://files.pythonhosted.org/packages/19/95/6195171e385007300f0f5574592e467c568becce2d937a0b6804f218bc49/pydantic_core-2.46.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:962ccbab7b642487b1d8b7df90ef677e03134cf1fd8880bf698649b22a69371f", size = 1951724, upload-time = "2026-05-06T13:37:02.697Z" }, + { url = "https://files.pythonhosted.org/packages/8e/bc/f47d1ff9cbb1620e1b5b697eef06010035735f07820180e74178226b27b3/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8233f2947cf85404441fd7e0085f53b10c93e0ee78611099b5c7237e36aacbf7", size = 1975742, upload-time = "2026-05-06T13:37:09.448Z" }, + { url = "https://files.pythonhosted.org/packages/5b/11/9b9a5b0306345664a2da6410877af6e8082481b5884b3ddd78d47c6013ce/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:3a233125ac121aa3ffba9a2b59edfc4a985a76092dc8279586ab4b71390875e7", size = 2052418, upload-time = "2026-05-06T13:37:38.234Z" }, + { url = "https://files.pythonhosted.org/packages/f1/b7/a65fec226f5d78fc39f4a13c4cc0c768c22b113438f60c14adc9d2865038/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5b712b53160b79a5850310b912a5ef8e57e56947c8ad690c227f5c9d7e561712", size = 2232274, upload-time = "2026-05-06T13:38:27.753Z" }, + { url = "https://files.pythonhosted.org/packages/68/f0/92039db98b907ef49269a8271f67db9cb78ae2fc68062ef7e4e77adb5f61/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9401557acd873c3a7f3eb9383edef8ac4968f9510e340f4808d427e75667e7b4", size = 2309940, upload-time = "2026-05-06T13:38:05.353Z" }, + { url = "https://files.pythonhosted.org/packages/5f/97/2aab507d3d00ca626e8e57c1eac6a79e4e5fbcc63eb99733ff55d1717f65/pydantic_core-2.46.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:926c9541b14b12b1681dca8a0b75feb510b06c6341b70a8e500c2fdcff837cce", size = 2094516, upload-time = "2026-05-06T13:39:10.577Z" }, + { url = "https://files.pythonhosted.org/packages/22/37/a8aca44d40d737dde2bc05b3c6c07dff0de07ce6f82e9f3167aeaf4d5dea/pydantic_core-2.46.4-cp312-cp312-manylinux_2_31_riscv64.whl", hash = "sha256:56cb4851bcaf3d117eddcef4fe66afd750a50274b0da8e22be256d10e5611987", size = 2136854, upload-time = "2026-05-06T13:40:22.59Z" }, + { url = "https://files.pythonhosted.org/packages/24/99/fcef1b79238c06a8cbec70819ac722ba76e02bc8ada9b0fd66eba40da01b/pydantic_core-2.46.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:c68fcd102d71ea85c5b2dfac3f4f8476eff42a9e078fd5faefff6d145063536b", size = 2180306, upload-time = "2026-05-06T13:40:10.666Z" }, + { url = "https://files.pythonhosted.org/packages/ae/6c/fc44000918855b42779d007ae63b0532794739027b2f417321cddbc44f6a/pydantic_core-2.46.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:b2f69dec1725e79a012d920df1707de5caf7ed5e08f3be4435e25803efc47458", size = 2190044, upload-time = "2026-05-06T13:40:43.231Z" }, + { url = "https://files.pythonhosted.org/packages/6b/65/d9cadc9f1920d7a127ad2edba16c1db7916e59719285cd6c94600b0080ba/pydantic_core-2.46.4-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:8d0820e8192167f80d88d64038e609c31452eeca865b4e1d9950a27a4609b00b", size = 2329133, upload-time = "2026-05-06T13:39:57.365Z" }, + { url = "https://files.pythonhosted.org/packages/d0/cf/c873d91679f3a30bcf5e7ac280ce5573483e72295307685120d0d5ad3416/pydantic_core-2.46.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:fbdb89b3e1c94a30cc5edfce477c6e6a5dc4d8f84665b455c27582f211a1c72c", size = 2374464, upload-time = "2026-05-06T13:38:06.976Z" }, + { url = "https://files.pythonhosted.org/packages/47/bd/6f2fc8188f31bf10590f1e98e7b306336161fac930a8c514cd7bd828c7dc/pydantic_core-2.46.4-cp312-cp312-win32.whl", hash = "sha256:9aa768456404a8bf48a4406685ac2bec8e72b62c69313734fa3b73cf33b3a894", size = 1974823, upload-time = "2026-05-06T13:40:47.985Z" }, + { url = "https://files.pythonhosted.org/packages/40/8c/985c1d41ea1107c2534abd9870e4ed5c8e7669b5c308297835c001e7a1c4/pydantic_core-2.46.4-cp312-cp312-win_amd64.whl", hash = "sha256:e9c26f834c65f5752f3f06cb08cb86a913ceb7274d0db6e267808a708b46bc89", size = 2072919, upload-time = "2026-05-06T13:39:21.153Z" }, + { url = "https://files.pythonhosted.org/packages/c4/ba/f463d006e0c47373ca7ec5e1a261c59dc01ef4d62b2657af925fb0deee3a/pydantic_core-2.46.4-cp312-cp312-win_arm64.whl", hash = "sha256:4fc73cb559bdb54b1134a706a2802a4cddd27a0633f5abb7e53056268751ac6a", size = 2027604, upload-time = "2026-05-06T13:39:03.753Z" }, + { url = "https://files.pythonhosted.org/packages/51/a2/5d30b469c5267a17b39dec53208222f76a8d351dfac4af661888c5aee77d/pydantic_core-2.46.4-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:5d5902252db0d3cedf8d4a1bc68f70eeb430f7e4c7104c8c476753519b423008", size = 2106306, upload-time = "2026-05-06T13:37:48.029Z" }, + { url = "https://files.pythonhosted.org/packages/c1/81/4fa520eaffa8bd7d1525e644cd6d39e7d60b1592bc5b516693c7340b50f1/pydantic_core-2.46.4-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:c94f0688e7b8d0a67abf40e57a7eaaecd17cc9586706a31b76c031f63df052b4", size = 1951906, upload-time = "2026-05-06T13:37:17.012Z" }, + { url = "https://files.pythonhosted.org/packages/03/d5/fd02da45b659668b05923b17ba3a0100a0a3d5541e3bd8fcc4ecb711309e/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f027324c56cd5406ca49c124b0db10e56c69064fec039acc571c29020cc87c76", size = 1976802, upload-time = "2026-05-06T13:37:35.113Z" }, + { url = "https://files.pythonhosted.org/packages/21/f2/95727e1368be3d3ed485eaab7adbd7dda408f33f7a36e8b48e0144002b91/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e739fee756ba1010f8bcccb534252e85a35fe45ae92c295a06059ce58b74ccd3", size = 2052446, upload-time = "2026-05-06T13:37:12.313Z" }, + { url = "https://files.pythonhosted.org/packages/9c/86/5d99feea3f77c7234b8718075b23db11532773c1a0dbd9b9490215dc2eeb/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9d56801be94b86a9da183e5f3766e6310752b99ff647e38b09a9500d88e46e76", size = 2232757, upload-time = "2026-05-06T13:39:01.149Z" }, + { url = "https://files.pythonhosted.org/packages/d2/3a/508ac615935ef7588cf6d9e9b91309fdc2da751af865e02a9098de88258c/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2412e734dcb48da14d4e4006b82b46b74f2518b8a26ee7e58c6844a6cd6d03c4", size = 2309275, upload-time = "2026-05-06T13:37:41.406Z" }, + { url = "https://files.pythonhosted.org/packages/07/f8/41db9de19d7987d6b04715a02b3b40aea467000275d9d758ffaa31af7d50/pydantic_core-2.46.4-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9551187363ffc0de2a00b2e47c25aeaeb1020b69b668762966df15fc5659dd5a", size = 2094467, upload-time = "2026-05-06T13:39:18.847Z" }, + { url = "https://files.pythonhosted.org/packages/2c/e2/f35033184cb11d0052daf4416e8e10a502ea2ac006fc4f459aee872727d1/pydantic_core-2.46.4-cp313-cp313-manylinux_2_31_riscv64.whl", hash = "sha256:0186750b482eefa11d7f435892b09c5c606193ef3375bcf94aa00ae6bfb66262", size = 2134417, upload-time = "2026-05-06T13:40:17.944Z" }, + { url = "https://files.pythonhosted.org/packages/7e/7b/6ceeb1cc90e193862f444ebe373d8fdf613f0a82572dde03fb10734c6c71/pydantic_core-2.46.4-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:5855698a4856556d86e8e6cd8434bc3ac0314ee8e12089ae0e143f64c6256e4e", size = 2179782, upload-time = "2026-05-06T13:40:32.618Z" }, + { url = "https://files.pythonhosted.org/packages/5a/f2/c8d7773ede6af08036423a00ae0ceffce266c3c52a096c435d68c896083f/pydantic_core-2.46.4-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:cbaf13819775b7f769bf4a1f066cb6df7a28d4480081a589828ef190226881cd", size = 2188782, upload-time = "2026-05-06T13:36:51.018Z" }, + { url = "https://files.pythonhosted.org/packages/59/31/0c864784e31f09f05cdd87606f08923b9c9e7f6e51dd27f20f62f975ce9f/pydantic_core-2.46.4-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:633147d34cf4550417f12e2b1a0383973bdf5cdfde212cb09e9a581cf10820be", size = 2328334, upload-time = "2026-05-06T13:40:37.764Z" }, + { url = "https://files.pythonhosted.org/packages/c2/eb/4f6c8a41efa30baa755590f4141abf3a8c370fab610915733e74134a7270/pydantic_core-2.46.4-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:82cf5301172168103724d49a1444d3378cb20cdee30b116a1bd6031236298a5d", size = 2372986, upload-time = "2026-05-06T13:39:34.152Z" }, + { url = "https://files.pythonhosted.org/packages/5b/24/b375a480d53113860c299764bfe9f349a3dc9108b3adc0d7f0d786492ebf/pydantic_core-2.46.4-cp313-cp313-win32.whl", hash = "sha256:9fa8ae11da9e2b3126c6426f147e0fba88d96d65921799bb30c6abd1cb2c97fb", size = 1973693, upload-time = "2026-05-06T13:37:55.072Z" }, + { url = "https://files.pythonhosted.org/packages/7e/e8/cff247591966f2d22ec8c003cd7587e27b7ba7b81ab2fb888e3ab75dc285/pydantic_core-2.46.4-cp313-cp313-win_amd64.whl", hash = "sha256:6b3ace8194b0e5204818c92802dcdca7fc6d88aabbb799d7c795540d9cd6d292", size = 2071819, upload-time = "2026-05-06T13:38:49.139Z" }, + { url = "https://files.pythonhosted.org/packages/c6/1a/f4aee670d5670e9e148e0c82c7db98d780be566c6e6a97ee8035528ca0b3/pydantic_core-2.46.4-cp313-cp313-win_arm64.whl", hash = "sha256:184c081504d17f1c1066e430e117142b2c77d9448a97f7b65c6ac9fd9aee238d", size = 2027411, upload-time = "2026-05-06T13:40:45.796Z" }, + { url = "https://files.pythonhosted.org/packages/8d/74/228a26ddad29c6672b805d9fd78e8d251cd04004fa7eed0e622096cd0250/pydantic_core-2.46.4-cp314-cp314-macosx_10_12_x86_64.whl", hash = "sha256:428e04521a40150c85216fc8b85e8d39fece235a9cf5e383761238c7fa9b96fb", size = 2102079, upload-time = "2026-05-06T13:38:41.019Z" }, + { url = "https://files.pythonhosted.org/packages/ad/1f/8970b150a4b4365623ae00fc88603491f763c627311ae8031e3111356d6e/pydantic_core-2.46.4-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:23ace664830ee0bfe014a0c7bc248b1f7f25ed7ad103852c317624a1083af462", size = 1952179, upload-time = "2026-05-06T13:36:59.812Z" }, + { url = "https://files.pythonhosted.org/packages/95/30/5211a831ae054928054b2f79731661087a2bc5c01e825c672b3a4a8f1b3e/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ce5c1d2a8b27468f433ca974829c44060b8097eedc39933e3c206a90ee49c4a9", size = 1978926, upload-time = "2026-05-06T13:37:39.933Z" }, + { url = "https://files.pythonhosted.org/packages/57/e9/689668733b1eb67adeef047db3c2e8788fcf65a7fd9c9e2b46b7744fe245/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7283d57845ecf5a163403eb0702dfc220cc4fbdd18919cb5ccea4f95ee1cdab4", size = 2046785, upload-time = "2026-05-06T13:38:01.995Z" }, + { url = "https://files.pythonhosted.org/packages/60/d9/6715260422ff50a2109878fd24d948a6c3446bb2664f34ee78cd972b3acd/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8daafc69c93ee8a0204506a3b6b30f586ef54028f52aeeeb5c4cfc5184fd5914", size = 2228733, upload-time = "2026-05-06T13:40:50.371Z" }, + { url = "https://files.pythonhosted.org/packages/18/ae/fdb2f64316afca925640f8e70bb1a564b0ec2721c1389e25b8eb4bf9a299/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd2213145bcc2ba85884d0ac63d222fece9209678f77b9b4d76f054c561adb28", size = 2307534, upload-time = "2026-05-06T13:37:21.531Z" }, + { url = "https://files.pythonhosted.org/packages/89/1d/8eff589b45bb8190a9d12c49cfad0f176a5cbd1534908a6b5125e2886239/pydantic_core-2.46.4-cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7a5f930472650a82629163023e630d160863fce524c616f4e5186e5de9d9a49b", size = 2099732, upload-time = "2026-05-06T13:39:31.942Z" }, + { url = "https://files.pythonhosted.org/packages/06/d5/ee5a3366637fee41dee51a1fc91562dcf12ddbc68fda34e6b253da2324bb/pydantic_core-2.46.4-cp314-cp314-manylinux_2_31_riscv64.whl", hash = "sha256:c1b3f518abeca3aa13c712fd202306e145abf59a18b094a6bafb2d2bbf59192c", size = 2129627, upload-time = "2026-05-06T13:37:25.033Z" }, + { url = "https://files.pythonhosted.org/packages/94/33/2414be571d2c6a6c4d08be21f9292b6d3fdb08949a97b6dfe985017821db/pydantic_core-2.46.4-cp314-cp314-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:1a7dd0b3ee80d90150e3495a3a13ac34dbcbfd4f012996a6a1d8900e91b5c0fb", size = 2179141, upload-time = "2026-05-06T13:37:14.046Z" }, + { url = "https://files.pythonhosted.org/packages/7b/79/7daa95be995be0eecc4cf75064cb33f9bbbfe3fe0158caf2f0d4a996a5c7/pydantic_core-2.46.4-cp314-cp314-musllinux_1_1_aarch64.whl", hash = "sha256:3fb702cd90b0446a3a1c5e470bfa0dd23c0233b676a9099ddcc964fa6ca13898", size = 2184325, upload-time = "2026-05-06T13:36:53.615Z" }, + { url = "https://files.pythonhosted.org/packages/9f/cb/d0a382f5c0de8a222dc61c65348e0ce831b1f68e0a018450d31c2cace3a5/pydantic_core-2.46.4-cp314-cp314-musllinux_1_1_armv7l.whl", hash = "sha256:b8458003118a712e66286df6a707db01c52c0f52f7db8e4a38f0da1d3b94fc4e", size = 2323990, upload-time = "2026-05-06T13:40:29.971Z" }, + { url = "https://files.pythonhosted.org/packages/05/db/d9ba624cc4a5aced1598e88c04fdbd8310c8a69b9d38b9a3d39ce3a61ed7/pydantic_core-2.46.4-cp314-cp314-musllinux_1_1_x86_64.whl", hash = "sha256:372429a130e469c9cd698925ce5fc50940b7a1336b0d82038e63d5bbc4edc519", size = 2369978, upload-time = "2026-05-06T13:37:23.027Z" }, + { url = "https://files.pythonhosted.org/packages/f2/20/d15df15ba918c423461905802bfd2981c3af0bfa0e40d05e13edbfa48bc3/pydantic_core-2.46.4-cp314-cp314-win32.whl", hash = "sha256:85bb3611ff1802f3ee7fdd7dbff26b56f343fb432d57a4728fdd49b6ef35e2f4", size = 1966354, upload-time = "2026-05-06T13:38:03.499Z" }, + { url = "https://files.pythonhosted.org/packages/fc/b6/6b8de4c0a7d7ab3004c439c80c5c1e0a3e8d78bbae19379b01960383d9e5/pydantic_core-2.46.4-cp314-cp314-win_amd64.whl", hash = "sha256:811ff8e9c313ab425368bcbb36e5c4ebd7108c2bbf4e4089cfbb0b01eff63fac", size = 2072238, upload-time = "2026-05-06T13:39:40.807Z" }, + { url = "https://files.pythonhosted.org/packages/32/36/51eb763beec1f4cf59b1db243a7dcc39cbb41230f050a09b9d69faaf0a48/pydantic_core-2.46.4-cp314-cp314-win_arm64.whl", hash = "sha256:bfec22eab3c8cc2ceec0248aec886624116dc079afa027ecc8ad4a7e62010f8a", size = 2018251, upload-time = "2026-05-06T13:37:26.72Z" }, + { url = "https://files.pythonhosted.org/packages/e8/91/855af51d625b23aa987116a19e231d2aaef9c4a415273ddc189b79a45fee/pydantic_core-2.46.4-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:af8244b2bef6aaad6d92cda81372de7f8c8d36c9f0c3ea36e827c60e7d9467a0", size = 2099593, upload-time = "2026-05-06T13:39:47.682Z" }, + { url = "https://files.pythonhosted.org/packages/fb/1b/8784a54c65edb5f49f0a14d6977cf1b209bba85a4c77445b255c2de58ab3/pydantic_core-2.46.4-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:5a4330cdbc57162e4b3aa303f588ba752257694c9c9be3e7ebb11b4aca659b5d", size = 1935226, upload-time = "2026-05-06T13:40:40.428Z" }, + { url = "https://files.pythonhosted.org/packages/e8/e7/1955d28d1afc56dd4b3ad7cc0cf39df1b9852964cf16e5d13912756d6d6b/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:29c61fc04a3d840155ff08e475a04809278972fe6aef51e2720554e96367e34b", size = 1974605, upload-time = "2026-05-06T13:37:32.029Z" }, + { url = "https://files.pythonhosted.org/packages/93/e2/3fedbf0ba7a22850e6e9fd78117f1c0f10f950182344d8a6c535d468fdd8/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c50f2528cf200c5eed56faf3f4e22fcd5f38c157a8b78576e6ba3168ec35f000", size = 2030777, upload-time = "2026-05-06T13:38:55.239Z" }, + { url = "https://files.pythonhosted.org/packages/f8/61/46be275fcaaba0b4f5b9669dd852267ce1ff616592dccf7a7845588df091/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0cbe8b01f948de4286c74cdd6c667aceb38f5c1e26f0693b3983d9d74887c65e", size = 2236641, upload-time = "2026-05-06T13:37:08.096Z" }, + { url = "https://files.pythonhosted.org/packages/60/db/12e93e46a8bac9988be3c016860f83293daea8c716c029c9ace279036f2f/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:617d7e2ca7dcb8c5cf6bcb8c59b8832c94b36196bbf1cbd1bfb56ed341905edd", size = 2286404, upload-time = "2026-05-06T13:40:20.221Z" }, + { url = "https://files.pythonhosted.org/packages/e2/4a/4d8b19008f38d31c53b8219cfedc2e3d5de5fe99d90076b7e767de29274f/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7027560ee92211647d0d34e3f7cd6f50da56399d26a9c8ad0da286d3869a53f3", size = 2109219, upload-time = "2026-05-06T13:38:12.153Z" }, + { url = "https://files.pythonhosted.org/packages/88/70/3cbc40978fefb7bb09c6708d40d4ad1a5d70fd7213c3d17f971de868ec1f/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_31_riscv64.whl", hash = "sha256:f99626688942fb746e545232e7726926f3be91b5975f8b55327665fafda991c7", size = 2110594, upload-time = "2026-05-06T13:40:02.971Z" }, + { url = "https://files.pythonhosted.org/packages/9d/20/b8d36736216e29491125531685b2f9e61aa5b4b2599893f8268551da3338/pydantic_core-2.46.4-cp314-cp314t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:fc3e9034a63de20e15e8ade85358bc6efc614008cab72898b4b4952bea0509ff", size = 2159542, upload-time = "2026-05-06T13:39:27.506Z" }, + { url = "https://files.pythonhosted.org/packages/1d/a2/367df868eb584dacf6bf82a389272406d7178e301c4ac82545ab98bc2dd9/pydantic_core-2.46.4-cp314-cp314t-musllinux_1_1_aarch64.whl", hash = "sha256:97e7cf2be5c77b7d1a9713a05605d49460d02c6078d38d8bef3cbe323c548424", size = 2168146, upload-time = "2026-05-06T13:38:31.93Z" }, + { url = "https://files.pythonhosted.org/packages/c1/b8/4460f77f7e201893f649a29ab355dddd3beee8a97bcb1a320db414f9a06e/pydantic_core-2.46.4-cp314-cp314t-musllinux_1_1_armv7l.whl", hash = "sha256:3bf92c5d0e00fefaab325a4d27828fe6b6e2a21848686b5b60d2d9eeb09d76c6", size = 2306309, upload-time = "2026-05-06T13:37:44.717Z" }, + { url = "https://files.pythonhosted.org/packages/64/c4/be2639293acd87dc8ddbcec41a73cee9b2ebf996fe6d892a1a74e88ad3f7/pydantic_core-2.46.4-cp314-cp314t-musllinux_1_1_x86_64.whl", hash = "sha256:3ecbc122d18468d06ca279dc26a8c2e2d5acb10943bb35e36ae92096dc3b5565", size = 2369736, upload-time = "2026-05-06T13:37:05.645Z" }, + { url = "https://files.pythonhosted.org/packages/30/a6/9f9f380dbb301f67023bf8f707aaa75daadf84f7152d95c410fd7e81d994/pydantic_core-2.46.4-cp314-cp314t-win32.whl", hash = "sha256:e846ae7835bf0703ae43f534ab79a867146dadd59dc9ca5c8b53d5c8f7c9ef02", size = 1955575, upload-time = "2026-05-06T13:38:51.116Z" }, + { url = "https://files.pythonhosted.org/packages/40/1f/f1eb9eb350e795d1af8586289746f5c5677d16043040d63710e22abc43c9/pydantic_core-2.46.4-cp314-cp314t-win_amd64.whl", hash = "sha256:2108ba5c1c1eca18030634489dc544844144ee36357f2f9f780b93e7ddbb44b5", size = 2051624, upload-time = "2026-05-06T13:38:21.672Z" }, + { url = "https://files.pythonhosted.org/packages/f6/d2/42dd53d0a85c27606f316d3aa5d2869c4e8470a5ed6dec30e4a1abe19192/pydantic_core-2.46.4-cp314-cp314t-win_arm64.whl", hash = "sha256:4fcbe087dbc2068af7eda3aa87634eba216dbda64d1ae73c8684b621d33f6596", size = 2017325, upload-time = "2026-05-06T13:40:52.723Z" }, + { url = "https://files.pythonhosted.org/packages/9d/1d/8987ad40f65ae1432753072f214fb5c74fe47ffbd0698bb9cbbb585664f8/pydantic_core-2.46.4-graalpy312-graalpy250_312_native-macosx_10_12_x86_64.whl", hash = "sha256:1d8ba486450b14f3b1d63bc521d410ec7565e52f887b9fb671791886436a42f7", size = 2095527, upload-time = "2026-05-06T13:39:52.283Z" }, + { url = "https://files.pythonhosted.org/packages/64/d3/84c282a7eee1d3ac4c0377546ef5a1ea436ce26840d9ac3b7ed54a377507/pydantic_core-2.46.4-graalpy312-graalpy250_312_native-macosx_11_0_arm64.whl", hash = "sha256:3009f12e4e90b7f88b4f9adb1b0c4a3d58fe7820f3238c190047209d148026df", size = 1936024, upload-time = "2026-05-06T13:40:15.671Z" }, + { url = "https://files.pythonhosted.org/packages/d7/ca/eac61596cdeb4d7e174d3dc0bd8a6238f14f75f97a24e7b7db4c7e7340a0/pydantic_core-2.46.4-graalpy312-graalpy250_312_native-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ad785e92e6dc634c21555edc8bd6b64957ab844541bcb96a1366c202951ae526", size = 1990696, upload-time = "2026-05-06T13:38:34.717Z" }, + { url = "https://files.pythonhosted.org/packages/fa/c3/7c8b240552251faf6b3a957db200fcfbbcec36763c050428b601e0c9b83b/pydantic_core-2.46.4-graalpy312-graalpy250_312_native-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:00c603d540afdd6b80eb39f078f33ebd46211f02f33e34a32d9f053bba711de0", size = 2147590, upload-time = "2026-05-06T13:39:29.883Z" }, +] + +[[package]] +name = "pydantic-settings" +version = "2.14.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pydantic" }, + { name = "python-dotenv" }, + { name = "typing-inspection" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/07/60/1d1e59c9c90d54591469ada7d268251f71c24bdb765f1a8a832cee8c6653/pydantic_settings-2.14.1.tar.gz", hash = "sha256:e874d3bec7e787b0c9958277956ed9b4dd5de6a80e162188fdaff7c5e26fd5fa", size = 235551, upload-time = "2026-05-08T13:40:06.542Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ae/8d/f1af3832f5e6eb13ba94ee809e72b8ecb5eef226d27ee0bef7d963d943c7/pydantic_settings-2.14.1-py3-none-any.whl", hash = "sha256:6e3c7edfd8277687cdc598f56e5cff0e9bfff0910a3749deaa8d4401c3a2b9de", size = 60964, upload-time = "2026-05-08T13:40:04.958Z" }, +] + +[[package]] +name = "python-dotenv" +version = "1.2.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/82/ed/0301aeeac3e5353ef3d94b6ec08bbcabd04a72018415dcb29e588514bba8/python_dotenv-1.2.2.tar.gz", hash = "sha256:2c371a91fbd7ba082c2c1dc1f8bf89ca22564a087c2c287cd9b662adde799cf3", size = 50135, upload-time = "2026-03-01T16:00:26.196Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/0b/d7/1959b9648791274998a9c3526f6d0ec8fd2233e4d4acce81bbae76b44b2a/python_dotenv-1.2.2-py3-none-any.whl", hash = "sha256:1d8214789a24de455a8b8bd8ae6fe3c6b69a5e3d64aa8a8e5d68e694bbcb285a", size = 22101, upload-time = "2026-03-01T16:00:25.09Z" }, +] + +[[package]] +name = "sqlparse" +version = "0.5.5" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/90/76/437d71068094df0726366574cf3432a4ed754217b436eb7429415cf2d480/sqlparse-0.5.5.tar.gz", hash = "sha256:e20d4a9b0b8585fdf63b10d30066c7c94c5d7a7ec47c889a2d83a3caa93ff28e", size = 120815, upload-time = "2025-12-19T07:17:45.073Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/49/4b/359f28a903c13438ef59ebeee215fb25da53066db67b305c125f1c6d2a25/sqlparse-0.5.5-py3-none-any.whl", hash = "sha256:12a08b3bf3eec877c519589833aed092e2444e68240a3577e8e26148acc7b1ba", size = 46138, upload-time = "2025-12-19T07:17:46.573Z" }, +] + +[[package]] +name = "typing-extensions" +version = "4.15.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/72/94/1a15dd82efb362ac84269196e94cf00f187f7ed21c242792a923cdb1c61f/typing_extensions-4.15.0.tar.gz", hash = "sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466", size = 109391, upload-time = "2025-08-25T13:49:26.313Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/18/67/36e9267722cc04a6b9f15c7f3441c2363321a3ea07da7ae0c0707beb2a9c/typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548", size = 44614, upload-time = "2025-08-25T13:49:24.86Z" }, +] + +[[package]] +name = "typing-inspection" +version = "0.4.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/55/e3/70399cb7dd41c10ac53367ae42139cf4b1ca5f36bb3dc6c9d33acdb43655/typing_inspection-0.4.2.tar.gz", hash = "sha256:ba561c48a67c5958007083d386c3295464928b01faa735ab8547c5692e87f464", size = 75949, upload-time = "2025-10-01T02:14:41.687Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/dc/9b/47798a6c91d8bdb567fe2698fe81e0c6b7cb7ef4d13da4114b41d239f65d/typing_inspection-0.4.2-py3-none-any.whl", hash = "sha256:4ed1cacbdc298c220f1bd249ed5287caa16f34d44ef4e9c3d0cbad5b521545e7", size = 14611, upload-time = "2025-10-01T02:14:40.154Z" }, +] + +[[package]] +name = "tzdata" +version = "2026.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ba/19/1b9b0e29f30c6d35cb345486df41110984ea67ae69dddbc0e8a100999493/tzdata-2026.2.tar.gz", hash = "sha256:9173fde7d80d9018e02a662e168e5a2d04f87c41ea174b139fbef642eda62d10", size = 198254, upload-time = "2026-04-24T15:22:08.651Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ce/e4/dccd7f47c4b64213ac01ef921a1337ee6e30e8c6466046018326977efd95/tzdata-2026.2-py2.py3-none-any.whl", hash = "sha256:bbe9af844f658da81a5f95019480da3a89415801f6cc966806612cc7169bffe7", size = 349321, upload-time = "2026-04-24T15:22:05.876Z" }, +] diff --git a/backend/.env.example b/backend/.env.example new file mode 100644 index 0000000..2e7190f --- /dev/null +++ b/backend/.env.example @@ -0,0 +1,8 @@ +# Backend environment (example – never commit real secrets) +DJANGO_SECRET_KEY=django-insecure-change-me-in-production +DJANGO_DEBUG=True +DB_NAME=cloud_reader +DB_USER=postgres +DB_PASSWORD=postgres +DB_HOST=localhost +DB_PORT=5432 \ No newline at end of file diff --git a/backend/apps/__init__.py b/backend/apps/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/backend/apps/annotations/__init__.py b/backend/apps/annotations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/backend/apps/annotations/admin.py b/backend/apps/annotations/admin.py new file mode 100644 index 0000000..6b5dac9 --- /dev/null +++ b/backend/apps/annotations/admin.py @@ -0,0 +1,19 @@ +from django.contrib import admin + +from apps.annotations.models import Bookmark, Note + + +@admin.register(Bookmark) +class BookmarkAdmin(admin.ModelAdmin): + list_display = ("user", "book", "page", "created_at") + list_select_related = ("user", "book") + search_fields = ("user__email", "book__title", "location_text") + list_filter = ("created_at",) + + +@admin.register(Note) +class NoteAdmin(admin.ModelAdmin): + list_display = ("user", "book", "page", "created_at", "updated_at") + list_select_related = ("user", "book") + search_fields = ("user__email", "book__title", "content", "location_text") + list_filter = ("created_at",) \ No newline at end of file diff --git a/backend/apps/annotations/apps.py b/backend/apps/annotations/apps.py new file mode 100644 index 0000000..3ebc727 --- /dev/null +++ b/backend/apps/annotations/apps.py @@ -0,0 +1,7 @@ +from django.apps import AppConfig + + +class AnnotationsConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.annotations" + label = "annotations" \ No newline at end of file diff --git a/backend/apps/annotations/models.py b/backend/apps/annotations/models.py new file mode 100644 index 0000000..fff70d1 --- /dev/null +++ b/backend/apps/annotations/models.py @@ -0,0 +1,84 @@ +import uuid + +from django.conf import settings +from django.db import models + + +class Bookmark(models.Model): + """A saved location in a book that the user can return to.""" + + id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False) + user = models.ForeignKey( + settings.AUTH_USER_MODEL, + on_delete=models.CASCADE, + related_name="bookmarks", + db_index=True, + ) + book = models.ForeignKey( + "books.Book", + on_delete=models.CASCADE, + related_name="bookmarks", + db_index=True, + ) + page = models.PositiveIntegerField() + location_text = models.TextField( + blank=True, + default="", + help_text="The selected passage text at this location", + ) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + class Meta: + db_table = "annotations_bookmark" + verbose_name = "Bookmark" + verbose_name_plural = "Bookmarks" + ordering = ["-created_at"] + constraints = [ + models.UniqueConstraint( + fields=["user", "book", "page"], + name="uq_bookmark_user_book_page", + ) + ] + + def __str__(self) -> str: + return f"{self.user} @ {self.book} p.{self.page}" + + +class Note(models.Model): + """A user-written note attached to a specific location in a book.""" + + id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False) + user = models.ForeignKey( + settings.AUTH_USER_MODEL, + on_delete=models.CASCADE, + related_name="notes", + db_index=True, + ) + book = models.ForeignKey( + "books.Book", + on_delete=models.CASCADE, + related_name="notes", + db_index=True, + ) + page = models.PositiveIntegerField() + location_text = models.TextField( + blank=True, + default="", + help_text="The selected passage text this note refers to", + ) + content = models.TextField( + help_text="The note body content" + ) + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + class Meta: + db_table = "annotations_note" + verbose_name = "Note" + verbose_name_plural = "Notes" + ordering = ["-created_at"] + + def __str__(self) -> str: + preview = self.content[:50] + return f"{self.user} @ {self.book} p.{self.page}: {preview}" \ No newline at end of file diff --git a/backend/apps/annotations/permissions.py b/backend/apps/annotations/permissions.py new file mode 100644 index 0000000..c4b156e --- /dev/null +++ b/backend/apps/annotations/permissions.py @@ -0,0 +1,8 @@ +from rest_framework import permissions + + +class IsOwner(permissions.BasePermission): + """Grant access only if the requesting user owns the object.""" + + def has_object_permission(self, request, view, obj) -> bool: + return obj.user == request.user \ No newline at end of file diff --git a/backend/apps/annotations/serializers.py b/backend/apps/annotations/serializers.py new file mode 100644 index 0000000..6b3981b --- /dev/null +++ b/backend/apps/annotations/serializers.py @@ -0,0 +1,108 @@ +from rest_framework import serializers + +from apps.annotations.models import Bookmark, Note + + +class BookmarkSerializer(serializers.ModelSerializer): + """Serialize Bookmark data with full details.""" + + book_title = serializers.CharField(source="book.title", read_only=True) + + class Meta: + model = Bookmark + fields = [ + "id", + "book", + "book_title", + "page", + "location_text", + "created_at", + "updated_at", + ] + read_only_fields = ["id", "created_at", "updated_at", "book_title"] + + def validate_page(self, value: int) -> int: + if value < 1: + raise serializers.ValidationError("Page must be a positive integer.") + return value + + +class BookmarkCreateSerializer(serializers.ModelSerializer): + """Serializer used for creating bookmarks. Sets user from request context.""" + + class Meta: + model = Bookmark + fields = ["book", "page", "location_text"] + + def validate_page(self, value: int) -> int: + if value < 1: + raise serializers.ValidationError("Page must be a positive integer.") + return value + + def validate(self, attrs): + user = self.context["request"].user + if Bookmark.objects.filter( + user=user, book=attrs["book"], page=attrs["page"] + ).exists(): + raise serializers.ValidationError( + {"page": "A bookmark already exists at this page for this book."} + ) + return attrs + + def create(self, validated_data): + validated_data["user"] = self.context["request"].user + return super().create(validated_data) + + +class NoteSerializer(serializers.ModelSerializer): + """Serialize Note data with full details.""" + + book_title = serializers.CharField(source="book.title", read_only=True) + + class Meta: + model = Note + fields = [ + "id", + "book", + "book_title", + "page", + "location_text", + "content", + "created_at", + "updated_at", + ] + read_only_fields = ["id", "created_at", "updated_at", "book_title"] + + def validate_page(self, value: int) -> int: + if value < 1: + raise serializers.ValidationError("Page must be a positive integer.") + return value + + def validate_content(self, value: str) -> str: + stripped = value.strip() + if not stripped: + raise serializers.ValidationError("Note content cannot be empty.") + return stripped + + +class NoteCreateSerializer(serializers.ModelSerializer): + """Serializer used for creating notes. Sets user from request context.""" + + class Meta: + model = Note + fields = ["book", "page", "location_text", "content"] + + def validate_page(self, value: int) -> int: + if value < 1: + raise serializers.ValidationError("Page must be a positive integer.") + return value + + def validate_content(self, value: str) -> str: + stripped = value.strip() + if not stripped: + raise serializers.ValidationError("Note content cannot be empty.") + return stripped + + def create(self, validated_data): + validated_data["user"] = self.context["request"].user + return super().create(validated_data) \ No newline at end of file diff --git a/backend/apps/annotations/tests.py b/backend/apps/annotations/tests.py new file mode 100644 index 0000000..86ef6ba --- /dev/null +++ b/backend/apps/annotations/tests.py @@ -0,0 +1,331 @@ +"""Tests for the annotations app – Bookmarks & Notes API.""" + +import pytest +from django.urls import reverse +from rest_framework import status +from rest_framework.test import APIClient + +from apps.annotations.models import Bookmark, Note +from apps.books.models import Book +from apps.users.models import User + + +# --------------------------------------------------------------------------- +# Fixtures +# --------------------------------------------------------------------------- + +@pytest.fixture +def api_client() -> APIClient: + return APIClient() + + +@pytest.fixture +def user() -> User: + return User.objects.create_user( + username="testuser", + email="test@example.com", + password="testpass123", + ) + + +@pytest.fixture +def other_user() -> User: + return User.objects.create_user( + username="other", + email="other@example.com", + password="testpass123", + ) + + +@pytest.fixture +def auth_client(api_client: APIClient, user: User) -> APIClient: + api_client.force_authenticate(user=user) + return api_client + + +@pytest.fixture +def book() -> Book: + return Book.objects.create( + title="Test Book", + author="Test Author", + total_pages=300, + ) + + +@pytest.fixture +def bookmark(auth_client, user: User, book: Book) -> Bookmark: + return Bookmark.objects.create( + user=user, + book=book, + page=42, + location_text="important passage", + ) + + +@pytest.fixture +def note(auth_client, user: User, book: Book) -> Note: + return Note.objects.create( + user=user, + book=book, + page=15, + location_text="highlighted section", + content="This is my note about this section.", + ) + + +# --------------------------------------------------------------------------- +# Bookmark tests +# --------------------------------------------------------------------------- + +class TestBookmarkList: + url = reverse("bookmark-list") + + def test_unauthenticated_user_cannot_list(self, api_client: APIClient): + response = api_client.get(self.url) + assert response.status_code == status.HTTP_401_UNAUTHORIZED + + def test_list_returns_user_bookmarks_only( + self, auth_client: APIClient, user: User, other_user: User, book: Book + ): + Bookmark.objects.create(user=user, book=book, page=1) + Bookmark.objects.create(user=other_user, book=book, page=2) + + response = auth_client.get(self.url) + assert response.status_code == status.HTTP_200_OK + results = response.data["results"] + assert len(results) == 1 + assert results[0]["page"] == 1 + + def test_list_returns_empty_when_no_bookmarks( + self, auth_client: APIClient + ): + response = auth_client.get(self.url) + assert response.status_code == status.HTTP_200_OK + assert response.data["count"] == 0 + + def test_list_orders_by_newest_first( + self, auth_client: APIClient, user: User, book: Book + ): + b1 = Bookmark.objects.create(user=user, book=book, page=1) + b2 = Bookmark.objects.create(user=user, book=book, page=2) + response = auth_client.get(self.url) + results = response.data["results"] + assert results[0]["page"] == 2 + assert results[1]["page"] == 1 + + def test_list_includes_book_title( + self, auth_client: APIClient, bookmark: Bookmark + ): + response = auth_client.get(self.url) + assert response.status_code == status.HTTP_200_OK + assert response.data["results"][0]["book_title"] == "Test Book" + + +class TestBookmarkCreate: + url = reverse("bookmark-list") + + def test_create_bookmark(self, auth_client: APIClient, book: Book): + data = {"book": str(book.id), "page": 10, "location_text": "key insight"} + response = auth_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_201_CREATED + assert response.data["page"] == 10 + + def test_create_bookmark_without_location_text( + self, auth_client: APIClient, book: Book + ): + data = {"book": str(book.id), "page": 5} + response = auth_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_201_CREATED + assert response.data["page"] == 5 + + def test_duplicate_bookmark_page_is_rejected( + self, auth_client: APIClient, bookmark: Bookmark + ): + data = {"book": str(bookmark.book.id), "page": bookmark.page} + response = auth_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_400_BAD_REQUEST + + def test_unauthenticated_user_cannot_create( + self, api_client: APIClient, book: Book + ): + data = {"book": str(book.id), "page": 10} + response = api_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_401_UNAUTHORIZED + + def test_invalid_page_rejected( + self, auth_client: APIClient, book: Book + ): + data = {"book": str(book.id), "page": 0} + response = auth_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_400_BAD_REQUEST + + +class TestBookmarkDetail: + def test_get_bookmark( + self, auth_client: APIClient, bookmark: Bookmark + ): + url = reverse("bookmark-detail", args=[str(bookmark.id)]) + response = auth_client.get(url) + assert response.status_code == status.HTTP_200_OK + assert response.data["page"] == bookmark.page + + def test_cannot_access_other_users_bookmark( + self, api_client: APIClient, other_user: User, bookmark: Bookmark + ): + api_client.force_authenticate(user=other_user) + url = reverse("bookmark-detail", args=[str(bookmark.id)]) + response = api_client.get(url) + assert response.status_code == status.HTTP_404_NOT_FOUND + + +class TestBookmarkDelete: + def test_delete_bookmark( + self, auth_client: APIClient, bookmark: Bookmark + ): + url = reverse("bookmark-detail", args=[str(bookmark.id)]) + response = auth_client.delete(url) + assert response.status_code == status.HTTP_204_NO_CONTENT + assert Bookmark.objects.count() == 0 + + def test_cannot_delete_other_users_bookmark( + self, api_client: APIClient, other_user: User, bookmark: Bookmark + ): + api_client.force_authenticate(user=other_user) + url = reverse("bookmark-detail", args=[str(bookmark.id)]) + response = api_client.delete(url) + assert response.status_code == status.HTTP_404_NOT_FOUND + + +class TestBookmarkFilterByBook: + def test_filter_by_book( + self, auth_client: APIClient, user: User, book: Book + ): + other_book = Book.objects.create(title="Other", author="Other") + Bookmark.objects.create(user=user, book=book, page=1) + Bookmark.objects.create(user=user, book=other_book, page=2) + + url = reverse("bookmark-list") + response = auth_client.get(url, {"book": str(book.id)}) + assert response.status_code == status.HTTP_200_OK + assert response.data["count"] == 1 + assert response.data["results"][0]["page"] == 1 + + +# --------------------------------------------------------------------------- +# Note tests +# --------------------------------------------------------------------------- + +class TestNoteList: + url = reverse("note-list") + + def test_unauthenticated_user_cannot_list(self, api_client: APIClient): + response = api_client.get(self.url) + assert response.status_code == status.HTTP_401_UNAUTHORIZED + + def test_list_returns_user_notes_only( + self, auth_client: APIClient, user: User, other_user: User, book: Book + ): + Note.objects.create(user=user, book=book, page=1, content="My note") + Note.objects.create(user=other_user, book=book, page=2, content="Other's note") + + response = auth_client.get(self.url) + assert response.status_code == status.HTTP_200_OK + results = response.data["results"] + assert len(results) == 1 + assert results[0]["content"] == "My note" + + def test_list_includes_book_title( + self, auth_client: APIClient, note: Note + ): + response = auth_client.get(self.url) + assert response.status_code == status.HTTP_200_OK + assert response.data["results"][0]["book_title"] == "Test Book" + + +class TestNoteCreate: + url = reverse("note-list") + + def test_create_note(self, auth_client: APIClient, book: Book): + data = { + "book": str(book.id), + "page": 20, + "location_text": "interesting part", + "content": "This is a thoughtful note.", + } + response = auth_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_201_CREATED + assert response.data["content"] == "This is a thoughtful note." + + def test_create_note_without_location_text( + self, auth_client: APIClient, book: Book + ): + data = {"book": str(book.id), "page": 20, "content": "A note."} + response = auth_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_201_CREATED + + def test_empty_content_rejected( + self, auth_client: APIClient, book: Book + ): + data = {"book": str(book.id), "page": 20, "content": " "} + response = auth_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_400_BAD_REQUEST + + def test_unauthenticated_user_cannot_create( + self, api_client: APIClient, book: Book + ): + data = {"book": str(book.id), "page": 20, "content": "Note"} + response = api_client.post(self.url, data, format="json") + assert response.status_code == status.HTTP_401_UNAUTHORIZED + + +class TestNoteUpdate: + def test_update_note_content( + self, auth_client: APIClient, note: Note + ): + url = reverse("note-detail", args=[str(note.id)]) + data = {"content": "Updated note content."} + response = auth_client.patch(url, data, format="json") + assert response.status_code == status.HTTP_200_OK + assert response.data["content"] == "Updated note content." + + def test_cannot_update_other_users_note( + self, api_client: APIClient, other_user: User, note: Note + ): + api_client.force_authenticate(user=other_user) + url = reverse("note-detail", args=[str(note.id)]) + data = {"content": "Hacked!"} + response = api_client.patch(url, data, format="json") + assert response.status_code == status.HTTP_404_NOT_FOUND + + +class TestNoteDelete: + def test_delete_note(self, auth_client: APIClient, note: Note): + url = reverse("note-detail", args=[str(note.id)]) + response = auth_client.delete(url) + assert response.status_code == status.HTTP_204_NO_CONTENT + assert Note.objects.count() == 0 + + def test_batch_delete_notes( + self, auth_client: APIClient, user: User, book: Book + ): + n1 = Note.objects.create(user=user, book=book, page=1, content="A") + n2 = Note.objects.create(user=user, book=book, page=2, content="B") + url = reverse("note-batch-delete") + response = auth_client.delete(url, {"ids": [str(n1.id), str(n2.id)]}, format="json") + assert response.status_code == status.HTTP_200_OK + assert response.data["deleted"] == 2 + + +class TestNoteFilterByBook: + def test_filter_by_book( + self, auth_client: APIClient, user: User, book: Book + ): + other_book = Book.objects.create(title="Other", author="Other") + Note.objects.create(user=user, book=book, page=1, content="In book") + Note.objects.create(user=user, book=other_book, page=2, content="In other") + + url = reverse("note-list") + response = auth_client.get(url, {"book": str(book.id)}) + assert response.status_code == status.HTTP_200_OK + assert response.data["count"] == 1 + assert response.data["results"][0]["content"] == "In book" \ No newline at end of file diff --git a/backend/apps/annotations/urls.py b/backend/apps/annotations/urls.py new file mode 100644 index 0000000..5f19280 --- /dev/null +++ b/backend/apps/annotations/urls.py @@ -0,0 +1,12 @@ +from django.urls import include, path +from rest_framework.routers import DefaultRouter + +from apps.annotations.views import BookmarkViewSet, NoteViewSet + +router = DefaultRouter() +router.register(r"bookmarks", BookmarkViewSet, basename="bookmark") +router.register(r"notes", NoteViewSet, basename="note") + +urlpatterns = [ + path("", include(router.urls)), +] \ No newline at end of file diff --git a/backend/apps/annotations/views.py b/backend/apps/annotations/views.py new file mode 100644 index 0000000..0ddafe4 --- /dev/null +++ b/backend/apps/annotations/views.py @@ -0,0 +1,93 @@ +from django_filters.rest_framework import DjangoFilterBackend +from rest_framework import status, viewsets +from rest_framework.decorators import action +from rest_framework.filters import OrderingFilter, SearchFilter +from rest_framework.permissions import IsAuthenticated +from rest_framework.response import Response + +from apps.annotations.models import Bookmark, Note +from apps.annotations.permissions import IsOwner +from apps.annotations.serializers import ( + BookmarkCreateSerializer, + BookmarkSerializer, + NoteCreateSerializer, + NoteSerializer, +) + + +class BookmarkViewSet(viewsets.ModelViewSet): + """CRUD for user bookmarks. Users can only manage their own bookmarks.""" + + permission_classes = [IsAuthenticated, IsOwner] + filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter] + filterset_fields = ["book"] + search_fields = ["location_text"] + ordering_fields = ["created_at", "page"] + ordering = ["-created_at"] + + def get_serializer_class(self): + if self.action == "create": + return BookmarkCreateSerializer + return BookmarkSerializer + + def get_queryset(self): + return Bookmark.objects.filter(user=self.request.user).select_related( + "book" + ) + + def perform_create(self, serializer): + serializer.save(user=self.request.user) + + @action(detail=False, methods=["delete"], url_path="batch-delete") + def batch_delete(self, request): + """Delete multiple bookmarks by id list.""" + ids = request.data.get("ids", []) + if not ids: + return Response( + {"detail": "No ids provided."}, status=status.HTTP_400_BAD_REQUEST + ) + deleted, _ = Bookmark.objects.filter( + id__in=ids, user=request.user + ).delete() + return Response( + {"deleted": deleted}, status=status.HTTP_200_OK + ) + + +class NoteViewSet(viewsets.ModelViewSet): + """CRUD for user notes. Users can only manage their own notes.""" + + permission_classes = [IsAuthenticated, IsOwner] + filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter] + filterset_fields = ["book"] + search_fields = ["content", "location_text"] + ordering_fields = ["created_at", "page"] + ordering = ["-created_at"] + + def get_serializer_class(self): + if self.action == "create": + return NoteCreateSerializer + return NoteSerializer + + def get_queryset(self): + return Note.objects.filter(user=self.request.user).select_related( + "book" + ) + + def perform_create(self, serializer): + serializer.save(user=self.request.user) + + @action(detail=False, methods=["delete"], url_path="batch-delete") + def batch_delete(self, request): + """Delete multiple notes by id list.""" + ids = request.data.get("ids", []) + if not ids: + return Response( + {"detail": "No ids provided."}, status=status.HTTP_400_BAD_REQUEST + ) + deleted, _ = Note.objects.filter( + id__in=ids, user=request.user + ).delete() + return Response( + {"deleted": deleted}, status=status.HTTP_200_OK + ) \ No newline at end of file diff --git a/backend/apps/books/__init__.py b/backend/apps/books/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/backend/apps/books/admin.py b/backend/apps/books/admin.py new file mode 100644 index 0000000..d94db8f --- /dev/null +++ b/backend/apps/books/admin.py @@ -0,0 +1,9 @@ +from django.contrib import admin + +from apps.books.models import Book + + +@admin.register(Book) +class BookAdmin(admin.ModelAdmin): + list_display = ("title", "author", "total_pages", "created_at") + search_fields = ("title", "author") \ No newline at end of file diff --git a/backend/apps/books/apps.py b/backend/apps/books/apps.py new file mode 100644 index 0000000..d3d291d --- /dev/null +++ b/backend/apps/books/apps.py @@ -0,0 +1,7 @@ +from django.apps import AppConfig + + +class BooksConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.books" + label = "books" \ No newline at end of file diff --git a/backend/apps/books/models.py b/backend/apps/books/models.py new file mode 100644 index 0000000..d6a16be --- /dev/null +++ b/backend/apps/books/models.py @@ -0,0 +1,21 @@ +from django.db import models + + +class Book(models.Model): + """Represents a book in the user's library.""" + + title = models.CharField(max_length=512) + author = models.CharField(max_length=256, blank=True, default="") + total_pages = models.PositiveIntegerField(default=0) + cover_image = models.URLField(blank=True, default="") + created_at = models.DateTimeField(auto_now_add=True) + updated_at = models.DateTimeField(auto_now=True) + + class Meta: + db_table = "books_book" + verbose_name = "Book" + verbose_name_plural = "Books" + ordering = ["title"] + + def __str__(self) -> str: + return self.title \ No newline at end of file diff --git a/backend/apps/books/serializers.py b/backend/apps/books/serializers.py new file mode 100644 index 0000000..7339b80 --- /dev/null +++ b/backend/apps/books/serializers.py @@ -0,0 +1,28 @@ +from rest_framework import serializers + +from apps.books.models import Book + + +class BookSerializer(serializers.ModelSerializer): + """Serialize Book data.""" + + class Meta: + model = Book + fields = [ + "id", + "title", + "author", + "total_pages", + "cover_image", + "created_at", + "updated_at", + ] + read_only_fields = ["id", "created_at", "updated_at"] + + +class BookListSerializer(serializers.ModelSerializer): + """Lightweight serializer for list views (excludes heavy fields).""" + + class Meta: + model = Book + fields = ["id", "title", "author", "total_pages", "cover_image"] \ No newline at end of file diff --git a/backend/apps/books/urls.py b/backend/apps/books/urls.py new file mode 100644 index 0000000..a95f0cd --- /dev/null +++ b/backend/apps/books/urls.py @@ -0,0 +1,11 @@ +from django.urls import include, path +from rest_framework.routers import DefaultRouter + +from apps.books.views import BookViewSet + +router = DefaultRouter() +router.register(r"", BookViewSet, basename="book") + +urlpatterns = [ + path("", include(router.urls)), +] \ No newline at end of file diff --git a/backend/apps/books/views.py b/backend/apps/books/views.py new file mode 100644 index 0000000..c3f9baa --- /dev/null +++ b/backend/apps/books/views.py @@ -0,0 +1,24 @@ +from django_filters.rest_framework import DjangoFilterBackend +from rest_framework import viewsets +from rest_framework.filters import OrderingFilter, SearchFilter +from rest_framework.permissions import IsAuthenticated + +from apps.books.models import Book +from apps.books.serializers import BookListSerializer, BookSerializer + + +class BookViewSet(viewsets.ModelViewSet): + """CRUD for books.""" + + queryset = Book.objects.all() + permission_classes = [IsAuthenticated] + filter_backends = [DjangoFilterBackend, SearchFilter, OrderingFilter] + filterset_fields = ["author"] + search_fields = ["title", "author"] + ordering_fields = ["title", "author", "created_at"] + ordering = ["title"] + + def get_serializer_class(self): + if self.action == "list": + return BookListSerializer + return BookSerializer \ No newline at end of file diff --git a/backend/apps/users/__init__.py b/backend/apps/users/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/backend/apps/users/admin.py b/backend/apps/users/admin.py new file mode 100644 index 0000000..ffe7f19 --- /dev/null +++ b/backend/apps/users/admin.py @@ -0,0 +1,11 @@ +from django.contrib import admin +from django.contrib.auth.admin import UserAdmin as BaseUserAdmin + +from apps.users.models import User + + +@admin.register(User) +class UserAdmin(BaseUserAdmin): + """Admin config for the custom User model.""" + list_display = ("email", "username", "is_staff", "is_active", "date_joined") + search_fields = ("email", "username") \ No newline at end of file diff --git a/backend/apps/users/apps.py b/backend/apps/users/apps.py new file mode 100644 index 0000000..d392ec4 --- /dev/null +++ b/backend/apps/users/apps.py @@ -0,0 +1,7 @@ +from django.apps import AppConfig + + +class UsersConfig(AppConfig): + default_auto_field = "django.db.models.BigAutoField" + name = "apps.users" + label = "users" \ No newline at end of file diff --git a/backend/apps/users/models.py b/backend/apps/users/models.py new file mode 100644 index 0000000..229f8f1 --- /dev/null +++ b/backend/apps/users/models.py @@ -0,0 +1,13 @@ +from django.contrib.auth.models import AbstractUser + + +class User(AbstractUser): + """Custom user model. Uses email as the unique identifier field.""" + + class Meta: + db_table = "users_user" + verbose_name = "User" + verbose_name_plural = "Users" + + def __str__(self) -> str: + return self.email or self.username \ No newline at end of file diff --git a/backend/apps/users/urls.py b/backend/apps/users/urls.py new file mode 100644 index 0000000..4386a57 --- /dev/null +++ b/backend/apps/users/urls.py @@ -0,0 +1,8 @@ +from django.urls import include, path +from rest_framework.routers import DefaultRouter +from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView + +urlpatterns = [ + path("token/", TokenObtainPairView.as_view(), name="token_obtain_pair"), + path("token/refresh/", TokenRefreshView.as_view(), name="token_refresh"), +] \ No newline at end of file diff --git a/backend/config/django.py b/backend/config/django.py new file mode 100644 index 0000000..e5b9a67 --- /dev/null +++ b/backend/config/django.py @@ -0,0 +1,153 @@ +""" +Django settings for cloud-reader backend. + +Generated using Django 5.1. Customised with pydantic-settings integration. +""" + +from pathlib import Path + +from config.settings import settings + +# --------------------------------------------------------------------------- +# Build paths +# --------------------------------------------------------------------------- +BASE_DIR = Path(__file__).resolve().parent.parent + +# --------------------------------------------------------------------------- +# Security +# --------------------------------------------------------------------------- +SECRET_KEY = settings.DJANGO_SECRET_KEY +DEBUG = settings.DJANGO_DEBUG +ALLOWED_HOSTS = settings.DJANGO_ALLOWED_HOSTS + +# --------------------------------------------------------------------------- +# Application definition +# --------------------------------------------------------------------------- +INSTALLED_APPS = [ + # Django built-in + "django.contrib.admin", + "django.contrib.auth", + "django.contrib.contenttypes", + "django.contrib.sessions", + "django.contrib.messages", + "django.contrib.staticfiles", + # Third-party + "rest_framework", + "rest_framework_simplejwt", + "corsheaders", + "django_filters", + # Local apps + "apps.users", + "apps.books", + "apps.annotations", +] + +MIDDLEWARE = [ + "corsheaders.middleware.CorsMiddleware", + "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 +# --------------------------------------------------------------------------- +DATABASES = { + "default": { + "ENGINE": "django.db.backends.postgresql", + "NAME": settings.DB_NAME, + "USER": settings.DB_USER, + "PASSWORD": settings.DB_PASSWORD, + "HOST": settings.DB_HOST, + "PORT": settings.DB_PORT, + } +} + +# --------------------------------------------------------------------------- +# Auth +# --------------------------------------------------------------------------- +AUTH_USER_MODEL = "users.User" + +AUTH_PASSWORD_VALIDATORS = [ + {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"}, + {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"}, +] + +# --------------------------------------------------------------------------- +# DRF +# --------------------------------------------------------------------------- +REST_FRAMEWORK = { + "DEFAULT_AUTHENTICATION_CLASSES": ( + "rest_framework_simplejwt.authentication.JWTAuthentication", + ), + "DEFAULT_PERMISSION_CLASSES": ( + "rest_framework.permissions.IsAuthenticated", + ), + "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination", + "PAGE_SIZE": 50, + "DEFAULT_FILTER_BACKENDS": [ + "django_filters.rest_framework.DjangoFilterBackend", + "rest_framework.filters.OrderingFilter", + "rest_framework.filters.SearchFilter", + ], +} + +# --------------------------------------------------------------------------- +# SimpleJWT +# --------------------------------------------------------------------------- +from datetime import timedelta + +SIMPLE_JWT = { + "ACCESS_TOKEN_LIFETIME": timedelta(minutes=settings.JWT_ACCESS_TOKEN_LIFETIME_MINUTES), + "REFRESH_TOKEN_LIFETIME": timedelta(days=settings.JWT_REFRESH_TOKEN_LIFETIME_DAYS), +} + +# --------------------------------------------------------------------------- +# CORS +# --------------------------------------------------------------------------- +CORS_ALLOWED_ORIGINS = settings.CORS_ALLOWED_ORIGINS + +# --------------------------------------------------------------------------- +# i18n +# --------------------------------------------------------------------------- +LANGUAGE_CODE = "en-us" +TIME_ZONE = "UTC" +USE_I18N = True +USE_TZ = True + +# --------------------------------------------------------------------------- +# Static / Media +# --------------------------------------------------------------------------- +STATIC_URL = "static/" +STATIC_ROOT = BASE_DIR / "staticfiles" +MEDIA_URL = "media/" +MEDIA_ROOT = BASE_DIR / "media" + +# --------------------------------------------------------------------------- +# Default primary key +# --------------------------------------------------------------------------- +DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" \ No newline at end of file diff --git a/backend/config/settings.py b/backend/config/settings.py new file mode 100644 index 0000000..7812b19 --- /dev/null +++ b/backend/config/settings.py @@ -0,0 +1,42 @@ +import os +from pathlib import Path + +from pydantic_settings import BaseSettings + + +class Settings(BaseSettings): + """Application settings via pydantic-settings. Reads from env vars and .env.""" + + # Django + DJANGO_SECRET_KEY: str = "django-insecure-change-me-in-production" + DJANGO_DEBUG: bool = False + DJANGO_ALLOWED_HOSTS: list[str] = ["*"] + + # PostgreSQL + DB_NAME: str = "cloud_reader" + DB_USER: str = "postgres" + DB_PASSWORD: str = "postgres" + DB_HOST: str = "localhost" + DB_PORT: int = 5432 + + # JWT + JWT_ACCESS_TOKEN_LIFETIME_MINUTES: int = 60 + JWT_REFRESH_TOKEN_LIFETIME_DAYS: int = 7 + + # CORS + CORS_ALLOWED_ORIGINS: list[str] = [ + "http://localhost:5173", + "http://localhost:3000", + ] + + @property + def DATABASE_URL(self) -> str: + return ( + f"postgresql://{self.DB_USER}:{self.DB_PASSWORD}" + f"@{self.DB_HOST}:{self.DB_PORT}/{self.DB_NAME}" + ) + + model_config = {"env_file": ".env", "env_file_encoding": "utf-8"} + + +settings = Settings() \ No newline at end of file diff --git a/backend/config/urls.py b/backend/config/urls.py new file mode 100644 index 0000000..cb1a5cb --- /dev/null +++ b/backend/config/urls.py @@ -0,0 +1,9 @@ +from django.contrib import admin +from django.urls import include, path + +urlpatterns = [ + path("admin/", admin.site.urls), + path("api/auth/", include("apps.users.urls")), + path("api/books/", include("apps.books.urls")), + path("api/annotations/", include("apps.annotations.urls")), +] \ No newline at end of file diff --git a/backend/config/wsgi.py b/backend/config/wsgi.py new file mode 100644 index 0000000..a418f6c --- /dev/null +++ b/backend/config/wsgi.py @@ -0,0 +1,7 @@ +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.django") + +application = get_wsgi_application() \ No newline at end of file diff --git a/backend/manage.py b/backend/manage.py new file mode 100644 index 0000000..189d79f --- /dev/null +++ b/backend/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.django") + 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() \ No newline at end of file diff --git a/backend/pytest.ini b/backend/pytest.ini new file mode 100644 index 0000000..71efc39 --- /dev/null +++ b/backend/pytest.ini @@ -0,0 +1,8 @@ +[tool:pytest] +DJANGO_SETTINGS_MODULE = config.django +python_files = tests.py test_*.py *_tests.py +testpaths = apps + +[coverage:run] +source = apps +omit = */tests/*,*/migrations/*,*/admin.py,*/apps.py \ No newline at end of file diff --git a/backend/requirements.txt b/backend/requirements.txt new file mode 100644 index 0000000..53d8e6b --- /dev/null +++ b/backend/requirements.txt @@ -0,0 +1,14 @@ +Django==5.1.7 +djangorestframework==3.15.2 +djangorestframework-simplejwt==5.4.0 +django-filter==25.1 +django-cors-headers==4.6.0 +psycopg2-binary==2.9.10 +pydantic==2.10.5 +pydantic-settings==2.7.1 +python-dotenv==1.0.1 +gunicorn==23.0.0 +pytest==8.3.4 +pytest-django==4.9.0 +pytest-cov==6.0.0 +coverage==7.6.10 \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..e03b53a --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,52 @@ +services: + db: + image: postgres:15 + restart: unless-stopped + volumes: + - postgres_data:/var/lib/postgresql/data + environment: + POSTGRES_DB: cloudreader + POSTGRES_USER: cloudreader + POSTGRES_PASSWORD: cloudreader + ports: + - "5432:5432" + healthcheck: + test: ["CMD-SHELL", "pg_isready -U cloudreader -d cloudreader"] + interval: 5s + timeout: 5s + retries: 10 + + api: + build: + context: ./api + ports: + - "8000:8000" + environment: + DATABASE_URL: "postgres://cloudreader:cloudreader@db:5432/cloudreader" + DJANGO_SECRET_KEY: "dev-secret-key-change-in-production" + DJANGO_DEBUG: "True" + volumes: + - ./api:/app + - book_uploads:/app/media + command: > + sh -c "python manage.py migrate && python manage.py runserver 0.0.0.0:8000" + depends_on: + db: + condition: service_healthy + + web: + build: + context: ./web + ports: + - "3000:3000" + environment: + VITE_API_URL: "http://localhost:8000" + volumes: + - ./web:/app + - /app/node_modules + depends_on: + - api + +volumes: + postgres_data: + book_uploads: \ No newline at end of file diff --git a/frontend/index.html b/frontend/index.html new file mode 100644 index 0000000..c404679 --- /dev/null +++ b/frontend/index.html @@ -0,0 +1,12 @@ + + + + + + Cloud Reader + + +
+ + + \ No newline at end of file diff --git a/frontend/package.json b/frontend/package.json new file mode 100644 index 0000000..1b174a5 --- /dev/null +++ b/frontend/package.json @@ -0,0 +1,30 @@ +{ + "name": "@cloud-reader/frontend", + "version": "1.0.0", + "private": true, + "type": "module", + "scripts": { + "dev": "vite", + "build": "tsc -b && vite build", + "preview": "vite preview", + "test": "vitest run", + "lint": "eslint ." + }, + "dependencies": { + "react": "^19.0.0", + "react-dom": "^19.0.0", + "react-router-dom": "^7.1.0", + "axios": "^1.7.9" + }, + "devDependencies": { + "@types/react": "^19.0.0", + "@types/react-dom": "^19.0.0", + "@vitejs/plugin-react": "^4.3.4", + "typescript": "~5.7.0", + "vite": "^6.0.0", + "vitest": "^2.1.0", + "@testing-library/react": "^16.2.0", + "@testing-library/jest-dom": "^6.6.3", + "jsdom": "^25.0.0" + } +} \ No newline at end of file diff --git a/frontend/src/api/annotations.ts b/frontend/src/api/annotations.ts new file mode 100644 index 0000000..df2148f --- /dev/null +++ b/frontend/src/api/annotations.ts @@ -0,0 +1,96 @@ +import api from "@/api/client"; +import type { + Bookmark, + CreateBookmarkPayload, + Note, + CreateNotePayload, + UpdateNotePayload, + PaginatedResponse, +} from "@/types"; + +/** Fetch bookmarks for the current user, optionally filtered by book */ +export async function fetchBookmarks( + bookId?: string +): Promise> { + const params: Record = {}; + if (bookId) params.book = bookId; + const { data } = await api.get>( + "/annotations/bookmarks/", + { params } + ); + return data; +} + +/** Create a new bookmark */ +export async function createBookmark( + payload: CreateBookmarkPayload +): Promise { + const { data } = await api.post( + "/annotations/bookmarks/", + payload + ); + return data; +} + +/** Delete a bookmark by id */ +export async function deleteBookmark(id: string): Promise { + await api.delete(`/annotations/bookmarks/${id}/`); +} + +/** Batch delete bookmarks */ +export async function batchDeleteBookmarks( + ids: string[] +): Promise<{ deleted: number }> { + const { data } = await api.delete<{ deleted: number }>( + "/annotations/bookmarks/batch-delete/", + { data: { ids } } + ); + return data; +} + +/** Fetch notes for the current user, optionally filtered by book */ +export async function fetchNotes( + bookId?: string +): Promise> { + const params: Record = {}; + if (bookId) params.book = bookId; + const { data } = await api.get>( + "/annotations/notes/", + { params } + ); + return data; +} + +/** Create a new note */ +export async function createNote(payload: CreateNotePayload): Promise { + const { data } = await api.post("/annotations/notes/", payload); + return data; +} + +/** Update a note's content */ +export async function updateNote( + id: string, + payload: UpdateNotePayload +): Promise { + const { data } = await api.patch( + `/annotations/notes/${id}/`, + payload + ); + return data; +} + +/** Delete a note by id */ +export async function deleteNote(id: string): Promise { + await api.delete(`/annotations/notes/${id}/`); +} + +/** Batch delete notes */ +export async function batchDeleteNotes( + ids: string[] +): Promise<{ deleted: number }> { + const { data } = await api.delete<{ deleted: number }>( + "/annotations/notes/batch-delete/", + { data: { ids } } + ); + return data; +} \ No newline at end of file diff --git a/frontend/src/api/client.ts b/frontend/src/api/client.ts new file mode 100644 index 0000000..5eb964b --- /dev/null +++ b/frontend/src/api/client.ts @@ -0,0 +1,67 @@ +import axios from "axios"; + +const api = axios.create({ + baseURL: "/api", + headers: { + "Content-Type": "application/json", + }, +}); + +// Attach JWT token to every request +api.interceptors.request.use((config) => { + const token = localStorage.getItem("access_token"); + if (token) { + config.headers.Authorization = `Bearer ${token}`; + } + return config; +}); + +// Attempt token refresh on 401 +let isRefreshing = false; +let pendingRequests: Array<(token: string) => void> = []; + +api.interceptors.response.use( + (response) => response, + async (error) => { + const originalRequest = error.config; + if (error.response?.status !== 401 || originalRequest._retry) { + return Promise.reject(error); + } + + if (isRefreshing) { + return new Promise((resolve) => { + pendingRequests.push((token: string) => { + originalRequest.headers.Authorization = `Bearer ${token}`; + resolve(api(originalRequest)); + }); + }); + } + + originalRequest._retry = true; + isRefreshing = true; + + try { + const refreshToken = localStorage.getItem("refresh_token"); + if (!refreshToken) { + throw new Error("No refresh token"); + } + const { data } = await axios.post("/api/auth/token/refresh/", { + refresh: refreshToken, + }); + localStorage.setItem("access_token", data.access); + pendingRequests.forEach((cb) => cb(data.access)); + pendingRequests = []; + originalRequest.headers.Authorization = `Bearer ${data.access}`; + return api(originalRequest); + } catch { + localStorage.removeItem("access_token"); + localStorage.removeItem("refresh_token"); + window.location.href = "/login"; + return Promise.reject(error); + } finally { + isRefreshing = false; + } + } +); + +export default api; \ No newline at end of file diff --git a/frontend/src/components/annotations/AddAnnotationForm.tsx b/frontend/src/components/annotations/AddAnnotationForm.tsx new file mode 100644 index 0000000..b95b8bb --- /dev/null +++ b/frontend/src/components/annotations/AddAnnotationForm.tsx @@ -0,0 +1,120 @@ +import React, { useState } from "react"; +import { useAnnotations } from "@/context/AnnotationsContext"; + +interface AddAnnotationFormProps { + bookId: string; + page: number; + locationText?: string; + onClose?: () => void; +} + +export function AddAnnotationForm({ + bookId, + page, + locationText, + onClose, +}: AddAnnotationFormProps): React.ReactElement { + const { addBookmark, addNote } = useAnnotations(); + const [mode, setMode] = useState<"bookmark" | "note" | null>(null); + const [noteContent, setNoteContent] = useState(""); + const [submitting, setSubmitting] = useState(false); + const [error, setError] = useState(null); + + const handleSubmit = async (): Promise => { + setSubmitting(true); + setError(null); + try { + if (mode === "bookmark") { + await addBookmark({ book: bookId, page, location_text: locationText }); + } else if (mode === "note") { + if (!noteContent.trim()) { + setError("Note content cannot be empty."); + setSubmitting(false); + return; + } + await addNote({ + book: bookId, + page, + location_text: locationText, + content: noteContent.trim(), + }); + } + onClose?.(); + } catch (err) { + setError( + err instanceof Error ? err.message : "Failed to save annotation." + ); + } finally { + setSubmitting(false); + } + }; + + return ( +
+
+ +

Add to Page {page}

+ {locationText && ( +
+ “{locationText}” +
+ )} + + {!mode ? ( +
+ + +
+ ) : ( +
+ {mode === "note" && ( +
+ +