sandwitches 1.5.0__tar.gz

sandwitches-1.5.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.3
+Name: sandwitches
+Version: 1.5.0
+Summary: Add your description here
+Author: Martyn van Dijke
+Author-email: Martyn van Dijke <martijnvdijke600@gmail.com>
+Requires-Dist: django-debug-toolbar>=6.1.0
+Requires-Dist: django-filter>=25.2
+Requires-Dist: django-imagekit>=6.0.0
+Requires-Dist: django-import-export>=4.3.14
+Requires-Dist: django-ninja>=1.5.1
+Requires-Dist: django-simple-history>=3.10.1
+Requires-Dist: django-tasks>=0.10.0
+Requires-Dist: django-solo>=2.3.0
+Requires-Dist: django>=6.0.0
+Requires-Dist: gunicorn>=23.0.0
+Requires-Dist: markdown>=3.10
+Requires-Dist: pillow>=12.0.0
+Requires-Dist: uvicorn>=0.40.0
+Requires-Dist: whitenoise[brotli]>=6.11.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="src/static/icons/banner.svg" alt="Sandwitches Banner" width="600px">
+</p>
+
+<h1 align="center">🥪 Sandwitches</h1>
+
+<p align="center">
+  <strong>Sandwiches so good, they haunt you!</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/martynvdijke/sandwitches/actions/workflows/ci.yaml">
+    <img src="https://github.com/martynvdijke/sandwitches/actions/workflows/ci.yaml/badge.svg" alt="CI Status">
+  </a>
+  <a href="https://github.com/martynvdijke/sandwitches/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/martynvdijke/sandwitches" alt="License">
+  </a>
+  <img src="https://img.shields.io/badge/python-3.12+-blue.svg" alt="Python Version">
+  <img src="https://img.shields.io/badge/django-6.0-green.svg" alt="Django Version">
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+</p>
+
+---
+
+## ✨ Overview
+
+Sandwitches is a modern, recipe management platform built with **Django 6.0**.
+It is made as a hobby project for my girlfriend, who likes to make what I call "fancy" sandwiches (sandwiches that go beyond the Dutch normals), lucky to be me :).
+See wanted to have a way to advertise and share those sandwtiches with the family and so I started coding making it happen, in the hopes of getting more fancy sandwiches.
+
+## 📥 Getting Started
+
+### Prerequisites
+
+* Python 3.12+
+* [uv](https://github.com/astral-sh/uv) (recommended) or pip
+
+### Installation
+
+1. **Clone the repository**:
+
+    ```bash
+    git clone https://github.com/martynvdijke/sandwitches.git
+    cd sandwitches
+    ```
+
+2. **Sync dependencies**:
+
+    ```bash
+    uv sync
+    ```
+
+3. **Run migrations and collect static files**:
+
+    ```bash
+    uv run invoke setup-ci  # Sets up environment variables
+    uv run src/manage.py migrate
+    uv run src/manage.py collectstatic --noinput
+    ```
+
+4. **Start the development server**:
+
+    ```bash
+    uv run src/manage.py runserver
+    ```
+
+## 🧪 Testing & Quality
+
+The project maintains high standards with over **80+ automated tests**.
+
+* **Run tests**: `uv run invoke tests`
+* **Linting**: `uv run invoke linting`
+* **Type checking**: `uv run invoke typecheck`
+
+---
+
+<p align="center">
+  Made with ❤️ for sandwich enthusiasts.
+</p>

sandwitches-1.5.0/README.md

@@ -0,0 +1,81 @@
+<p align="center">
+  <img src="src/static/icons/banner.svg" alt="Sandwitches Banner" width="600px">
+</p>
+
+<h1 align="center">🥪 Sandwitches</h1>
+
+<p align="center">
+  <strong>Sandwiches so good, they haunt you!</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/martynvdijke/sandwitches/actions/workflows/ci.yaml">
+    <img src="https://github.com/martynvdijke/sandwitches/actions/workflows/ci.yaml/badge.svg" alt="CI Status">
+  </a>
+  <a href="https://github.com/martynvdijke/sandwitches/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/martynvdijke/sandwitches" alt="License">
+  </a>
+  <img src="https://img.shields.io/badge/python-3.12+-blue.svg" alt="Python Version">
+  <img src="https://img.shields.io/badge/django-6.0-green.svg" alt="Django Version">
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff">
+  </a>
+</p>
+
+---
+
+## ✨ Overview
+
+Sandwitches is a modern, recipe management platform built with **Django 6.0**.
+It is made as a hobby project for my girlfriend, who likes to make what I call "fancy" sandwiches (sandwiches that go beyond the Dutch normals), lucky to be me :).
+See wanted to have a way to advertise and share those sandwtiches with the family and so I started coding making it happen, in the hopes of getting more fancy sandwiches.
+
+## 📥 Getting Started
+
+### Prerequisites
+
+* Python 3.12+
+* [uv](https://github.com/astral-sh/uv) (recommended) or pip
+
+### Installation
+
+1. **Clone the repository**:
+
+    ```bash
+    git clone https://github.com/martynvdijke/sandwitches.git
+    cd sandwitches
+    ```
+
+2. **Sync dependencies**:
+
+    ```bash
+    uv sync
+    ```
+
+3. **Run migrations and collect static files**:
+
+    ```bash
+    uv run invoke setup-ci  # Sets up environment variables
+    uv run src/manage.py migrate
+    uv run src/manage.py collectstatic --noinput
+    ```
+
+4. **Start the development server**:
+
+    ```bash
+    uv run src/manage.py runserver
+    ```
+
+## 🧪 Testing & Quality
+
+The project maintains high standards with over **80+ automated tests**.
+
+* **Run tests**: `uv run invoke tests`
+* **Linting**: `uv run invoke linting`
+* **Type checking**: `uv run invoke typecheck`
+
+---
+
+<p align="center">
+  Made with ❤️ for sandwich enthusiasts.
+</p>

sandwitches-1.5.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "sandwitches"
+version = "1.5.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Martyn van Dijke", email = "martijnvdijke600@gmail.com" }
+]
+
+requires-python = ">=3.12"
+
+dependencies = [
+    "django-debug-toolbar>=6.1.0",
+    "django-filter>=25.2",
+    "django-imagekit>=6.0.0",
+    "django-import-export>=4.3.14",
+    "django-ninja>=1.5.1",
+    "django-simple-history>=3.10.1",
+    "django-tasks>=0.10.0",
+    "django-solo>=2.3.0",
+    "django>=6.0.0",
+    "gunicorn>=23.0.0",
+    "markdown>=3.10",
+    "pillow>=12.0.0",
+    "uvicorn>=0.40.0",
+    "whitenoise[brotli]>=6.11.0",
+]
+
+
+[build-system]
+requires = ["uv_build>=0.8.19,<0.9.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "invoke>=2.2.1",
+    "pytest-django>=4.11.1",
+    "pytest>=8.4.2",
+    "ruff>=0.14.3",
+    "ty>=0.0.1a26",
+]
+
+[tool.uv]
+package = true
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "sandwitches.settings"

