codarascan 0.1.0__tar.gz

codarascan-0.1.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes are recorded here. CodaraScan follows semantic versioning
+after 1.0; during 0.x, breaking changes are identified explicitly.
+
+## 0.1.0 - Unreleased alpha
+
+- Renamed the distribution and import package to `codarascan`.
+- Added immutable, reusable Tessera/Mosaic `Scanner` APIs and cached one-off calls.
+- Added image adapters, EXIF orientation, normalized ROI, full-image quads,
+  explicit statuses, raw-byte preservation, metadata, diagnostics, typed errors,
+  deterministic JSON, and published schemas.
+- Exposed the concrete installed ZXing-C++ readable catalog: 27 linear and 13
+  matrix selections, with clean generated or Apache-2.0 fixtures.
+- Added lazy native Tessera loading with an exact once-per-process warning and
+  tested Python-reference fallback.
+- Replaced every installed Poppler runtime path with pypdfium2 native-raster
+  reuse or 300-DPI PDFium rendering.
+- Added ordered document scanning/streaming, one-based page selection, bounded
+  workers, cancellation cleanup, and raise/collect error policies.
+- Added human, JSON, and NDJSON CLI output plus a private framed-JSON worker.
+- Added Apache-2.0 licensing, notices, typed-package metadata, compatibility and
+  release documentation, CI/release workflows, and artifact tests.
+
+Known validation gaps are listed in `docs/KNOWN_LIMITATIONS.md`; 1.0 production
+gates are not claimed by this alpha.

codarascan-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing
+
+CodaraScan keeps public contracts separate from research-derived engine
+implementations. Public behavior belongs in `scanner.py`, `documents.py`,
+`models.py`, `formats.py`, `inputs.py`, `serialization.py`, `cli.py`, and
+`worker.py`. Tessera, Mosaic, shared recovery, and native code live under
+`src/codarascan/engines/`. Research and frozen historical versions remain in
+`benchmarks/` and `archive/` and are excluded from installed artifacts.
+
+## Setup and checks
+
+Use a supported CPython (3.11-3.14), initialize the pinned ZXing-C++ submodule,
+and install the development dependencies:
+
+```bash
+git submodule update --init --recursive
+python3.11 -m venv .venv
+.venv/bin/python -m pip install -U pip
+.venv/bin/python -m pip install -e ".[dev]"
+```
+
+Run all release-floor checks before proposing a change:
+
+```bash
+.venv/bin/ruff check src/codarascan tests
+.venv/bin/mypy
+.venv/bin/python -m pytest
+.venv/bin/python -m build
+git diff --check
+```
+
+Build the optional native extension in place with:
+
+```bash
+.venv/bin/python setup.py build_ext --inplace
+```
+
+Use `CODARASCAN_FORCE_PYTHON=1` for reference-backend tests. Native algorithm
+changes require parity evidence; format or recovery changes require corpus
+results and wrong-payload review. Do not weaken a valid behavior merely to make
+a test pass.
+
+## Fixtures and repository hygiene
+
+New fixtures need source, license, generator/version, payload, and expected
+format recorded alongside the test or benchmark. The QR Model 1 fixture comes
+from the pinned Apache-2.0 ZXing-C++ submodule; other clean catalog fixtures are
+generated by the installed ZXing writer.
+
+Never commit confidential documents, proprietary corpora, credentials, local
+paths, virtual environments, caches, model downloads, debug output, rendered
+pages, or unreviewed benchmark runs. Inputs and payloads may be sensitive.
+Review wheel and sdist contents before every release.
+
+## Compatibility discipline
+
+0.x may make deliberate breaking changes, but each one must update the
+changelog and migration notes. A selectable format is not removed silently.
+Stable result fields, errors, schemas, CLI output, and worker protocol are
+1.0-gated contracts described in [docs/RELEASE.md](docs/RELEASE.md).

codarascan-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Abderraouf FELLAHI
+
+   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.

codarascan-0.1.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include LICENSE NOTICE THIRD_PARTY_NOTICES.md
+include README.md CHANGELOG.md CONTRIBUTING.md MIGRATION.md SECURITY.md
+include pyproject.toml setup.py
+recursive-include src/codarascan *.py *.json py.typed *.cpp
+recursive-include docs *.md
+prune archive
+prune benchmarks/datasets
+prune docs/barcode-report
+prune reports
+prune third_party
+prune tests
+global-exclude .DS_Store *.py[cod] *.so *.dylib *.dll *.o
+global-exclude __pycache__

codarascan-0.1.0/MIGRATION.md

