structables 0.4.4__tar.gz → 0.4.6__tar.gz

{structables-0.4.4 → structables-0.4.6}/.dockerignore

@@ -1,7 +1,9 @@
 .env
+.git
 .vscode
 __pycache__/
 docker-compose.yml
+compose.yaml
 privacy.md
 privacy.txt
 *.pyc

structables-0.4.6/.forgejo/workflows/docker.yml

@@ -0,0 +1,59 @@
+name: Docker CI/CD
+
+on:
+  push:
+    tags:
+      - "*"
+  workflow_dispatch:
+
+enable-openid-connect: true
+
+jobs:
+  docker:
+    name: Docker Build and Push to git.private.coffee
+    runs-on: docker-privileged
+    container:
+      image: node:22-bookworm
+      options: >-
+        --privileged
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          apt update
+          apt install -y docker.io jq
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Fetch JWT
+        id: jwt
+        env:
+          AUD: u:5:f67ef752-45f6-4a9d-933c-986806a9dc84
+        run: |
+          jwt=$(
+            curl --fail \
+              -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" \
+              "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=$AUD" \
+              | jq -r ".value"
+          )
+          echo "::add-mask::$jwt"
+          echo "jwt=$jwt" >> $FORGEJO_OUTPUT
+
+      - name: Login to Forgejo
+        run: |
+          echo "${{ steps.jwt.outputs.jwt }}" \
+            | docker login --username token --password-stdin git.private.coffee
+
+      - name: Build and push to Forgejo
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          tags: |
+            git.private.coffee/privatecoffee/structables:latest
+            git.private.coffee/privatecoffee/structables:${{ env.GITHUB_REF_NAME }}

{structables-0.4.4 → structables-0.4.6}/Dockerfile

@@ -11,10 +11,13 @@ COPY . /app
 
 RUN $APP_ENV/bin/pip install --no-cache-dir pip && \
   $APP_ENV/bin/pip install /app && \
-  adduser -S -D -H structables
+  adduser -S -D -H structables && \
+  mkdir -p /tmp/structables_cache && chown structables /tmp/structables_cache
 
 EXPOSE 8002
 
 USER structables
 
+STOPSIGNAL SIGQUIT
+
 ENTRYPOINT ["/app/entrypoint.sh"]