sandwitches-1.5.0/src/sandwitches/__init__.py

@@ -0,0 +1,6 @@
+"""Top-level package for sandwitches."""
+
+from importlib.metadata import version
+
+__version__ = version("sandwitches")  # Matches the 'name' in pyproject.toml
+__author__ = """Martyn van Dijke"""

sandwitches-1.5.0/src/sandwitches/admin.py

@@ -0,0 +1,68 @@
+from django.contrib import admin
+from django.contrib.auth import get_user_model
+from django.contrib.auth.admin import UserAdmin
+from .models import Recipe, Tag, Rating, Setting
+from django.utils.html import format_html
+from import_export import resources
+from import_export.admin import ImportExportModelAdmin
+from solo.admin import SingletonModelAdmin
+from .forms import SettingForm
+
+
+class RecipeResource(resources.ModelResource):
+    class Meta:
+        model = Recipe
+
+
+class TagResource(resources.ModelResource):
+    class Meta:
+        model = Tag
+
+
+class RatingResource(resources.ModelResource):
+    class Meta:
+        model = Rating
+
+
+User = get_user_model()
+
+
+@admin.register(Setting)
+class SettingAdmin(SingletonModelAdmin):
+    form = SettingForm
+
+
+@admin.register(User)
+class CustomUserAdmin(UserAdmin):
+    fieldsets = UserAdmin.fieldsets + (
+        (None, {"fields": ("avatar", "bio", "language", "favorites")}),
+    )
+
+
+@admin.register(Recipe)
+class RecipeAdmin(ImportExportModelAdmin):
+    resource_classes = [RecipeResource]
+    list_display = ("title", "uploaded_by", "created_at", "show_url")
+    readonly_fields = ("created_at", "updated_at")
+
+    def save_model(self, request, obj, form, change):
+        # set uploaded_by automatically when creating in admin
+        if not change and not obj.uploaded_by:
+            obj.uploaded_by = request.user
+        super().save_model(request, obj, form, change)
+
+    def show_url(self, obj):
+        url = obj.get_absolute_url()
+        return format_html("<a href='{url}'>{url}</a>", url=url)
+
+    show_url.short_description = "Recipe Link"  # ty:ignore[unresolved-attribute]
+
+
+@admin.register(Tag)
+class TagAdmin(ImportExportModelAdmin):
+    resource_classes = [TagResource]
+
+
+@admin.register(Rating)
+class RatingAdmin(ImportExportModelAdmin):
+    resource_classes = [RatingResource]

