qrpipe 0.1.0__tar.gz

qrpipe-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  checks:
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12", "3.13", "3.14"]
+
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip && python -m pip install -e ".[dev]"
+
+      - name: Run quality gates
+        run: python -m scripts.ci

qrpipe-0.1.0/.github/workflows/publish-testpypi.yml

@@ -0,0 +1,34 @@
+name: Publish to TestPyPI
+
+on:
+  workflow_dispatch:
+
+permissions: {}
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/qrpipe
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Build distributions
+        run: python -m pip install --upgrade build twine && python -m build && python -m twine check dist/*
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

qrpipe-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions: {}
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/qrpipe
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Check out release tag
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.release.tag_name }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Build distributions
+        run: python -m pip install --upgrade build twine && python -m build && python -m twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

qrpipe-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+.idea/
+.pytest_cache/
+.ruff_cache/
+.coverage
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/

qrpipe-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-pep8-blank-lines
+        name: Ruff PEP 8 blank lines
+        entry: ruff check --preview --select E302,E305
+        language: python
+        additional_dependencies: ["ruff>=0.11"]
+        types_or: [python, pyi]
+      - id: ruff-check
+        name: Ruff lint
+        entry: ruff check
+        language: python
+        additional_dependencies: ["ruff>=0.11"]
+        types_or: [python, pyi]
+      - id: ruff-format
+        name: Ruff format
+        entry: ruff format --check
+        language: python
+        additional_dependencies: ["ruff>=0.11"]
+        types_or: [python, pyi]
+      - id: rumdl
+        name: Markdown lint
+        entry: rumdl check
+        language: python
+        additional_dependencies: ["rumdl>=0.1"]
+        files: \.(md|mdx)$

qrpipe-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

qrpipe-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.1.0 - 2026-09-10
+
+- Read QR payloads from standard input or one positional argument.
+- Strip exactly one shell-added trailing line ending by default.
+- Render compact terminal QR codes.
+- Save QR codes through Segno using an output filename extension.
+- Provide typed CLI boundaries, tests, Ruff, Pyright, and pytest configuration.
+- Add exact QR redundancy, module size, atomic file writes, and TTY-safe input handling.
+- Add `phone` and `vcard` payload types for scanner-friendly structured QR content.
+- Add opt-in `--open` support for launching saved images in the system viewer.

qrpipe-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Rick
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

qrpipe-0.1.0/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.4
+Name: qrpipe
+Version: 0.1.0
+Summary: Turn piped input into a terminal or file-based QR code.
+Author: Rick
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sheepfling/qrpipe
+Project-URL: Source, https://github.com/sheepfling/qrpipe
+Project-URL: Issues, https://github.com/sheepfling/qrpipe/issues
+Keywords: cli,qr,qrcode,terminal,unix
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: segno<2,>=1.6.6
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: pre-commit>=4; extra == "dev"
+Requires-Dist: pyright>=1.1.400; extra == "dev"
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-cov>=6; extra == "dev"
+Requires-Dist: ruff>=0.11; extra == "dev"
+Requires-Dist: rumdl>=0.1; extra == "dev"
+Requires-Dist: twine>=6; extra == "dev"
+Dynamic: license-file
+
+# qrpipe
+
+`qrpipe` turns piped input into a QR code or QR image.
+
+The smallest useful interaction is:
+
+```shell
+printf '%s' 'https://example.com' | qrpipe
+```
+
+By default, `qrpipe` renders a compact QR code in the terminal. With `--output`, it writes a
+file whose format is inferred from the extension by Segno.
+
+## Install for development
+
+```console
+python3.12 -m venv .venv
+.venv/bin/python -m pip install -e '.[dev]'
+.venv/bin/qrpipe --help
+```
+
+## Examples
+
+```console
+printf '%s' 'https://example.com' | qrpipe
+echo 'https://example.com' | qrpipe
+cat payload.txt | qrpipe
+qrpipe 'https://example.com'
+printf '%s' 'https://example.com' | qrpipe --output example.png --size 8
+printf '%s' 'https://example.com' | qrpipe -o example.svg --size 4
+printf '%s' 'https://example.com' | qrpipe -o example.png --open
+printf '%s' 'important payload' | qrpipe --redundancy H
+```
+
+`--size` controls the output module scale; `--scale` is an alias. `--redundancy` (also
+`--error`) selects the exact QR error-correction level: `L`, `M`, `Q`, or `H`. `--open` is an
+explicit opt-in that opens an image file with the operating system's default viewer; it requires
+`--output`.
+
+## Structured payloads
+
+The default `--type text` leaves the payload unchanged. `--type phone` converts a human-readable
+number into a `tel:` URI:
+
+```console
+printf '%s\n' '+1 (555) 010-1234' | qrpipe --type phone -o phone.png
+```
+
+`--type vcard` accepts a complete vCard, common property lines (`FN:`, `TEL:`, `EMAIL:`, `ORG:`),
+or a plain name, which becomes a minimal vCard:
+
+```console
+printf '%s' 'Ada Lovelace' | qrpipe --type vcard -o ada.svg
+printf '%s\n' 'FN:Ada Lovelace' 'EMAIL:ada@example.test' | qrpipe --type vcard -o ada.svg
+```
+
+Structured payloads must be UTF-8. Ordinary text input is read as bytes and passed to Segno
+without a decode/re-encode round trip.
+
+## Input and output semantics
+
+- A positional `DATA` value takes precedence over standard input and is treated literally.
+- When reading standard input, exactly one final `\n` or `\r\n` is removed by default. Use
+  `--preserve-newline` when that line ending is meaningful payload data.
+- Empty input exits with status `2`; whitespace is valid data.
+- Running `qrpipe` with no argument on an interactive terminal exits immediately with guidance
+  instead of waiting forever for EOF.
+- File output is written beside the destination and atomically replaces an existing destination.
+- PNG and SVG are the normal file formats; Segno also supports other formats selected by extension.
+
+Successful terminal output contains only the QR rendering. Diagnostics never include the original
+payload, which matters for URLs with tokens, Wi-Fi credentials, OTP setup URIs, and other secrets.
+
+## Deliberate boundaries
+
+qrpipe always creates ordinary QR codes. Micro QR, structured-append sequences, explicit Segno
+encoding modes, and additional helper formats such as Wi-Fi, email, geo, MeCard, and EPC payment
+QR are intentionally outside this small initial interface.
+
+## Development
+
+```console
+.venv/bin/python -m scripts.ci
+```
+
+This runs compilation, Ruff, branch coverage, build/metadata checks, Pyright, Markdown linting,
+and pre-commit. GitHub Actions runs the same gates on Ubuntu, macOS, and Windows with Python 3.12,
+3.13, and 3.14.
+
+## Releasing
+
+1. Push the release commit and wait for CI to pass.
+2. Configure PyPI and TestPyPI trusted publishers for this repository's corresponding workflows.
+3. Tag that commit as `v0.1.0` and push the tag.
+4. Run **Publish to TestPyPI** from GitHub Actions against the tag and install the result in a
+   fresh environment.
+5. Create a GitHub release from the same tag to publish to PyPI.
+
+## License
+
+MIT. See `LICENSE`.

qrpipe-0.1.0/README.md

@@ -0,0 +1,101 @@
+# qrpipe
+
+`qrpipe` turns piped input into a QR code or QR image.
+
+The smallest useful interaction is:
+
+```shell
+printf '%s' 'https://example.com' | qrpipe
+```
+
+By default, `qrpipe` renders a compact QR code in the terminal. With `--output`, it writes a
+file whose format is inferred from the extension by Segno.
+
+## Install for development
+
+```console
+python3.12 -m venv .venv
+.venv/bin/python -m pip install -e '.[dev]'
+.venv/bin/qrpipe --help
+```
+
+## Examples
+
+```console
+printf '%s' 'https://example.com' | qrpipe
+echo 'https://example.com' | qrpipe
+cat payload.txt | qrpipe
+qrpipe 'https://example.com'
+printf '%s' 'https://example.com' | qrpipe --output example.png --size 8
+printf '%s' 'https://example.com' | qrpipe -o example.svg --size 4
+printf '%s' 'https://example.com' | qrpipe -o example.png --open
+printf '%s' 'important payload' | qrpipe --redundancy H
+```
+
+`--size` controls the output module scale; `--scale` is an alias. `--redundancy` (also
+`--error`) selects the exact QR error-correction level: `L`, `M`, `Q`, or `H`. `--open` is an
+explicit opt-in that opens an image file with the operating system's default viewer; it requires
+`--output`.
+
+## Structured payloads
+
+The default `--type text` leaves the payload unchanged. `--type phone` converts a human-readable
+number into a `tel:` URI:
+
+```console
+printf '%s\n' '+1 (555) 010-1234' | qrpipe --type phone -o phone.png
+```
+
+`--type vcard` accepts a complete vCard, common property lines (`FN:`, `TEL:`, `EMAIL:`, `ORG:`),
+or a plain name, which becomes a minimal vCard:
+
+```console
+printf '%s' 'Ada Lovelace' | qrpipe --type vcard -o ada.svg
+printf '%s\n' 'FN:Ada Lovelace' 'EMAIL:ada@example.test' | qrpipe --type vcard -o ada.svg
+```
+
+Structured payloads must be UTF-8. Ordinary text input is read as bytes and passed to Segno
+without a decode/re-encode round trip.
+
+## Input and output semantics
+
+- A positional `DATA` value takes precedence over standard input and is treated literally.
+- When reading standard input, exactly one final `\n` or `\r\n` is removed by default. Use
+  `--preserve-newline` when that line ending is meaningful payload data.
+- Empty input exits with status `2`; whitespace is valid data.
+- Running `qrpipe` with no argument on an interactive terminal exits immediately with guidance
+  instead of waiting forever for EOF.
+- File output is written beside the destination and atomically replaces an existing destination.
+- PNG and SVG are the normal file formats; Segno also supports other formats selected by extension.
+
+Successful terminal output contains only the QR rendering. Diagnostics never include the original
+payload, which matters for URLs with tokens, Wi-Fi credentials, OTP setup URIs, and other secrets.
+
+## Deliberate boundaries
+
+qrpipe always creates ordinary QR codes. Micro QR, structured-append sequences, explicit Segno
+encoding modes, and additional helper formats such as Wi-Fi, email, geo, MeCard, and EPC payment
+QR are intentionally outside this small initial interface.
+
+## Development
+
+```console
+.venv/bin/python -m scripts.ci
+```
+
+This runs compilation, Ruff, branch coverage, build/metadata checks, Pyright, Markdown linting,
+and pre-commit. GitHub Actions runs the same gates on Ubuntu, macOS, and Windows with Python 3.12,
+3.13, and 3.14.
+
+## Releasing
+
+1. Push the release commit and wait for CI to pass.
+2. Configure PyPI and TestPyPI trusted publishers for this repository's corresponding workflows.
+3. Tag that commit as `v0.1.0` and push the tag.
+4. Run **Publish to TestPyPI** from GitHub Actions against the tag and install the result in a
+   fresh environment.
+5. Create a GitHub release from the same tag to publish to PyPI.
+
+## License
+
+MIT. See `LICENSE`.

qrpipe-0.1.0/pyproject.toml

@@ -0,0 +1,118 @@
+[build-system]
+requires = ["setuptools>=77", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "qrpipe"
+dynamic = ["version"]
+description = "Turn piped input into a terminal or file-based QR code."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+authors = [{ name = "Rick" }]
+keywords = ["cli", "qr", "qrcode", "terminal", "unix"]
+dependencies = [
+    "segno>=1.6.6,<2",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Utilities",
+]
+
+[project.urls]
+Homepage = "https://github.com/sheepfling/qrpipe"
+Source = "https://github.com/sheepfling/qrpipe"
+Issues = "https://github.com/sheepfling/qrpipe/issues"
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2",
+    "pre-commit>=4",
+    "pyright>=1.1.400",
+    "pytest>=8.3",
+    "pytest-cov>=6",
+    "ruff>=0.11",
+    "rumdl>=0.1",
+    "twine>=6",
+]
+
+[project.scripts]
+qrpipe = "qrpipe.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+qrpipe = ["py.typed"]
+
+[tool.setuptools_scm]
+version_scheme = "no-guess-dev"
+fallback_version = "0.1.0"
+
+[tool.pytest.ini_options]
+addopts = "-ra --strict-config --strict-markers"
+testpaths = ["tests"]
+
+[tool.pyright]
+include = ["src", "scripts", "tests"]
+exclude = [".venv"]
+pythonVersion = "3.12"
+pythonPlatform = "All"
+typeCheckingMode = "strict"
+venvPath = "."
+venv = ".venv"
+reportUnnecessaryTypeIgnoreComment = "error"
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    "A",
+    "ANN",
+    "ARG",
+    "B",
+    "C4",
+    "E",
+    "F",
+    "I",
+    "N",
+    "PERF",
+    "PIE",
+    "PL",
+    "PTH",
+    "RET",
+    "RUF",
+    "SIM",
+    "TRY",
+    "UP",
+    "W",
+]
+ignore = [
+    "ANN401",
+    "TRY003",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["PLR2004", "S101"]
+
+[tool.coverage.run]
+branch = true
+source = ["qrpipe"]
+
+[tool.coverage.report]
+fail_under = 95
+show_missing = true
+skip_covered = true
+
+[tool.rumdl]
+line-length = 100
+exclude = [".git", ".github", "build", "dist", "node_modules", "vendor"]
+respect-gitignore = true

qrpipe-0.1.0/scripts/__init__.py

@@ -0,0 +1 @@
+"""Local development and continuous-integration helpers."""

qrpipe-0.1.0/scripts/ci.py

@@ -0,0 +1,64 @@
+"""Run the repository quality gates in the hosted-CI order."""
+
+from __future__ import annotations
+
+import os
+import subprocess
+import sys
+import sysconfig
+from collections.abc import Sequence
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+ROOT = Path(__file__).resolve().parents[1]
+
+
+def _run(command: Sequence[str], *, cwd: Path = ROOT) -> None:
+    """Run one quality gate and stop immediately if it fails."""
+    print("+", " ".join(command), flush=True)
+    scripts_directory = Path(sysconfig.get_path("scripts"))
+    environment = os.environ | {
+        "PATH": os.pathsep.join(
+            (str(scripts_directory), str(Path(sys.executable).parent), os.environ.get("PATH", ""))
+        )
+    }
+    subprocess.run(command, check=True, cwd=cwd, env=environment)
+
+
+def _check_distributions(python: str) -> None:
+    """Build isolated distributions and validate their core metadata."""
+    with TemporaryDirectory(prefix="qrpipe-build-") as temporary_directory:
+        artifacts = Path(temporary_directory)
+        _run([python, "-m", "build", "--outdir", str(artifacts)])
+        distributions = sorted(artifacts.iterdir())
+        _run([python, "-m", "twine", "check", *(str(path) for path in distributions)])
+
+
+def _environment_tool(python: str, name: str) -> str:
+    """Return a tool installed beside the selected interpreter."""
+    scripts_directory = Path(sysconfig.get_path("scripts"))
+    return str(scripts_directory / f"{name}{Path(python).suffix}")
+
+
+def main() -> int:
+    """Run all local quality gates."""
+    python = sys.executable
+    commands = (
+        [python, "-m", "compileall", "-q", "src", "scripts", "tests"],
+        [python, "-m", "ruff", "check", "--preview", "--select", "E302,E305", "."],
+        [python, "-m", "ruff", "check", "."],
+        [python, "-m", "ruff", "format", "--check", "."],
+        [python, "-m", "pytest", "--cov=qrpipe", "--cov-branch"],
+    )
+    for command in commands:
+        _run(command)
+
+    _check_distributions(python)
+    _run([python, "-m", "pyright"])
+    _run([_environment_tool(python, "rumdl"), "check", "README.md", "CHANGELOG.md"])
+    _run([python, "-m", "pre_commit", "run", "--all-files"])
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

qrpipe-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

qrpipe-0.1.0/src/qrpipe/__init__.py

@@ -0,0 +1,12 @@
+"""Pipe text into a QR code."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("qrpipe")
+except PackageNotFoundError:
+    __version__ = "0.0.0+unknown"
+
+__all__ = ["__version__"]

qrpipe-0.1.0/src/qrpipe/__main__.py

@@ -0,0 +1,8 @@
+"""Support ``python -m qrpipe``."""
+
+from __future__ import annotations
+
+from qrpipe.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())