@@ -0,0 +1,29 @@
+# Migration to CodaraScan 0.1
+
+The former development distribution `barcode-detection` and import package
+`barcode_detection` are replaced by `codarascan`. There is no compatibility
+shim in 0.1.0.
+
+```python
+# Before: private engine access
+from barcode_detection.engines import get_engine
+
+# After: public package contract
+from codarascan import Scanner
+
+scanner = Scanner(mode="fast", symbols="all", decode=True)
+result = scanner.scan_image("page.png")
+```
+
+Application code should not import `codarascan.engines`, recovery modules, or
+the native extension directly. Use `Scanner`, public result/error types,
+`supported_formats`, serialization helpers, CLI output, or the framed worker.
+
+Poppler is no longer a runtime requirement. PDF callers should use
+`scan_document` or `iter_document`; page numbers are one-based, duplicates are
+invalid, and output follows requested order. `workers` now defaults explicitly
+to 1.
+
+Localization-only (`decode=False`) results intentionally have no `text`,
+`value`, `raw_bytes`, or `format` attributes. Consumers must branch on status
+or result type rather than expect null payload fields.

codarascan-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+CodaraScan
+Copyright 2026 Abderraouf FELLAHI
+
+This product includes software developed by third parties. See
+THIRD_PARTY_NOTICES.md for dependency provenance and license references.

codarascan-0.1.0/PKG-INFO