sandwitches-1.5.0/src/sandwitches/api.py

@@ -0,0 +1,207 @@
+import logging
+from ninja import NinjaAPI
+from .models import Recipe, Tag, Setting, Rating
+from django.contrib.auth import get_user_model
+from .utils import (
+    parse_ingredient_line,
+    scale_ingredient,
+    format_scaled_ingredient,
+)  # Import utility functions
+
+from ninja import ModelSchema
+from ninja import Schema
+from django.shortcuts import get_object_or_404
+from datetime import date
+import random
+from typing import List, Optional  # Import typing hints
+
+from ninja.security import django_auth
+
+from . import __version__
+
+# Get the custom User model
+User = get_user_model()
+
+api = NinjaAPI(version=__version__)
+
+
+class UserPublicSchema(ModelSchema):
+    class Meta:
+        model = User
+        fields = ["username", "first_name", "last_name", "avatar"]
+
+
+class RecipeSchema(ModelSchema):
+    favorited_by: List[UserPublicSchema] = []
+
+    class Meta:
+        model = Recipe
+        fields = "__all__"
+
+
+class TagSchema(ModelSchema):
+    class Meta:
+        model = Tag
+        fields = "__all__"
+
+
+class UserSchema(ModelSchema):
+    class Meta:
+        model = User
+        exclude = ["password", "last_login", "user_permissions"]
+
+
+class SettingSchema(ModelSchema):
+    class Meta:
+        model = Setting
+        fields = "__all__"
+
+
+class RatingSchema(ModelSchema):
+    user: UserPublicSchema
+
+    class Meta:
+        model = Rating
+        fields = "__all__"
+
+
+class Error(Schema):
+    message: str
+
+
+class RatingResponseSchema(Schema):
+    average: float
+    count: int
+
+
+class ScaledIngredient(Schema):  # New Schema for scaled ingredients
+    original_line: str
+    scaled_line: str
+    quantity: Optional[float]
+    unit: Optional[str]
+    name: Optional[str]
+
+
+@api.get("ping")
+def ping(request):
+    return {"status": "ok", "message": "pong"}
+
+
+@api.get("v1/settings", response=SettingSchema)
+def get_settings(request):
+    return Setting.objects.get()  # ty:ignore[unresolved-attribute]
+
+
+@api.post("v1/settings", auth=django_auth, response={200: SettingSchema, 403: Error})
+def update_settings(request, payload: SettingSchema):
+    if not request.user.is_staff:
+        return 403, {"message": "You are not authorized to perform this action"}
+    settings = Setting.objects.get()  # ty:ignore[unresolved-attribute]
+    for attr, value in payload.dict().items():
+        setattr(settings, attr, value)
+    settings.save()
+    return settings
+
+
+@api.get("v1/me", response={200: UserSchema, 403: Error})
+def me(request):
+    if not request.user.is_authenticated:
+        return 403, {"message": "Please sign in first"}
+    return request.user
+
+
+@api.get("v1/users", auth=django_auth, response=list[UserSchema])
+def users(request):
+    return User.objects.all()
+
+
+@api.get("v1/recipes", response=list[RecipeSchema])
+def get_recipes(request):
+    return Recipe.objects.all().prefetch_related("favorited_by")  # ty:ignore[unresolved-attribute]
+
+
+@api.get("v1/recipes/{recipe_id}", response=RecipeSchema)
+def get_recipe(request, recipe_id: int):
+    recipe = get_object_or_404(
+        Recipe.objects.prefetch_related("favorited_by"),  # ty:ignore[unresolved-attribute]
+        id=recipe_id,
+    )
+    return recipe
+
+
+@api.get("v1/recipes/{recipe_id}/scale-ingredients", response=List[ScaledIngredient])
+def scale_recipe_ingredients(request, recipe_id: int, target_servings: int):
+    recipe = get_object_or_404(Recipe, id=recipe_id)
+
+    # Ensure target_servings is at least 1
+    target_servings = max(1, target_servings)
+
+    current_servings = recipe.servings
+    if not current_servings or current_servings <= 0:
+        current_servings = 1
+
+    ingredient_lines = [
+        line.strip() for line in (recipe.ingredients or "").split("\n") if line.strip()
+    ]
+
+    scaled_ingredients_output = []
+    for line in ingredient_lines:
+        try:
+            parsed = parse_ingredient_line(line)
+            scaled = scale_ingredient(parsed, current_servings, target_servings)
+            formatted_line = format_scaled_ingredient(scaled)
+
+            scaled_ingredients_output.append(
+                ScaledIngredient(
+                    original_line=line,
+                    scaled_line=formatted_line,
+                    quantity=scaled.get("quantity"),
+                    unit=scaled.get("unit"),
+                    name=scaled.get("name"),
+                )
+            )
+        except Exception as e:
+            # Fallback for lines that fail to parse/scale
+            scaled_ingredients_output.append(
+                ScaledIngredient(
+                    original_line=line,
+                    scaled_line=line,
+                    quantity=None,
+                    unit=None,
+                    name=line,
+                )
+            )
+            logging.warning(f"Failed to scale ingredient line '{line}': {e}")
+
+    return scaled_ingredients_output
+
+
+@api.get("v1/recipe-of-the-day", response=RecipeSchema)
+def get_recipe_of_the_day(request):
+    recipes = list(Recipe.objects.all().prefetch_related("favorited_by"))  # ty:ignore[unresolved-attribute]
+    if not recipes:
+        return None
+    today = date.today()
+    random.seed(today.toordinal())
+    recipe = random.choice(recipes)
+    return recipe
+
+
+@api.get("v1/recipes/{recipe_id}/rating", response=RatingResponseSchema)
+def get_recipe_rating(request, recipe_id: int):
+    recipe = get_object_or_404(Recipe, id=recipe_id)
+    return {
+        "average": recipe.average_rating(),
+        "count": recipe.rating_count(),
+    }
+
+
+@api.get("v1/tags", response=list[TagSchema])
+def get_tags(request):
+    return Tag.objects.all()  # ty:ignore[unresolved-attribute]
+
+
+@api.get("v1/tags/{tag_id}", response=TagSchema)
+def get_tag(request, tag_id: int):
+    tag = get_object_or_404(Tag, id=tag_id)
+    return tag

sandwitches-1.5.0/src/sandwitches/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for sandwitches project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "sandwitches.settings")
+
+application = get_asgi_application()

sandwitches-1.5.0/src/sandwitches/feeds.py

@@ -0,0 +1,23 @@
+from django.contrib.syndication.views import Feed
+from django.urls import reverse_lazy
+from .models import Recipe
+
+
+class LatestRecipesFeed(Feed):
+    title = "Sandwitches - Latest Recipes"
+    link = reverse_lazy(
+        "index"
+    )  # This should point to the homepage or a list of recipes
+    description = "Updates on the newest recipes added to Sandwitches."
+
+    def items(self):
+        return Recipe.objects.order_by("-created_at")[:5]  # ty:ignore[unresolved-attribute]
+
+    def item_title(self, item):
+        return item.title
+
+    def item_description(self, item):
+        return item.description
+
+    def item_link(self, item):
+        return item.get_absolute_url()