{structables-0.4.4 → structables-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: structables
-Version: 0.4.4
+Version: 0.4.6
 Summary: A simple frontend for Instructables
 Project-URL: Homepage, https://git.private.coffee/privatecoffee/structables
 Project-URL: Bug Tracker, https://git.private.coffee/privatecoffee/structables/issues
@@ -675,6 +675,8 @@ Requires-Python: >=3.10
 Requires-Dist: beautifulsoup4
 Requires-Dist: flask
 Requires-Dist: markdown2[all]
+Provides-Extra: dev
+Requires-Dist: ruff; extra == 'dev'
 Description-Content-Type: text/markdown
 
 <img align="right" src="src/structables/static/img/logo.png">
@@ -699,7 +701,6 @@ An open source alternative front-end to Instructables. This is a fork of <a href
 | [structables.private.coffee](https://structables.private.coffee)           | [Private.coffee](https://private.coffee)       | Austria 🇦🇹 🇪🇺    | Main instance |
 | [structables.bloat.cat](https://structables.bloat.cat)                     | [Bloat.cat](https://bloat.cat)                 | Germany 🇩🇪 🇪🇺    |               |
 | [structables.darkness.services](https://structables.darkness.services)     | [Darkness.services](https://darkness.services) | United States 🇺🇸 |               |
-| [structables.franklyflawless.org](https://structables.franklyflawless.org) | [FranklyFlawless](https://franklyflawless.org) | Germany 🇩🇪 🇪🇺    |               |
 
 <!-- END_INSTANCE_LIST -->
 

{structables-0.4.4 → structables-0.4.6}/README.md

@@ -20,7 +20,6 @@ An open source alternative front-end to Instructables. This is a fork of <a href
 | [structables.private.coffee](https://structables.private.coffee)           | [Private.coffee](https://private.coffee)       | Austria 🇦🇹 🇪🇺    | Main instance |
 | [structables.bloat.cat](https://structables.bloat.cat)                     | [Bloat.cat](https://bloat.cat)                 | Germany 🇩🇪 🇪🇺    |               |
 | [structables.darkness.services](https://structables.darkness.services)     | [Darkness.services](https://darkness.services) | United States 🇺🇸 |               |
-| [structables.franklyflawless.org](https://structables.franklyflawless.org) | [FranklyFlawless](https://franklyflawless.org) | Germany 🇩🇪 🇪🇺    |               |
 
 <!-- END_INSTANCE_LIST -->
 

{structables-0.4.4 → structables-0.4.6}/instances.json

@@ -50,15 +50,5 @@
             "url": "https://darkness.services"
         },
         "location": "US"
-    },
-    {
-        "name": "structables.franklyflawless.org",
-        "url": "https://structables.franklyflawless.org",
-        "type": "clearnet",
-        "provider": {
-            "name": "FranklyFlawless",
-            "url": "https://franklyflawless.org"
-        },
-        "location": "DE"
     }
 ]

{structables-0.4.4 → structables-0.4.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "structables"
-version = "0.4.4"
+version = "0.4.6"
 authors = [
   { name="Private.coffee Team", email="support@private.coffee" },
 ]
@@ -23,6 +23,11 @@ dependencies = [
   "markdown2[all]",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "ruff",
+]
+
 [project.scripts]
 structables = "structables.main:main"
 

structables-0.4.6/scripts/create_release.py

@@ -0,0 +1,153 @@
+#!/usr/bin/env python3
+
+import argparse
+import re
+import subprocess
+import sys
+from pathlib import Path
+
+VERSION_PATTERN = re.compile(
+    r'(?m)^(version\s*=\s*")(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(")$'
+)
+PRE_RELEASE_COMMANDS = (
+    ("-m", "ruff", "check", "src", "scripts"),
+    ("-m", "ruff", "format", "--check", "src", "scripts"),
+)
+
+
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description=(
+            "Bump the project version in pyproject.toml and create a release commit "
+            "and tag."
+        )
+    )
+    group = parser.add_mutually_exclusive_group(required=True)
+    group.add_argument(
+        "--major",
+        action="store_true",
+        help="Bump the major version and reset minor/patch.",
+    )
+    group.add_argument(
+        "--minor", action="store_true", help="Bump the minor version and reset patch."
+    )
+    group.add_argument("--patch", action="store_true", help="Bump the patch version.")
+    parser.add_argument(
+        "--skip-checks",
+        "--skip-lint",
+        dest="skip_checks",
+        action="store_true",
+        help="Skip the pre-release checks.",
+    )
+    return parser.parse_args()
+
+
+def run_git(*args: str, repo_root: Path) -> str:
+    result = subprocess.run(
+        ["git", *args],
+        cwd=repo_root,
+        check=True,
+        text=True,
+        capture_output=True,
+    )
+    return result.stdout.strip()
+
+
+def run_python(*args: str, repo_root: Path) -> None:
+    subprocess.run(
+        [sys.executable, *args],
+        cwd=repo_root,
+        check=True,
+    )
+
+
+def ensure_clean_worktree(repo_root: Path) -> None:
+    status = run_git("status", "--short", repo_root=repo_root)
+    if status:
+        raise SystemExit("Working tree is not clean. Commit or stash changes first.")
+
+
+def load_version(pyproject_path: Path) -> tuple[str, tuple[int, int, int]]:
+    content = pyproject_path.read_text(encoding="utf-8")
+    match = VERSION_PATTERN.search(content)
+    if not match:
+        raise SystemExit("Could not find [project] version in pyproject.toml.")
+    version = (
+        int(match.group("major")),
+        int(match.group("minor")),
+        int(match.group("patch")),
+    )
+    return content, version
+
+
+def bump_version(
+    version: tuple[int, int, int], args: argparse.Namespace
+) -> tuple[int, int, int]:
+    major, minor, patch = version
+    if args.major:
+        return major + 1, 0, 0
+    if args.minor:
+        return major, minor + 1, 0
+    return major, minor, patch + 1
+
+
+def write_version(
+    pyproject_path: Path, content: str, new_version: tuple[int, int, int]
+) -> str:
+    version_text = ".".join(str(part) for part in new_version)
+    updated = VERSION_PATTERN.sub(rf"\g<1>{version_text}\g<5>", content, count=1)
+    pyproject_path.write_text(updated, encoding="utf-8")
+    return version_text
+
+
+def ensure_tag_does_not_exist(repo_root: Path, tag_name: str) -> None:
+    if run_git("tag", "--list", tag_name, repo_root=repo_root):
+        raise SystemExit(f"Tag {tag_name} already exists.")
+
+
+def ensure_pre_release_checks_pass(repo_root: Path) -> None:
+    for command in PRE_RELEASE_COMMANDS:
+        try:
+            run_python(*command, repo_root=repo_root)
+        except subprocess.CalledProcessError as exc:
+            raise SystemExit(
+                "Pre-release checks failed. Fix the errors or re-run with --skip-checks."
+            ) from exc
+
+
+def create_release_commit(repo_root: Path, tag_name: str) -> None:
+    run_git("add", "pyproject.toml", repo_root=repo_root)
+    run_git("commit", "-m", f"Release {tag_name}", repo_root=repo_root)
+
+
+def create_tag(repo_root: Path, tag_name: str) -> None:
+    run_git("tag", "-m", f"Release {tag_name}", tag_name, repo_root=repo_root)
+
+
+def main() -> int:
+    args = parse_args()
+    repo_root = Path(__file__).resolve().parent.parent
+    pyproject_path = repo_root / "pyproject.toml"
+
+    ensure_clean_worktree(repo_root)
+    if not args.skip_checks:
+        ensure_pre_release_checks_pass(repo_root)
+    content, current_version = load_version(pyproject_path)
+    new_version = bump_version(current_version, args)
+    version_text = ".".join(str(part) for part in new_version)
+    tag_name = f"v{version_text}"
+    ensure_tag_does_not_exist(repo_root, tag_name)
+    write_version(pyproject_path, content, new_version)
+    create_release_commit(repo_root, tag_name)
+    create_tag(repo_root, tag_name)
+    print(f"Released {tag_name}")
+    return 0
+
+
+if __name__ == "__main__":
+    try:
+        raise SystemExit(main())
+    except subprocess.CalledProcessError as exc:
+        if exc.stderr:
+            print(exc.stderr.strip(), file=sys.stderr)
+        raise SystemExit(exc.returncode) from exc

{structables-0.4.4 → structables-0.4.6}/src/structables/config.py

@@ -1,7 +1,6 @@
+import logging
 import os
 import tempfile
-import logging
-
 from pathlib import Path
 
 from .utils.helpers import get_typesense_api_key
@@ -10,11 +9,11 @@ logger = logging.getLogger(__name__)
 
 
 class Config:
-    DEBUG = os.environ.get("FLASK_DEBUG", os.environ.get("STRUCTABLES_DEBUG", False))
-    PORT = int(os.environ.get("STRUCTABLES_PORT", 8002))
+    DEBUG = os.environ.get("FLASK_DEBUG", os.environ.get("STRUCTABLES_DEBUG"))
+    PORT = int(os.environ.get("STRUCTABLES_PORT", "8002"))
     LISTEN_HOST = os.environ.get("STRUCTABLES_LISTEN_HOST", "127.0.0.1")
     INVIDIOUS = os.environ.get("STRUCTABLES_INVIDIOUS")
-    UNSAFE = os.environ.get("STRUCTABLES_UNSAFE", False)
+    UNSAFE = os.environ.get("STRUCTABLES_UNSAFE")
     PRIVACY_FILE = os.environ.get("STRUCTABLES_PRIVACY_FILE")
     THEME = os.environ.get("STRUCTABLES_THEME", "auto")
     TYPESENSE_API_KEY = get_typesense_api_key()
@@ -39,19 +38,21 @@ class Config:
             CACHE_DIR.mkdir(parents=True, exist_ok=True)
             (CACHE_DIR / "test").write_text("test")
             (CACHE_DIR / "test").unlink()
-        except Exception as e:
-            logger.error(f"Could not create or write to cache directory: {e} - disabling cache")
+        except Exception as e:  # noqa: BLE001
+            logger.error(
+                f"Could not create or write to cache directory: {e} - disabling cache"
+            )
             CACHE_ENABLED = False
             CACHE_DIR = None
 
     CACHE_MAX_AGE = int(
-        os.environ.get("STRUCTABLES_CACHE_MAX_AGE", 60 * 60 * 24 * 7)
+        os.environ.get("STRUCTABLES_CACHE_MAX_AGE", "604800")
     )  # 1 week default
     CACHE_MAX_SIZE = int(
-        os.environ.get("STRUCTABLES_CACHE_MAX_SIZE", 1024 * 1024 * 1024)
+        os.environ.get("STRUCTABLES_CACHE_MAX_SIZE", "1073741824")
     )  # 1GB default
     CACHE_CLEANUP_INTERVAL = int(
-        os.environ.get("STRUCTABLES_CACHE_CLEANUP_INTERVAL", 60 * 60)
+        os.environ.get("STRUCTABLES_CACHE_CLEANUP_INTERVAL", "3600")
     )  # 1 hour default
 
     @staticmethod

{structables-0.4.4 → structables-0.4.6}/src/structables/main.py

@@ -1,8 +1,6 @@
-#!/usr/bin/env python
+import logging
 
 from flask import Flask
-import logging
-import time
 
 from .config import Config
 from .routes import init_routes

{structables-0.4.4 → structables-0.4.6}/src/structables/routes/__init__.py

@@ -1,12 +1,13 @@
-from .main import init_main_routes
 from .category import init_category_routes
+from .contest import init_contest_routes
+from .main import init_main_routes
 from .member import init_member_routes
 from .proxy import init_proxy_routes
-from .contest import init_contest_routes
+
 
 def init_routes(app):
     init_main_routes(app)
     init_category_routes(app)
     init_member_routes(app)
     init_proxy_routes(app)
-    init_contest_routes(app)
+    init_contest_routes(app)

{structables-0.4.4 → structables-0.4.6}/src/structables/routes/category.py

@@ -1,7 +1,9 @@
+import logging
+
 from flask import redirect
 from werkzeug.exceptions import NotFound
-from ..utils.helpers import project_list, category_page
-import logging
+
+from ..utils.helpers import category_page, project_list
 
 logger = logging.getLogger(__name__)
 
@@ -58,6 +60,10 @@ def init_category_routes(app):
         logger.debug("Rendering craft category page")
         return category_page(app, "Craft")
 
+    @app.route("/design/")
+    def route_design():
+        return category_page(app, "Design")
+
     @app.route("/cooking/")
     def route_cooking():
         logger.debug("Rendering cooking category page")

{structables-0.4.4 → structables-0.4.6}/src/structables/routes/contest.py

@@ -1,10 +1,11 @@
-from flask import render_template, request, abort, url_for
-from urllib.request import urlopen, Request
-from urllib.error import HTTPError
-from ..utils.helpers import proxy
-from bs4 import BeautifulSoup
-import json
 import logging
+from urllib.error import HTTPError
+from urllib.parse import urlencode
+
+from flask import abort, render_template, request, url_for
+
+from ..utils.cache import get_cached_json
+from ..utils.helpers import proxy, thumbnail
 
 logger = logging.getLogger(__name__)
 
@@ -20,19 +21,17 @@ def init_contest_routes(app):
         logger.debug(f"Fetching contest archive page {page} with limit {limit}")
 
         try:
-            # Fetch data using urlopen
             url = f"https://www.instructables.com/json-api/getClosedContests?limit={limit}&offset={offset}"
             logger.debug(f"Making request to {url}")
-            response = urlopen(url)
-            data = json.loads(response.read().decode())
+            data = get_cached_json(app, url)
             logger.debug(
                 f"Received contest archive data with {len(data.get('contests', []))} contests"
             )
         except HTTPError as e:
             logger.error(f"HTTP error fetching contest archive: {e.code}")
             abort(e.code)
-        except Exception as e:
-            logger.error(f"Error fetching contest archive: {str(e)}")
+        except Exception as e:  # noqa: BLE001
+            logger.error(f"Error fetching contest archive: {e!s}")
             abort(500)  # Handle other exceptions like JSON decode errors
 
         contests = data.get("contests", [])
@@ -85,9 +84,7 @@ def init_contest_routes(app):
             try:
                 url = f"{base_url}?q=*&filter_by=contestPath:{contest}&sort_by=contestEntryDate:desc&per_page={per_page}&page={page}"
                 logger.debug(f"Making request to {url} (page {page})")
-                request = Request(url, headers=headers)
-                response = urlopen(request)
-                data = json.loads(response.read().decode())
+                data = get_cached_json(app, url, headers=headers)
             except HTTPError as e:
                 logger.error(f"HTTP error fetching contest entries: {e.code}")
                 abort(e.code)
@@ -99,7 +96,7 @@ def init_contest_routes(app):
                 break
 
             all_entries.extend(hits)
-            if len(hits) < per_page:
+            if len(all_entries) >= data["found"]:
                 break
             page += 1
 
@@ -111,32 +108,21 @@ def init_contest_routes(app):
         logger.debug(f"Fetching contest page for: {contest}")
 
         try:
-            data = urlopen(f"https://www.instructables.com/contest/{contest}/")
-            html = data.read().decode()
-            soup = BeautifulSoup(html, "html.parser")
-
-            title_tag = soup.find("h1")
-            title = title_tag.get_text() if title_tag else "Contest"
+            data = get_cached_json(
+                app,
+                "https://www.instructables.com/json-api/contest?"
+                + urlencode({"path": contest}),
+            )
+            title = data["title"]
             logger.debug(f"Contest title: {title}")
 
-            img_tag = soup.find("img", alt=lambda x: x and "Banner" in x)
-            img = img_tag.get("src") if img_tag else "default.jpg"
+            img = proxy(data["bannerUrl"])
 
             logger.debug(f"Fetching entries for contest: {contest}")
             entries = get_entries(contest)
-            entry_count = len(entries)
-            logger.debug(f"Found {entry_count} entries")
-
-            prizes_items = soup.select("article")
-            prizes = len(prizes_items) if prizes_items else 0
-            logger.debug(f"Found {prizes} prizes")
-
-            overview_section = soup.find("section", id="overview")
-            info = (
-                overview_section.decode_contents()
-                if overview_section
-                else "No Overview"
-            )
+            entry_count = data["numEntries"]
+            prizes = data["prizeCount"]
+            info = data.get("bodyFull", "")
 
         except HTTPError as e:
             logger.error(f"HTTP error fetching contest page: {e.code}")
@@ -147,11 +133,11 @@ def init_contest_routes(app):
             doc = entry["document"]
             entry_details = {
                 "link": url_for("route_article", article=doc["urlString"]),
-                "entry_img": doc["coverImageUrl"],
+                "entry_img": thumbnail(doc["coverImageUrl"]),
                 "entry_title": doc["title"],
                 "author": doc["screenName"],
                 "author_link": url_for("route_member", member=doc["screenName"]),
-                "channel": doc["channel"][0],
+                "channel": doc["channel"][0] if doc.get("channel") else "",
                 "channel_link": f"/{doc['primaryClassification']}",
                 "views": doc.get("views", 0),
             }
@@ -173,16 +159,16 @@ def init_contest_routes(app):
 
         try:
             # Fetch current contests from the JSON API
-            response = urlopen(
-                "https://www.instructables.com/json-api/getCurrentContests?limit=50&offset=0"
+            data = get_cached_json(
+                app,
+                "https://www.instructables.com/json-api/getCurrentContests?limit=50&offset=0",
             )
-            data = json.loads(response.read().decode())
             logger.debug("Received current contests data")
         except HTTPError as e:
             logger.error(f"HTTP error fetching current contests: {e.code}")
             abort(e.code)
-        except Exception as e:
-            logger.error(f"Error fetching current contests: {str(e)}")
+        except Exception as e:  # noqa: BLE001
+            logger.error(f"Error fetching current contests: {e!s}")
             abort(500)  # Handle other exceptions such as JSON decode errors
 
         contests = data.get("contests", [])