@@ -0,0 +1,221 @@
+Metadata-Version: 2.4
+Name: codarascan
+Version: 0.1.0
+Summary: Offline barcode localization and decoding for images and PDF documents
+Author: Abderraouf FELLAHI
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/flh-raouf/codarascan
+Project-URL: Issues, https://github.com/flh-raouf/codarascan/issues
+Project-URL: Source, https://github.com/flh-raouf/codarascan
+Keywords: barcode,qr-code,data-matrix,pdf,zxing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Graphics :: Capture :: Scanners
+Classifier: Typing :: Typed
+Requires-Python: <3.15,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY_NOTICES.md
+Requires-Dist: numpy<3,>=2.0
+Requires-Dist: opencv-contrib-python-headless<6,>=4.10
+Requires-Dist: zxing-cpp<4,>=3.0
+Requires-Dist: Pillow<13,>=10
+Requires-Dist: pypdfium2<6,>=4.30
+Provides-Extra: test
+Requires-Dist: build<2,>=1.2; extra == "test"
+Requires-Dist: jsonschema<5,>=4.23; extra == "test"
+Requires-Dist: pytest<10,>=8; extra == "test"
+Requires-Dist: pytest-cov<8,>=6; extra == "test"
+Provides-Extra: dev
+Requires-Dist: codarascan[test]; extra == "dev"
+Requires-Dist: mypy<2,>=1.15; extra == "dev"
+Requires-Dist: numpy<2.5,>=2.0; extra == "dev"
+Requires-Dist: ruff<1,>=0.12; extra == "dev"
+Provides-Extra: benchmark
+Requires-Dist: pytest<10,>=8; extra == "benchmark"
+Requires-Dist: qrcode<9,>=7; extra == "benchmark"
+Requires-Dist: torch<3,>=2.6; extra == "benchmark"
+Provides-Extra: experiments
+Requires-Dist: huggingface_hub<1,>=0.30; extra == "experiments"
+Requires-Dist: torch<3,>=2.6; extra == "experiments"
+Requires-Dist: ultralytics<9,>=8; extra == "experiments"
+Dynamic: license-file
+
+# CodaraScan
+
+CodaraScan is an offline Python package for locating and decoding barcodes in
+images and PDF documents. It combines two explicit engines behind one stable
+API: Tessera for low latency (`mode="fast"`) and Mosaic for stronger recovery
+(`mode="robust"`). Results preserve quadrilateral geometry, localization-only
+and unresolved states, Unicode text, and original payload bytes.
+
+> **0.1.0 is alpha software.** APIs and schemas may change during 0.x. Pin an
+> exact version and evaluate your own corpus before production use. All
+> concrete formats readable by the installed ZXing-C++ release are selectable,
+> but degraded-image validation depth varies by format. Stable 1.0 remains
+> blocked on the production gates in [release policy](docs/RELEASE.md).
+
+## Install
+
+CodaraScan supports CPython 3.11 through 3.14.
+
+```bash
+python -m pip install codarascan==0.1.0
+```
+
+PDF support is included in the normal installation through pypdfium2. No
+Poppler executable, server, network connection, runtime model download, or
+Codara application is required.
+
+## Python API
+
+```python
+from codarascan import Scanner
+
+scanner = Scanner(
+    mode="fast",                 # Tessera; use "robust" for Mosaic
+    symbols="all",               # "linear", "2d", or "all"
+    formats=["qr-code", "code-128"],
+    decode=True,
+)
+scanner.warm()                   # optional eager initialization
+
+result = scanner.scan_image("shipping-label.png")
+for symbol in result.symbols:
+    print(symbol.status, symbol.quad)
+    if hasattr(symbol, "text"):
+        print(symbol.format, symbol.text, symbol.raw_bytes)
+```
+
+`scan_image` accepts image paths, encoded image bytes, Pillow images, 2-D
+`uint8` grayscale arrays, and 3/4-channel `uint8` BGR/BGRA arrays. EXIF
+orientation is applied when metadata exists. NumPy arrays are analyzed exactly
+as supplied and copied to isolate scans from caller mutation.
+
+PDF scanning uses one-based page numbers and keeps requested order even with
+parallel analysis:
+
+```python
+document = scanner.scan_document(
+    "batch.pdf",
+    pages=[3, 1, 2],
+    workers=4,                    # default 1; positive integer or "auto"
+    on_error="collect",           # default "raise"
+)
+
+with scanner.iter_document("large.pdf", workers=2) as pages:
+    for page in pages:
+        persist(page)
+    print(pages.complete, pages.errors)
+```
+
+`iter_document` keeps at most the selected worker count in flight and does not
+accumulate returned pages. Both image and document calls accept an optional
+normalized `(x, y, width, height)` ROI and opt-in diagnostics.
+
+One-off `scan_image`, `scan_document`, and `iter_document` functions reuse
+cached immutable scanner configurations. See the complete [API contract](docs/API.md).
+
+## Results
+
+Stable symbol statuses are:
+
+- `decoded`
+- `localized_unresolved_linear`
+- `localized_unresolved_matrix`
+- `localized` when decoding is disabled
+- `review_candidate`
+
+Decoded results expose `text`, its `value` alias, exact `raw_bytes`, canonical
+`format`, kind, confidence, sources, pixel quad, normalized quad, and analyzed
+dimensions. Localization-only results do not have payload or format
+attributes. Confidence is an engine-specific evidence score, not a probability
+and not directly comparable across engines; status is the semantic signal.
+
+`to_json(result)` is deterministic, rejects non-finite numbers, and serializes
+raw bytes as Base64. Schemas and shared golden fixtures ship in
+`codarascan/schemas` for consumer contract tests.
+
+## Formats
+
+```python
+groups = Scanner.supported_formats()
+print([item.name for item in groups["1d"]])
+print([item.name for item in groups["2d"]])
+```
+
+The capability is generated from the installed ZXing-C++ readable catalog and
+contains 27 linear and 13 matrix selections in the pinned 0.1.0 dependency
+range. It deliberately has no experimental/stability field. See
+[compatibility and format status](docs/COMPATIBILITY.md) and the
+[0.1.0 format evidence](benchmarks/results/FORMAT_STATUS_0.1.0.md).
+
+## CLI
+
+```bash
+codarascan image label.png --mode fast --symbols all --json
+codarascan document dossier.pdf --pages 1-4,7 --workers auto --ndjson
+```
+
+Human output is the default. `--json` emits one shared-schema result;
+`--ndjson` streams page objects and a final document summary. Standard output
+is reserved for results. Warnings and debug-output locations use standard
+error. Exit codes are 0 (symbols), 1 (successful no-symbol scan), 2 (invalid
+usage/input), 3 (processing failure), and 4 (partial document result).
+
+The private `codarascan _worker` command provides a persistent, versioned,
+length-prefixed JSON protocol for backend adapters without opening a network
+port. See [worker protocol](docs/WORKER_PROTOCOL.md).
+
+## Native Tessera acceleration
+
+Official wheels are expected to contain `codarascan._sttg_native`. Source
+installs build it when a supported compiler is available. If it cannot load,
+scanning continues through the Python reference backend and emits exactly one
+process-level warning:
+
+> CodaraScan could not load the native Tessera extension. Falling back to the slower Python implementation.
+
+Set `CODARASCAN_FORCE_PYTHON=1` to exercise the reference path. Result metadata
+records `native` or `python-reference`.
+
+## Offline, privacy, and resources
+
+Import, warm, image scanning, PDF rendering, CLI, and worker operations make no
+network requests and emit no telemetry. Inputs, decoded payloads, rendered
+pages, diagnostics, and explicit debug output may be sensitive. Default scans
+leave no persistent crops, overlays, rendered pages, or payload files.
+
+CodaraScan intentionally imposes no hidden limits on input bytes, dimensions,
+pages, workers, CPU, memory, or results. Large images, 300-DPI PDFs, broad
+format searches, diagnostics, and high worker counts can exhaust resources.
+Callers own quotas, isolation, timeouts, admission control, and cancellation.
+
+## Development
+
+```bash
+git submodule update --init --recursive
+python3.11 -m venv .venv
+.venv/bin/python -m pip install -e ".[dev]"
+.venv/bin/ruff check src/codarascan tests
+.venv/bin/mypy
+.venv/bin/python -m pytest
+.venv/bin/python -m build
+```
+
+Research history remains under `archive/`, `benchmarks/`, and the authored
+barcode report. Those assets are not installed as runtime package data. See
+[contributing](CONTRIBUTING.md), [migration notes](MIGRATION.md),
+[known limitations](docs/KNOWN_LIMITATIONS.md), and [changelog](CHANGELOG.md).
+
+CodaraScan is licensed under Apache-2.0. Third-party provenance is recorded in
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).