Metadata-Version: 2.2
Name: hcc2d-encoder
Version: 0.9.0
Summary: Pure Python reference encoder for QR, HCC2D4, and HCC2D8 symbols
Author: Marco Querini
License: Apache License
        Version 2.0, January 2004
        http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1. Definitions.
        
        "License" shall mean the terms and conditions for use, reproduction, and
        distribution as defined by Sections 1 through 9 of this document.
        
        "Licensor" shall mean the copyright owner or entity authorized by the
        copyright owner that is granting the License.
        
        "Legal Entity" shall mean the union of the acting entity and all other
        entities that control, are controlled by, or are under common control with
        that entity. For the purposes of this definition, "control" means (i) the
        power, direct or indirect, to cause the direction or management of such
        entity, whether by contract or otherwise, or (ii) ownership of fifty percent
        (50%) or more of the outstanding shares, or (iii) beneficial ownership of
        such entity.
        
        "You" (or "Your") shall mean an individual or Legal Entity exercising
        permissions granted by this License.
        
        "Source" form shall mean the preferred form for making modifications,
        including but not limited to software source code, documentation source, and
        configuration files.
        
        "Object" form shall mean any form resulting from mechanical transformation or
        translation of a Source form, including but not limited to compiled object
        code, generated documentation, and conversions to other media types.
        
        "Work" shall mean the work of authorship, whether in Source or Object form,
        made available under the License, as indicated by a copyright notice that is
        included in or attached to the work (an example is provided in the Appendix
        below).
        
        "Derivative Works" shall mean any work, whether in Source or Object form,
        that is based on (or derived from) the Work and for which the editorial
        revisions, annotations, elaborations, or other modifications represent, as a
        whole, an original work of authorship. For the purposes of this License,
        Derivative Works shall not include works that remain separable from, or
        merely link (or bind by name) to the interfaces of, the Work and Derivative
        Works thereof.
        
        "Contribution" shall mean any work of authorship, including the original
        version of the Work and any modifications or additions to that Work or
        Derivative Works thereof, that is intentionally submitted to Licensor for
        inclusion in the Work by the copyright owner or by an individual or Legal
        Entity authorized to submit on behalf of the copyright owner. For the
        purposes of this definition, "submitted" means any form of electronic, verbal,
        or written communication sent to the Licensor or its representatives,
        including but not limited to communication on electronic mailing lists, source
        code control systems, and issue tracking systems that are managed by, or on
        behalf of, the Licensor for the purpose of discussing and improving the Work,
        but excluding communication that is conspicuously marked or otherwise
        designated in writing by the copyright owner as "Not a Contribution."
        
        "Contributor" shall mean Licensor and any individual or Legal Entity on behalf
        of whom a Contribution has been received by Licensor and subsequently
        incorporated within the Work.
        
        2. Grant of Copyright License. Subject to the terms and conditions of this
        License, each Contributor hereby grants to You a perpetual, worldwide,
        non-exclusive, no-charge, royalty-free, irrevocable copyright license to
        reproduce, prepare Derivative Works of, publicly display, publicly perform,
        sublicense, and distribute the Work and such Derivative Works in Source or
        Object form.
        
        3. Grant of Patent License. Subject to the terms and conditions of this
        License, each Contributor hereby grants to You a perpetual, worldwide,
        non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
        section) patent license to make, have made, use, offer to sell, sell, import,
        and otherwise transfer the Work, where such license applies only to those
        patent claims licensable by such Contributor that are necessarily infringed by
        their Contribution(s) alone or by combination of their Contribution(s) with
        the Work to which such Contribution(s) was submitted. If You institute patent
        litigation against any entity (including a cross-claim or counterclaim in a
        lawsuit) alleging that the Work or a Contribution incorporated within the Work
        constitutes direct or contributory patent infringement, then any patent
        licenses granted to You under this License for that Work shall terminate as of
        the date such litigation is filed.
        
        4. Redistribution. You may reproduce and distribute copies of the Work or
        Derivative Works thereof in any medium, with or without modifications, and in
        Source or Object form, provided that You meet the following conditions:
        
        (a) You must give any other recipients of the Work or Derivative Works a copy
        of this License; and
        
        (b) You must cause any modified files to carry prominent notices stating that
        You changed the files; and
        
        (c) You must retain, in the Source form of any Derivative Works that You
        distribute, all copyright, patent, trademark, and attribution notices from
        the Source form of the Work, excluding those notices that do not pertain to
        any part of the Derivative Works; and
        
        (d) If the Work includes a "NOTICE" text file as part of its distribution,
        then any Derivative Works that You distribute must include a readable copy of
        the attribution notices contained within such NOTICE file, excluding those
        notices that do not pertain to any part of the Derivative Works, in at least
        one of the following places: within a NOTICE text file distributed as part of
        the Derivative Works; within the Source form or documentation, if provided
        along with the Derivative Works; or, within a display generated by the
        Derivative Works, if and wherever such third-party notices normally appear.
        The contents of the NOTICE file are for informational purposes only and do not
        modify the License. You may add Your own attribution notices within Derivative
        Works that You distribute, alongside or as an addendum to the NOTICE text from
        the Work, provided that such additional attribution notices cannot be
        construed as modifying the License.
        
        You may add Your own copyright statement to Your modifications and may provide
        additional or different license terms and conditions for use, reproduction, or
        distribution of Your modifications, or for any such Derivative Works as a
        whole, provided Your use, reproduction, and distribution of the Work otherwise
        complies with the conditions stated in this License.
        
        5. Submission of Contributions. Unless You explicitly state otherwise, any
        Contribution intentionally submitted for inclusion in the Work by You to the
        Licensor shall be under the terms and conditions of this License, without any
        additional terms or conditions. Notwithstanding the above, nothing herein
        shall supersede or modify the terms of any separate license agreement you may
        have executed with Licensor regarding such Contributions.
        
        6. Trademarks. This License does not grant permission to use the trade names,
        trademarks, service marks, or product names of the Licensor, except as
        required for reasonable and customary use in describing the origin of the Work
        and reproducing the content of the NOTICE file.
        
        7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
        writing, Licensor provides the Work (and each Contributor provides its
        Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
        KIND, either express or implied, including, without limitation, any warranties
        or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
        PARTICULAR PURPOSE. You are solely responsible for determining the
        appropriateness of using or redistributing the Work and assume any risks
        associated with Your exercise of permissions under this License.
        
        8. Limitation of Liability. In no event and under no legal theory, whether in
        tort (including negligence), contract, or otherwise, unless required by
        applicable law (such as deliberate and grossly negligent acts) or agreed to in
        writing, shall any Contributor be liable to You for damages, including any
        direct, indirect, special, incidental, or consequential damages of any
        character arising as a result of this License or out of the use or inability
        to use the Work (including but not limited to damages for loss of goodwill,
        work stoppage, computer failure or malfunction, or any and all other
        commercial damages or losses), even if such Contributor has been advised of
        the possibility of such damages.
        
        9. Accepting Warranty or Additional Liability. While redistributing the Work
        or Derivative Works thereof, You may choose to offer, and charge a fee for,
        acceptance of support, warranty, indemnity, or other liability obligations
        and/or rights consistent with this License. However, in accepting such
        obligations, You may act only on Your own behalf and on Your sole
        responsibility, not on behalf of any other Contributor, and only if You agree
        to indemnify, defend, and hold each Contributor harmless for any liability
        incurred by, or claims asserted against, such Contributor by reason of your
        accepting any such warranty or additional liability.
        
        END OF TERMS AND CONDITIONS
        
        APPENDIX: How to apply the Apache License to your work.
        
        To apply the Apache License to your work, attach the following boilerplate
        notice, with the fields enclosed by brackets "[]" replaced with your own
        identifying information. (Don't include the brackets!) The text should be
        enclosed in the appropriate comment syntax for the file format. We also
        recommend that a file or class name and description of purpose be included on
        the same "printed page" as the copyright notice for easier identification
        within third-party archives.
        
        Copyright [yyyy] [name of copyright owner]
        
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
        
            http://www.apache.org/licenses/LICENSE-2.0
        
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License.
        
Project-URL: Homepage, https://hcc2d.com/en/
Project-URL: Documentation, https://hcc2d.com/en/api
Project-URL: Specification, https://doi.org/10.5281/zenodo.22206528
Project-URL: Source, https://github.com/marco-querini/hcc2d-cli-python-encoder
Project-URL: Issues, https://github.com/marco-querini/hcc2d-cli-python-encoder/issues
Keywords: hcc2d,qr-code,barcode,encoder,color-barcode
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
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
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# HCC2D Python Encoder 0.9.0

Written by Marco Querini.

Pure Python distribution of the HCC2D reference encoder. It is functionally
aligned with the public
[single-file C reference encoder](https://github.com/marco-querini/hcc2d-cli-c-encoder)
0.9.0, has no runtime dependencies, and can be used either as a command-line
application or as an importable library.

## Official links

- HCC2D website: <https://hcc2d.com/en/>
- HCC2D Code Specification 0.9.0: <https://doi.org/10.5281/zenodo.22206528>
- HCC2D API: <https://hcc2d.com/en/api>
- HCC2D Decoder on Google Play: <https://play.google.com/store/apps/details?id=com.hcc2d.decoder>
- HCC2D Decoder on Huawei AppGallery:
  <https://appgallery.cloud.huawei.com/marketshare/app/C117478101>
- HCC2D Decoder on the App Store: <https://apps.apple.com/app/id6762202762>
- HCC2D Encoder on the Mac App Store: <https://apps.apple.com/app/id6767833986>

## Supported features

- standard black/white QR Code
- HCC2D4 with 4 colours and 2 bits per module
- HCC2D8 with 8 colours and 3 bits per module
- EC levels `L`, `M`, `Q`, and `H`
- versions `1..40`, or `0` for automatic selection
- screen-oriented Model 1 and print-oriented Model 2 palettes
- raw payloads and optional HCC2DF wrapping
- text and binary-file inputs
- indexed PNG output

HCC2D16 is not included because it is not part of the HCC2D 0.9.0
specification or the public C reference encoder 0.9.0.

## Requirements

- Python 3.8 or later
- no third-party runtime packages

## Installation

From PyPI:

```bash
python3 -m pip install hcc2d-encoder
```

For an isolated command-line installation:

```bash
pipx install hcc2d-encoder
```

Before the first PyPI release, or when working from a clone, install the local
source tree instead:

```bash
python3 -m venv .venv
.venv/bin/python -m pip install --upgrade pip
.venv/bin/python -m pip install -e .
```

## Command-line usage

Show the complete help and legal notice:

```bash
hcc2d-encoder --help
```

The equivalent module entry point is:

```bash
python3 -m hcc2d_encoder --help
```

Generate a standard QR Code containing raw UTF-8 text:

```bash
hcc2d-encoder --text "https://hcc2d.com/spec" \
  --mode qr --file-format raw qr_spec_url.png
```

Generate an HCC2D4 symbol containing raw text bytes:

```bash
hcc2d-encoder --text "Batch=2026-06-16;Line=A3;Unit=004271" \
  --mode hcc2d4 --file-format raw hcc2d4_label.png
```

Generate an HCC2D8 symbol carrying a file in an HCC2DF container:

```bash
hcc2d-encoder --input-file report.pdf --mode hcc2d8 \
  --file-format hcc2df --ec-level L hcc2d8_report.png
```

Defaults are HCC2D4, EC level Q, automatic version selection, 12 pixels per
module, a 4-module quiet zone, Model 1 palette, and HCC2DF wrapping.

Run `hcc2d-encoder --help` for the complete option reference. Exactly one of
`--text` and `--input-file` is required. The destination PNG path is the final
positional argument.

### Raw versus HCC2DF

Use `raw` when the input bytes are already the complete payload and filename
metadata is unnecessary. This minimizes overhead.

Use `hcc2df` when the payload should carry a filename and may benefit from
automatic zlib compression. Compression is used only when the content is at
least 128 bytes and the compressed representation is strictly smaller than
90% of the original size. File input preserves the basename; text input uses
`text.txt` as its embedded filename.

## Python API

Generate an HCC2D4 PNG:

```python
from pathlib import Path

from hcc2d_encoder import encode_hcc2d, write_png

symbol = encode_hcc2d(
    b"hello",
    mode="hcc2d4",
    ec_level="Q",
    version=0,
    scale=12,
    quiet_zone=4,
)
write_png(Path("hello.png"), symbol)
```

Generate a standard QR PNG:

```python
from pathlib import Path

from hcc2d_encoder import encode_qr, write_png

symbol = encode_qr(b"https://hcc2d.com/", ec_level="Q")
write_png(Path("hcc2d-website.png"), symbol)
```

Both encoding functions return an `EncodedSymbol`. Pass that object to
`write_png`, or use `build_indexed_png` when the encoded PNG bytes are needed
in memory. The lower-level public helpers and palette constants are listed in
`hcc2d_encoder.__all__`.

## Compatibility and validation

The Python encoder was compared directly with the public C reference encoder
0.9.0. Validation covered:

- all versions from 1 through 40
- QR, HCC2D4, and HCC2D8
- EC levels L, M, Q, and H
- all applicable Model 1 and Model 2 palettes
- raw and HCC2DF text/file payloads
- automatic version selection and capacity failures
- controlled CLI errors without Python tracebacks

The exhaustive forced-version matrix produced 800 out of 800 PNG files that
were byte-identical to the C implementation. The automated tests also pin
known QR, HCC2D4, and HCC2D8 output hashes.

Run the package tests with:

```bash
python3 -m unittest discover -s tests -v
```

GitHub Actions runs the test suite on every declared Python version from 3.8
through 3.13 and verifies that both PyPI distribution formats build cleanly.

## Building PyPI artifacts locally

Use an isolated environment:

```bash
python3 -m venv .venv
.venv/bin/python -m pip install --upgrade pip build twine
.venv/bin/python -m unittest discover -s tests -v
.venv/bin/python -m build
.venv/bin/python -m twine check --strict dist/*
```

This produces a pure-Python wheel and a source distribution under `dist/`.
Before the first real release, test installation from the wheel in a fresh
virtual environment.

Production publication is performed by the release workflow through PyPI
Trusted Publishing, so no long-lived API token is stored in the repository or
in GitHub secrets. See [PUBLISHING.md](PUBLISHING.md) for the one-time PyPI
configuration and the complete release checklist.

## License and warranty

Copyright 2010-2026 Marco Querini.

SPDX-License-Identifier: Apache-2.0. See [LICENSE](LICENSE) for the complete
license text.

This software is provided "as is", without warranties or conditions of any
kind, express or implied, including but not limited to merchantability,
fitness for a particular purpose, and noninfringement. Use is entirely at your
own risk. The author assumes no responsibility or liability for damages,
losses, claims, unreadable or non-decodable codes, failed scans, data loss, or
other consequences arising from its use.

## Notice

The views expressed in connection with the HCC2D Code Specification, HCC2D
applications distributed through app stores, and HCC2D source code released
as open source are solely those of the author and do not necessarily reflect
the official position of any institution, organization, or employer with
which the author is or has been affiliated.
