podpack-qrcode 0.2.1__tar.gz

podpack_qrcode-0.2.1/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.3
+Name: podpack-qrcode
+Version: 0.2.1
+Summary: QR code generation for podpack sites
+Author: Steve Holden
+Author-email: Steve Holden <steve@holdenweb.com>
+Requires-Dist: flask>=3.0
+Requires-Dist: flask-wtf>=1.2.1
+Requires-Dist: qrcode[pil]>=7.4.2
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# podpack-qrcode
+
+A podpack app that turns a piece of text into a QR code, delivered as a GIF.
+
+The distribution is `podpack-qrcode`, the import name (for a site's `apps`
+list) is `podpack_qrcode`, and the app answers to `qrcode` — its blueprint's
+name, which keys `[site.mounts]` and its directories on disk.
+
+## Routes
+
+| Route | What it does |
+| --- | --- |
+| `/qrcode/` (GET) | the form |
+| `/qrcode/` (POST) | the QR code, as `image/gif` |
+
+## What it needs from the site
+
+The form is CSRF-protected by flask-wtf, which uses the `SECRET_KEY` podpack
+already requires — nothing to configure. There is no `[apps.qrcode]` section;
+the app has no settings.

podpack_qrcode-0.2.1/README.md

@@ -0,0 +1,20 @@
+# podpack-qrcode
+
+A podpack app that turns a piece of text into a QR code, delivered as a GIF.
+
+The distribution is `podpack-qrcode`, the import name (for a site's `apps`
+list) is `podpack_qrcode`, and the app answers to `qrcode` — its blueprint's
+name, which keys `[site.mounts]` and its directories on disk.
+
+## Routes
+
+| Route | What it does |
+| --- | --- |
+| `/qrcode/` (GET) | the form |
+| `/qrcode/` (POST) | the QR code, as `image/gif` |
+
+## What it needs from the site
+
+The form is CSRF-protected by flask-wtf, which uses the `SECRET_KEY` podpack
+already requires — nothing to configure. There is no `[apps.qrcode]` section;
+the app has no settings.

podpack_qrcode-0.2.1/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "podpack-qrcode"
+version = "0.2.1"
+description = "QR code generation for podpack sites"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "flask>=3.0",
+    "flask-wtf>=1.2.1",
+    "qrcode[pil]>=7.4.2",
+]
+
+[[project.authors]]
+name = "Steve Holden"
+email = "steve@holdenweb.com"
+
+[build-system]
+requires = ["uv_build>=0.8.4,<0.9.0"]
+build-backend = "uv_build"
+
+# podpack is deliberately absent from `dependencies`: a real dependency's
+# [tool.uv.sources] entry travels with the distribution, so a site whose own
+# podpack source differs could never lock. A dependency group is dev-only
+# metadata and constrains nobody. See writing-an-app.md rule 1.
+[dependency-groups]
+dev = [
+    "podpack",
+    "pytest>=8.0",
+    "mypy>=1.11",
+    "types-qrcode>=8.2.0.20260518",
+    "types-wtforms>=3.2.1.20260518",
+]
+
+[tool.uv.sources]
+# The published repository, not a path. An editable pointer at
+# /Users/sholden/sites/podpack resolved on exactly one machine, put an absolute
+# home directory into a committed lockfile, and made this package unlockable
+# anywhere else. podpack is on GitHub, so a git source needs no checkout at all.
+podpack = { git = "https://github.com/holdenweb/podpack.git" }
+
+[tool.mypy]
+files = ["src", "tests"]
+
+# flask-wtf ships neither stubs nor a py.typed marker, and no types-* package
+# exists for it. Suppressed for that one module rather than globally.
+[[tool.mypy.overrides]]
+module = "flask_wtf.*"
+ignore_missing_imports = true

podpack_qrcode-0.2.1/src/podpack_qrcode/__init__.py

@@ -0,0 +1,15 @@
+"""The qrcode app: turn a piece of text into a QR code image."""
+
+from podpack import Section, SiteApp
+
+from .views import blueprint
+
+site_app = SiteApp(
+    blueprint=blueprint,
+    url_prefix="/qrcode",
+    # `qrcode.form`, not `podpack_qrcode.form`: nav names an *endpoint*, and
+    # endpoints carry the blueprint's name, which is this app's name (ADR-0003).
+    # `podpack_qrcode` is only the import name -- what a site's `apps` list
+    # carries -- and the two differ deliberately.
+    nav=(Section("QR codes", "qrcode.form"),),
+)

podpack_qrcode-0.2.1/src/podpack_qrcode/forms.py

@@ -0,0 +1,7 @@
+from flask_wtf import FlaskForm
+from wtforms import StringField, SubmitField
+
+
+class QRCodeForm(FlaskForm):
+    qrcode_text = StringField("qrcode_text")
+    submit = SubmitField("Get QR Code")

podpack_qrcode-0.2.1/src/podpack_qrcode/templates/qrcode/form.html

@@ -0,0 +1,32 @@
+{% extends "base.html" %}
+
+{% block content %}
+<div class="col-5">
+  <h1>QR Code Generator</h1>
+  <form class="form-horizontal" method="post" enctype="multipart/form-data">
+    <fieldset>
+    {{ form.hidden_tag() }}
+
+    <!-- Form Name -->
+    <legend>QR Code Generator</legend>
+    <p>Enter the text you want in the QR code
+    and it will be displayed as a GIF file.</p>
+
+    <!-- File Button -->
+    <div class="control-group">
+      <label class="control-label" for="qrcode_text">QR code text</label>
+      <div class="controls">
+        {{ form.qrcode_text(size=32) }}
+      </div>
+    </div>
+
+    <!-- Button -->
+    <div class="control-group">
+      <label class="control-label" for="sbutton">Get QR Code</label>
+      <div class="controls">
+        {{ form.submit() }}
+    </div>
+    </fieldset>
+  </form>
+</div>
+{% endblock %}

podpack_qrcode-0.2.1/src/podpack_qrcode/views.py

@@ -0,0 +1,30 @@
+"""One form, one image: the QR code generator."""
+
+import io
+from logging import getLogger
+
+import qrcode
+from flask import Blueprint, Response, render_template, request
+from flask.typing import ResponseReturnValue
+from qrcode.image.pil import PilImage
+
+from .forms import QRCodeForm
+
+logger = getLogger(__name__)
+
+blueprint = Blueprint("qrcode", __name__, template_folder="templates")
+
+
+@blueprint.route("/", methods=["GET", "POST"])
+def form() -> ResponseReturnValue:
+    form = QRCodeForm()
+    if form.validate_on_submit():
+        text = request.form["qrcode_text"]
+        # The PIL factory named explicitly: qrcode falls back to a PyPNG-backed
+        # image without Pillow, whose save() cannot produce the GIF promised.
+        image = qrcode.make(text, image_factory=PilImage)
+        memfile = io.BytesIO()
+        image.save(memfile, format="GIF")
+        logger.info("generated a QR code of %d characters", len(text))
+        return Response(memfile.getvalue(), mimetype="image/gif")
+    return render_template("qrcode/form.html", form=form, title="QR Code Generator")