aztec-py 0.11.0__tar.gz

aztec_py-0.11.0/CONTRIBUTORS.md

@@ -0,0 +1,28 @@
+# Contributors & Lineage
+
+## Authors
+- Originally written by Dmitry Alimov (delimitry).
+- Updates, bug fixes, and active maintenance in this fork by greyllmmoder.
+
+## Current maintainer
+- greyllmmoder - https://github.com/greyllmmoder
+
+## Upstream lineage (MIT license chain)
+This project is a fork of **dlenski/aztec_code_generator**
+(https://github.com/dlenski/aztec_code_generator), which is itself
+a fork of **delimitry/aztec_code_generator**
+(https://github.com/delimitry/aztec_code_generator).
+
+Both upstream projects are MIT licensed. The original upstream license
+text is preserved in `LICENSE.upstream`.
+
+## What changed from upstream
+- Fixed: CRLF encoding crash (upstream issue #5)
+- Fixed: Error correction capacity calculation (upstream issue #7)
+- Added: SVG renderer (based on upstream PR #6)
+- Added: Type hints, docstrings, CLI, PDF output, Rune mode
+- Restructured: Single-file module split into package
+
+## Third-party contributions incorporated
+- SVG support: originally authored by Zazzik1
+  (https://github.com/dlenski/aztec_code_generator/pull/6), MIT license

aztec_py-0.11.0/LICENSE

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

aztec_py-0.11.0/LICENSE.upstream

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Dmitry Alimov
+
+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.

aztec_py-0.11.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include requirements.txt
+include LICENSE
+include LICENSE.upstream
+include CONTRIBUTORS.md
+include docs/ISO_IEC_24778_TRACEABILITY.md

aztec_py-0.11.0/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: aztec-py
+Version: 0.11.0
+Summary: Pure-Python Aztec Code 2D barcode generator - production-grade fork
+Author: greyllmmoder
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/greyllmmoder/python-aztec
+Project-URL: Bug Tracker, https://github.com/greyllmmoder/python-aztec/issues
+Project-URL: Source, https://github.com/greyllmmoder/python-aztec
+Project-URL: Upstream, https://github.com/dlenski/aztec_code_generator
+Keywords: aztec,barcode,2d-barcode,qr,iso-24778
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Graphics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE.upstream
+Provides-Extra: image
+Requires-Dist: pillow>=8.0; extra == "image"
+Provides-Extra: svg
+Requires-Dist: lxml>=4.9; extra == "svg"
+Provides-Extra: pdf
+Requires-Dist: fpdf2>=2.7; extra == "pdf"
+Requires-Dist: pillow>=8.0; extra == "pdf"
+Provides-Extra: decode
+Requires-Dist: zxing>=1.0.4; extra == "decode"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: hypothesis>=6.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: pillow>=8.0; extra == "dev"
+Requires-Dist: fpdf2>=2.7; extra == "dev"
+Dynamic: license-file
+
+# aztec-py
+
+[![CI](https://github.com/greyllmmoder/python-aztec/actions/workflows/ci.yml/badge.svg)](https://github.com/greyllmmoder/python-aztec/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/aztec-py.svg)](https://pypi.org/project/aztec-py/)
+[![Coverage](https://img.shields.io/badge/coverage-%3E=90%25-brightgreen)](https://github.com/greyllmmoder/python-aztec)
+[![mypy](https://img.shields.io/badge/type_checked-mypy-blue)](https://mypy-lang.org/)
+
+Pure-Python Aztec Code 2D barcode generator.
+
+Forked from [`dlenski/aztec_code_generator`](https://github.com/dlenski/aztec_code_generator)
+with production fixes, package modernization, SVG/PDF output, CLI tooling, and active maintenance.
+
+## What Is Aztec Code?
+
+Aztec Code is a compact 2D barcode format standardized in ISO/IEC 24778. It can encode text or
+binary payloads with configurable error correction, and it does not require a quiet zone.
+
+## Install
+
+```bash
+pip install aztec-py
+```
+
+Optional extras:
+
+```bash
+pip install "aztec-py[pdf]"      # PDF output
+pip install "aztec-py[decode]"   # Decode utility via python-zxing + Java
+pip install "aztec-py[svg]"      # lxml-backed SVG workflows (optional)
+```
+
+## Use In Your Project
+
+Recommended dependency pins for production:
+
+`requirements.txt`
+```text
+aztec-py>=0.11,<1.0
+```
+
+`pyproject.toml` (PEP 621)
+```toml
+[project]
+dependencies = [
+  "aztec-py>=0.11,<1.0",
+]
+```
+
+Install directly from GitHub when you need an unreleased fix:
+
+```bash
+pip install "aztec-py @ git+https://github.com/greyllmmoder/python-aztec.git@<tag-or-commit>"
+```
+
+For production, pin to a tag or commit SHA, not `main`.
+
+## Quick Start
+
+```python
+from aztec_py import AztecCode
+
+code = AztecCode("Hello World")
+code.save("hello.png", module_size=4)
+print(code.svg())
+```
+
+## Production Validation
+
+Run compatibility fixtures and generate a markdown report:
+
+```bash
+python scripts/decoder_matrix.py --report compat_matrix_report.md
+```
+
+The script is skip-safe when decode runtime requirements (`zxing` + Java) are unavailable.
+Use strict mode when decode checks are mandatory in CI:
+
+```bash
+python scripts/decoder_matrix.py --strict-decode
+```
+
+Generate full conformance evidence (markdown + JSON + compatibility matrix):
+
+```bash
+python scripts/conformance_report.py \
+  --report conformance_report.md \
+  --json conformance_report.json \
+  --matrix-report compat_matrix_report.md
+```
+
+Fixture source: `tests/compat/fixtures.json`
+Traceability matrix: `docs/ISO_IEC_24778_TRACEABILITY.md`
+Release checklist: `PRODUCTION_CHECKLIST.md`
+
+## CLI
+
+```bash
+aztec "Hello World" --format terminal
+aztec "Hello World" --format svg > code.svg
+aztec "Hello World" --format png --module-size 4 --output code.png
+aztec --ec 33 --charset ISO-8859-1 "Héllo" --format svg --output code.svg
+```
+
+Supported flags:
+
+- `--format/-f`: `svg`, `png`, `terminal` (default: `terminal`)
+- `--module-size/-m`: module size in pixels (default: `1`)
+- `--ec`: error correction percent (default: `23`)
+- `--charset`: text charset/ECI hint (default: `UTF-8`)
+- `--output/-o`: output file path (required for `png`)
+
+## API Reference
+
+### `AztecCode`
+
+- `AztecCode(data, ec_percent=23, encoding=None, charset=None, size=None, compact=None)`
+- `image(module_size=2, border=0)`
+- `svg(module_size=1, border=1) -> str`
+- `pdf(module_size=3, border=1) -> bytes`
+- `save(path, module_size=2, border=0, format=None)`
+- `print_out(border=0)`
+- `print_fancy(border=0)`
+
+### `AztecRune`
+
+- `AztecRune(value)` where `value` is in `0..255`
+- `image()`, `svg()`, `save(...)`
+
+### GS1 Payload Helper
+
+- `GS1Element(ai, data, variable_length=False)`
+- `build_gs1_payload([...]) -> str`
+- `GROUP_SEPARATOR` (`\x1d`)
+
+Example:
+
+```python
+from aztec_py import AztecCode, GS1Element, build_gs1_payload
+
+payload = build_gs1_payload(
+    [
+        GS1Element("01", "03453120000011"),
+        GS1Element("17", "120508"),
+        GS1Element("10", "ABCD1234", variable_length=True),
+        GS1Element("410", "9501101020917"),
+    ]
+)
+AztecCode(payload).save("gs1.png", module_size=4)
+```
+
+### Decode Utility
+
+```python
+from aztec_py import AztecCode, decode
+
+code = AztecCode("test data")
+decoded = decode(code.image())
+```
+
+Requires `pip install "aztec-py[decode]"` and a Java runtime.
+
+## GS1 Recipes
+
+```python
+from aztec_py import GS1Element, build_gs1_payload
+```
+
+1. GTIN + Expiry (fixed-length only)
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("17", "120508"),
+])
+```
+2. GTIN + Batch/Lot + Ship To (variable field adds separator)
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("10", "ABCD1234", variable_length=True),
+    GS1Element("410", "9501101020917"),
+])
+```
+3. GTIN + Serial
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("21", "SERIAL0001", variable_length=True),
+])
+```
+4. GTIN + Weight (kg)
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("3103", "000750"),
+])
+```
+5. GTIN + Expiry + Serial + Destination
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("17", "120508"),
+    GS1Element("21", "XYZ12345", variable_length=True),
+    GS1Element("410", "9501101020917"),
+])
+```
+
+## Comparison
+
+| Library | Pure Python encode | SVG | CLI | Rune | PDF | Notes |
+|---|---:|---:|---:|---:|---:|---|
+| `aztec-py` | Yes | Yes | Yes | Yes | Yes | Active fork with bugfixes |
+| `dlenski/aztec_code_generator` | Yes | PR pending | No | No | No | Upstream fork |
+| `delimitry/aztec_code_generator` | Yes | No | No | No | No | Original lineage |
+| `treepoem` | No (BWIPP/Ghostscript backend) | Via backend | No | Backend-dependent | Via backend | Wrapper-based |
+| Aspose Barcode | No (proprietary) | Yes | N/A | Yes | Yes | Commercial SDK |
+
+## Lineage and Attribution
+
+- Originally written by Dmitry Alimov (delimitry); this fork's updates and bug fixes are maintained by greyllmmoder.
+- Upstream fork source: https://github.com/dlenski/aztec_code_generator
+- Original project: https://github.com/delimitry/aztec_code_generator
+- License chain: MIT (`LICENSE` and `LICENSE.upstream`)
+- SVG support based on upstream PR #6 by Zazzik1:
+  https://github.com/dlenski/aztec_code_generator/pull/6
+
+## Contributing
+
+- Read contribution guidelines: `CONTRIBUTING.md`
+- Security reporting process: `SECURITY.md`
+- Production release checks: `PRODUCTION_CHECKLIST.md`
+- To sync standard labels (after `gh auth login`): `./scripts/sync_labels.sh`

aztec_py-0.11.0/README.md

@@ -0,0 +1,231 @@
+# aztec-py
+
+[![CI](https://github.com/greyllmmoder/python-aztec/actions/workflows/ci.yml/badge.svg)](https://github.com/greyllmmoder/python-aztec/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/aztec-py.svg)](https://pypi.org/project/aztec-py/)
+[![Coverage](https://img.shields.io/badge/coverage-%3E=90%25-brightgreen)](https://github.com/greyllmmoder/python-aztec)
+[![mypy](https://img.shields.io/badge/type_checked-mypy-blue)](https://mypy-lang.org/)
+
+Pure-Python Aztec Code 2D barcode generator.
+
+Forked from [`dlenski/aztec_code_generator`](https://github.com/dlenski/aztec_code_generator)
+with production fixes, package modernization, SVG/PDF output, CLI tooling, and active maintenance.
+
+## What Is Aztec Code?
+
+Aztec Code is a compact 2D barcode format standardized in ISO/IEC 24778. It can encode text or
+binary payloads with configurable error correction, and it does not require a quiet zone.
+
+## Install
+
+```bash
+pip install aztec-py
+```
+
+Optional extras:
+
+```bash
+pip install "aztec-py[pdf]"      # PDF output
+pip install "aztec-py[decode]"   # Decode utility via python-zxing + Java
+pip install "aztec-py[svg]"      # lxml-backed SVG workflows (optional)
+```
+
+## Use In Your Project
+
+Recommended dependency pins for production:
+
+`requirements.txt`
+```text
+aztec-py>=0.11,<1.0
+```
+
+`pyproject.toml` (PEP 621)
+```toml
+[project]
+dependencies = [
+  "aztec-py>=0.11,<1.0",
+]
+```
+
+Install directly from GitHub when you need an unreleased fix:
+
+```bash
+pip install "aztec-py @ git+https://github.com/greyllmmoder/python-aztec.git@<tag-or-commit>"
+```
+
+For production, pin to a tag or commit SHA, not `main`.
+
+## Quick Start
+
+```python
+from aztec_py import AztecCode
+
+code = AztecCode("Hello World")
+code.save("hello.png", module_size=4)
+print(code.svg())
+```
+
+## Production Validation
+
+Run compatibility fixtures and generate a markdown report:
+
+```bash
+python scripts/decoder_matrix.py --report compat_matrix_report.md
+```
+
+The script is skip-safe when decode runtime requirements (`zxing` + Java) are unavailable.
+Use strict mode when decode checks are mandatory in CI:
+
+```bash
+python scripts/decoder_matrix.py --strict-decode
+```
+
+Generate full conformance evidence (markdown + JSON + compatibility matrix):
+
+```bash
+python scripts/conformance_report.py \
+  --report conformance_report.md \
+  --json conformance_report.json \
+  --matrix-report compat_matrix_report.md
+```
+
+Fixture source: `tests/compat/fixtures.json`
+Traceability matrix: `docs/ISO_IEC_24778_TRACEABILITY.md`
+Release checklist: `PRODUCTION_CHECKLIST.md`
+
+## CLI
+
+```bash
+aztec "Hello World" --format terminal
+aztec "Hello World" --format svg > code.svg
+aztec "Hello World" --format png --module-size 4 --output code.png
+aztec --ec 33 --charset ISO-8859-1 "Héllo" --format svg --output code.svg
+```
+
+Supported flags:
+
+- `--format/-f`: `svg`, `png`, `terminal` (default: `terminal`)
+- `--module-size/-m`: module size in pixels (default: `1`)
+- `--ec`: error correction percent (default: `23`)
+- `--charset`: text charset/ECI hint (default: `UTF-8`)
+- `--output/-o`: output file path (required for `png`)
+
+## API Reference
+
+### `AztecCode`
+
+- `AztecCode(data, ec_percent=23, encoding=None, charset=None, size=None, compact=None)`
+- `image(module_size=2, border=0)`
+- `svg(module_size=1, border=1) -> str`
+- `pdf(module_size=3, border=1) -> bytes`
+- `save(path, module_size=2, border=0, format=None)`
+- `print_out(border=0)`
+- `print_fancy(border=0)`
+
+### `AztecRune`
+
+- `AztecRune(value)` where `value` is in `0..255`
+- `image()`, `svg()`, `save(...)`
+
+### GS1 Payload Helper
+
+- `GS1Element(ai, data, variable_length=False)`
+- `build_gs1_payload([...]) -> str`
+- `GROUP_SEPARATOR` (`\x1d`)
+
+Example:
+
+```python
+from aztec_py import AztecCode, GS1Element, build_gs1_payload
+
+payload = build_gs1_payload(
+    [
+        GS1Element("01", "03453120000011"),
+        GS1Element("17", "120508"),
+        GS1Element("10", "ABCD1234", variable_length=True),
+        GS1Element("410", "9501101020917"),
+    ]
+)
+AztecCode(payload).save("gs1.png", module_size=4)
+```
+
+### Decode Utility
+
+```python
+from aztec_py import AztecCode, decode
+
+code = AztecCode("test data")
+decoded = decode(code.image())
+```
+
+Requires `pip install "aztec-py[decode]"` and a Java runtime.
+
+## GS1 Recipes
+
+```python
+from aztec_py import GS1Element, build_gs1_payload
+```
+
+1. GTIN + Expiry (fixed-length only)
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("17", "120508"),
+])
+```
+2. GTIN + Batch/Lot + Ship To (variable field adds separator)
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("10", "ABCD1234", variable_length=True),
+    GS1Element("410", "9501101020917"),
+])
+```
+3. GTIN + Serial
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("21", "SERIAL0001", variable_length=True),
+])
+```
+4. GTIN + Weight (kg)
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("3103", "000750"),
+])
+```
+5. GTIN + Expiry + Serial + Destination
+```python
+build_gs1_payload([
+    GS1Element("01", "03453120000011"),
+    GS1Element("17", "120508"),
+    GS1Element("21", "XYZ12345", variable_length=True),
+    GS1Element("410", "9501101020917"),
+])
+```
+
+## Comparison
+
+| Library | Pure Python encode | SVG | CLI | Rune | PDF | Notes |
+|---|---:|---:|---:|---:|---:|---|
+| `aztec-py` | Yes | Yes | Yes | Yes | Yes | Active fork with bugfixes |
+| `dlenski/aztec_code_generator` | Yes | PR pending | No | No | No | Upstream fork |
+| `delimitry/aztec_code_generator` | Yes | No | No | No | No | Original lineage |
+| `treepoem` | No (BWIPP/Ghostscript backend) | Via backend | No | Backend-dependent | Via backend | Wrapper-based |
+| Aspose Barcode | No (proprietary) | Yes | N/A | Yes | Yes | Commercial SDK |
+
+## Lineage and Attribution
+
+- Originally written by Dmitry Alimov (delimitry); this fork's updates and bug fixes are maintained by greyllmmoder.
+- Upstream fork source: https://github.com/dlenski/aztec_code_generator
+- Original project: https://github.com/delimitry/aztec_code_generator
+- License chain: MIT (`LICENSE` and `LICENSE.upstream`)
+- SVG support based on upstream PR #6 by Zazzik1:
+  https://github.com/dlenski/aztec_code_generator/pull/6
+
+## Contributing
+
+- Read contribution guidelines: `CONTRIBUTING.md`
+- Security reporting process: `SECURITY.md`
+- Production release checks: `PRODUCTION_CHECKLIST.md`
+- To sync standard labels (after `gh auth login`): `./scripts/sync_labels.sh`

aztec_py-0.11.0/aztec_code_generator.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Backward-compatible import shim for the legacy module path."""
+
+from aztec_py.core import *  # noqa: F401,F403
+from aztec_py.core import main
+
+
+if __name__ == '__main__':
+    import sys
+
+    main(sys.argv)

aztec_py-0.11.0/aztec_py/__init__.py

@@ -0,0 +1,39 @@
+"""Public package API for aztec-py."""
+
+from .core import (
+    AztecCode,
+    Latch,
+    Misc,
+    Mode,
+    Shift,
+    encoding_to_eci,
+    find_optimal_sequence,
+    find_suitable_matrix_size,
+    get_data_codewords,
+    get_config_from_table,
+    optimal_sequence_to_bits,
+    reed_solomon,
+)
+from .decode import decode
+from .gs1 import GROUP_SEPARATOR, GS1Element, build_gs1_payload
+from .rune import AztecRune
+
+__all__ = [
+    'AztecCode',
+    'Latch',
+    'Misc',
+    'Mode',
+    'Shift',
+    'encoding_to_eci',
+    'find_optimal_sequence',
+    'find_suitable_matrix_size',
+    'get_data_codewords',
+    'get_config_from_table',
+    'optimal_sequence_to_bits',
+    'reed_solomon',
+    'AztecRune',
+    'decode',
+    'GROUP_SEPARATOR',
+    'GS1Element',
+    'build_gs1_payload',
+]