qrref 0.1.0__tar.gz

qrref-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+*.pdf
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+.vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

qrref-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Truls Henriksson
+
+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.

qrref-0.1.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: qrref
+Version: 0.1.0
+Summary: QR code generator with a command-line interface for showing, saving and copying generated QR codes.
+Project-URL: Homepage, https://github.com/TrulsHenriksson/qrref/
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: pillow
+Provides-Extra: copy
+Requires-Dist: pyperclipimg; extra == 'copy'
+Description-Content-Type: text/markdown
+
+# qrref
+
+Python package and reference implementation of the ISO/IEC 18004:2015 Standard for QR codes, with a simple but convenient CLI for showing, saving and copying generated QR codes.
+
+![Sample QR code](sample_qr_code.png)
+
+# Purpose
+
+This is first and foremost a reference implementation, meaning I wanted the code to be readable and well-documented, without lots of magic numbers and tables copied straight from the specification. For those wanting to implement their own QR code generator, or extending one to suit their needs (custom colors, styles, inset images, etc.) this should be a good basis.
+
+Wherever possible, I've chosen to implement the table data as functions instead. This doesn't result in the shortest or fastest implementation, but should explain where the numbers come from better.
+
+The priorities of this project have been as follows, in approximate order of importance.
+1. **Referentiability.** The code should adhere closely to the specification.
+    - Most functions and tables are accompanied by comments referencing where they can be found in the specification. Look up "ISO/IEC 18004" and you can probably find it somewhere.
+2. **Clarity.** The code should be easy to read and understand.
+    - Comments and docstrings are mandatory.
+    - The code is split up into files with clearly different responsibilities, and should be understandable (mostly) on their own.
+3. **Transparency.** Table data should be generated by functions wherever possible. 
+    - The implementation could be made shorter by hard-coding certain parts, most notably the coefficients of the generating polynomials for the Solomon-Reed code. This is against the spirit of this project though.
+    - Table data is still preferred where a function would be less clear.
+4. **Efficiency.** Looping over the entire symbol in Python should be avoided.
+    - NumPy is used extensively to speed up generation.
+
+# Usage
+
+Install by running
+```bash
+$ pip install qrref
+```
+or to also be able to copy QR codes directly to the clipboard, by running
+```bash
+$ pip install qrref[copy]
+```
+This is an optional dependency, since it uses `pyperclipimg` which states in its README: "This module is separate [from pyperclip] because it has some heavy dependencies (pywin32, Quartz, etc.)" Without it, you can still show and save QR codes as png.
+
+You can then `import qrref` and use `qrref.generate_qr_code` in your own code, or use the command-line interface (CLI) directly.
+
+## Examples
+
+Show a QR code with the message "This is a QR code". This is done using Matplotlib, which means that "F" toggles fullscreen and "Q" closes the window. Perfect for quickly throwing up a QR code on a big screen.
+```bash
+$ py -m qrref "This is a QR code"
+```
+Save the QR code to `./wikipedia_qr.png`:
+```bash
+$ py -m qrref "https://wikipedia.org" --png --filename wikipedia_qr
+```
+Copy the QR code to the clipboard (requires installing with `pip install qrref[copy]`):
+```bash
+$ py -m qrref "https://wikipedia.org" --copy
+```
+
+# Reference details
+
+The generation of a QR code is handled by `qrref.qr.generate_qr_code`. This function is fairly readable and illustrates the process from start to finish:
+
+```python
+def generate_qr_code(
+    content: str, 
+    ec_level: Literal["L", "M", "Q", "H"], 
+    version: int | None = None,
+):
+    if version is None:
+        version, modes = select_version(content, ec_level)
+    else:
+        modes = select_modes(content, version)
+
+    bitstream = encode_mixed(modes, version)
+    bytestream = to_data_bytestream(bitstream, version, ec_level)
+    blockstream = generate_error_correction_blocks(bytestream, version, ec_level)
+    final_bytestream = interleave_blocks(blockstream, version, ec_level)
+
+    symbol = place_bytestream(final_bytestream, version)
+    insert_timing_patterns(symbol)
+    insert_finder_patterns(symbol)
+    insert_alignment_patterns(symbol, version)
+
+    symbol, mask_pattern_id = apply_mask(symbol, version)
+
+    place_format_bits(symbol, generate_format_bits(ec_level, mask_pattern_id))
+    if version >= 7:
+        place_version_bits(symbol, generate_version_bits(version))
+
+    symbol = expand_quiet_region(symbol)
+    return symbol
+```
+
+This uses functions split up over several files. Here's a high-level overview of what each file does, in the order they are used in the above function.
+1. `qrref/data_analysis.py`: Select the minimum version (qr code size) that the content (input string) fits in. Also select the encoding types that minimizes the length of the data bitstream (numeric data is denser than alphanumeric data, which is denser than byte data).
+2. `qrref/data_encoding.py`: Encode the message into a bitstream and group the bits together into bytes.
+3. `qrref/error_correction.py`: Generate error correction bytes using the Reed-Solomon codes. In practice, does this by finding polynomial remainders over the Galois Field of order 256 ([wikipedia](https://en.wikipedia.org/wiki/Finite_field_arithmetic)), which also uses `qrref/galois_field.py`. Turn the resulting data and error correction bytes into a bitstream by splitting them into blocks and interleaving those blocks. Also generate the format and version bits after the masking is complete.
+4. `qrref/placement.py`: Place the finalized bitstream into the symbol, as well as finder, alignment and timing patterns. After the format and version bits are generated, place those too.
+5. `qrref/masking.py`: Find and apply the mask that minimizes undesirable patterns, like long runs of the same color, etc. This is done after placing everything but the format and version bits in the symbol.
+
+Auxiliary files:
+1. `qrref/custom_types.py`: Custom types for type hinting throughout the package.
+2. `qrref/qr.py`: Assemble and visualize the QR code.
+3. `qrref/settings.py`: Global settings. Currently only one, which is the encoding to use for byte strings (Latin-1 or UTF-8).
+4. `qrref/table_data.py`: Data from tables, either in the form of dictionaries or functions.

qrref-0.1.0/README.md

@@ -0,0 +1,100 @@
+# qrref
+
+Python package and reference implementation of the ISO/IEC 18004:2015 Standard for QR codes, with a simple but convenient CLI for showing, saving and copying generated QR codes.
+
+![Sample QR code](sample_qr_code.png)
+
+# Purpose
+
+This is first and foremost a reference implementation, meaning I wanted the code to be readable and well-documented, without lots of magic numbers and tables copied straight from the specification. For those wanting to implement their own QR code generator, or extending one to suit their needs (custom colors, styles, inset images, etc.) this should be a good basis.
+
+Wherever possible, I've chosen to implement the table data as functions instead. This doesn't result in the shortest or fastest implementation, but should explain where the numbers come from better.
+
+The priorities of this project have been as follows, in approximate order of importance.
+1. **Referentiability.** The code should adhere closely to the specification.
+    - Most functions and tables are accompanied by comments referencing where they can be found in the specification. Look up "ISO/IEC 18004" and you can probably find it somewhere.
+2. **Clarity.** The code should be easy to read and understand.
+    - Comments and docstrings are mandatory.
+    - The code is split up into files with clearly different responsibilities, and should be understandable (mostly) on their own.
+3. **Transparency.** Table data should be generated by functions wherever possible. 
+    - The implementation could be made shorter by hard-coding certain parts, most notably the coefficients of the generating polynomials for the Solomon-Reed code. This is against the spirit of this project though.
+    - Table data is still preferred where a function would be less clear.
+4. **Efficiency.** Looping over the entire symbol in Python should be avoided.
+    - NumPy is used extensively to speed up generation.
+
+# Usage
+
+Install by running
+```bash
+$ pip install qrref
+```
+or to also be able to copy QR codes directly to the clipboard, by running
+```bash
+$ pip install qrref[copy]
+```
+This is an optional dependency, since it uses `pyperclipimg` which states in its README: "This module is separate [from pyperclip] because it has some heavy dependencies (pywin32, Quartz, etc.)" Without it, you can still show and save QR codes as png.
+
+You can then `import qrref` and use `qrref.generate_qr_code` in your own code, or use the command-line interface (CLI) directly.
+
+## Examples
+
+Show a QR code with the message "This is a QR code". This is done using Matplotlib, which means that "F" toggles fullscreen and "Q" closes the window. Perfect for quickly throwing up a QR code on a big screen.
+```bash
+$ py -m qrref "This is a QR code"
+```
+Save the QR code to `./wikipedia_qr.png`:
+```bash
+$ py -m qrref "https://wikipedia.org" --png --filename wikipedia_qr
+```
+Copy the QR code to the clipboard (requires installing with `pip install qrref[copy]`):
+```bash
+$ py -m qrref "https://wikipedia.org" --copy
+```
+
+# Reference details
+
+The generation of a QR code is handled by `qrref.qr.generate_qr_code`. This function is fairly readable and illustrates the process from start to finish:
+
+```python
+def generate_qr_code(
+    content: str, 
+    ec_level: Literal["L", "M", "Q", "H"], 
+    version: int | None = None,
+):
+    if version is None:
+        version, modes = select_version(content, ec_level)
+    else:
+        modes = select_modes(content, version)
+
+    bitstream = encode_mixed(modes, version)
+    bytestream = to_data_bytestream(bitstream, version, ec_level)
+    blockstream = generate_error_correction_blocks(bytestream, version, ec_level)
+    final_bytestream = interleave_blocks(blockstream, version, ec_level)
+
+    symbol = place_bytestream(final_bytestream, version)
+    insert_timing_patterns(symbol)
+    insert_finder_patterns(symbol)
+    insert_alignment_patterns(symbol, version)
+
+    symbol, mask_pattern_id = apply_mask(symbol, version)
+
+    place_format_bits(symbol, generate_format_bits(ec_level, mask_pattern_id))
+    if version >= 7:
+        place_version_bits(symbol, generate_version_bits(version))
+
+    symbol = expand_quiet_region(symbol)
+    return symbol
+```
+
+This uses functions split up over several files. Here's a high-level overview of what each file does, in the order they are used in the above function.
+1. `qrref/data_analysis.py`: Select the minimum version (qr code size) that the content (input string) fits in. Also select the encoding types that minimizes the length of the data bitstream (numeric data is denser than alphanumeric data, which is denser than byte data).
+2. `qrref/data_encoding.py`: Encode the message into a bitstream and group the bits together into bytes.
+3. `qrref/error_correction.py`: Generate error correction bytes using the Reed-Solomon codes. In practice, does this by finding polynomial remainders over the Galois Field of order 256 ([wikipedia](https://en.wikipedia.org/wiki/Finite_field_arithmetic)), which also uses `qrref/galois_field.py`. Turn the resulting data and error correction bytes into a bitstream by splitting them into blocks and interleaving those blocks. Also generate the format and version bits after the masking is complete.
+4. `qrref/placement.py`: Place the finalized bitstream into the symbol, as well as finder, alignment and timing patterns. After the format and version bits are generated, place those too.
+5. `qrref/masking.py`: Find and apply the mask that minimizes undesirable patterns, like long runs of the same color, etc. This is done after placing everything but the format and version bits in the symbol.
+
+Auxiliary files:
+1. `qrref/custom_types.py`: Custom types for type hinting throughout the package.
+2. `qrref/qr.py`: Assemble and visualize the QR code.
+3. `qrref/settings.py`: Global settings. Currently only one, which is the encoding to use for byte strings (Latin-1 or UTF-8).
+4. `qrref/table_data.py`: Data from tables, either in the form of dictionaries or functions.

qrref-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "qrref"
+version = "0.1.0"
+description = "QR code generator with a command-line interface for showing, saving and copying generated QR codes."
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+  "numpy",
+  "matplotlib",
+  "pillow",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/TrulsHenriksson/qrref/"
+
+[project.optional-dependencies]
+copy = [
+  "pyperclipimg"
+]

qrref-0.1.0/qrref/__init__.py

@@ -0,0 +1,8 @@
+from qrref.qr import generate_qr_code, show_qr_code, save_qr_code
+
+
+__all__ = [
+    "generate_qr_code",
+    "show_qr_code",
+    "save_qr_code",
+]

qrref-0.1.0/qrref/__main__.py

@@ -0,0 +1,76 @@
+import argparse
+
+from qrref.settings import SETTINGS
+from qrref.qr import (
+    generate_qr_code,
+    show_qr_code,
+    save_qr_code,
+    copy_qr_code,
+)
+
+
+# Create the parser
+parser = argparse.ArgumentParser(description="Create a QR code and save, show or copy it.")
+parser.add_argument("content", nargs="?", help="What to encode in the QR code", default="https://youtu.be/NR1TdhpCfcY")
+
+ec_levels = parser.add_argument_group("Error correction level").add_mutually_exclusive_group()
+ec_levels.add_argument("-L", action="store_true", help="Low: 7 percent error correction")
+ec_levels.add_argument("-M", action="store_true", help="Medium: 15 percent error correction (default)")
+ec_levels.add_argument("-Q", action="store_true", help="Quartile: 25 percent error correction")
+ec_levels.add_argument("-H", action="store_true", help="High: 30 percent error correction")
+
+parser.add_argument(
+    "-v",
+    "--version",
+    type=int,
+    default=0,
+    help=(
+        "Which version (size) of QR code to use. By default, chooses the smallest one"
+        " that the content fits in."
+    ),
+)
+
+formats = parser.add_argument_group("How to save the QR code").add_mutually_exclusive_group()
+formats.add_argument("--png", action="store_true", help="As PNG")
+formats.add_argument("--show", action="store_true", help="Show without saving (default)")
+formats.add_argument("--copy", action="store_true", help="Copy image to clipboard")
+
+parser.add_argument("-f", "--filename", help="Filename to save with", default="qr_code")
+parser.add_argument("-t", "--transparent", action="store_true", help="Use transparent background")
+parser.add_argument("-u", "--utf-8" , action="store_true", help="Use UTF-8 instead of Latin-1 encoding")
+parser.add_argument("--debug", action="store_true", help="Show debug output")
+
+
+if __name__ == "__main__":
+    args = parser.parse_args()
+    if args.utf_8:
+        SETTINGS.byte_encoding = "utf-8"
+
+    # Find the selected ec_level, otherwise use "M"
+    for ec_level, flag in zip(("L", "M", "Q", "H"), (args.L, args.M, args.Q, args.H)):
+        if flag:
+            break
+    else:
+        ec_level = "M"
+
+    # Find the selected format, otherwise use "show"
+    for format, flag in zip(("png", "show", "copy"), (args.png, args.show, args.copy)):
+        if flag:
+            break
+    else:
+        format = "show"
+
+
+    version = args.version if 1 <= args.version <= 40 else None
+    symbol = generate_qr_code(args.content, ec_level, version, debug=args.debug)
+
+    match format:
+        case "show":
+            show_qr_code(symbol)
+        case "png":
+            file_path = args.filename + "." + format
+            save_qr_code(symbol, file_path, args.transparent)
+            print(f"QR code successfully saved to {file_path}.")
+        case "copy":
+            copy_qr_code(symbol, args.transparent)
+            print("QR code succesfully copied to clipboard.")

qrref-0.1.0/qrref/custom_types.py

@@ -0,0 +1,51 @@
+import numpy as np
+
+from typing import Generator, Sequence, Literal, Iterable, Callable, Protocol
+
+
+__all__ = [
+    "Bit",
+    "Byte",
+    "Mode",
+    "ErrorCorrectionLevel",
+    "Symbol",
+    "FieldElement",
+    "Generator",
+    "Sequence",
+    "Literal",
+    "Iterable",
+    "Callable",
+    "to_bits",
+    "to_byte",
+]
+
+
+class FieldElement[T](Protocol):
+    def __add__(self: T, other: T, /) -> T: ...
+    def __sub__(self: T, other: T, /) -> T: ...
+    def __mul__(self: T, other: T, /) -> T: ...
+    def __truediv__(self: T, other: T, /) -> T: ...
+
+
+type Bit = Literal[0, 1]
+type Byte = int  # 0-255
+type Mode = Literal["numeric", "alphanumeric", "byte"]
+type ErrorCorrectionLevel = Literal["L", "M", "Q", "H"]
+type Symbol = np.ndarray[tuple[int, int], np.dtype[np.bool]]
+
+
+def to_bits(value: int, length: int) -> Generator[Bit]:
+    """Generate the lowest `length` bits of `value`, highest bit first."""
+    if length < 1:
+        raise ValueError("length must be positive")
+    bit_position = 1 << length - 1
+    while bit_position:
+        yield 1 if value & bit_position else 0
+        bit_position >>= 1
+
+def to_byte(bits: tuple[Bit, Bit, Bit, Bit, Bit, Bit, Bit, Bit]) -> Byte:
+    """Convert a tuple of 8 bits to its numeric value as a byte (uint8)."""
+    byte = 0
+    for bit in bits:
+        byte = (byte << 1) + bit
+    return byte