scanlib 1.0.0__tar.gz

scanlib-1.0.0/LICENSE

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

scanlib-1.0.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: scanlib
+Version: 1.0.0
+Summary: A multiplatform document scanning library for Python
+Author-email: Angelo Mottola <a.mottola@gmail.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: comtypes>=1.4; sys_platform == "win32"
+Requires-Dist: pyobjc-framework-ImageCaptureCore; sys_platform == "darwin"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-timeout; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
+Dynamic: license-file
+
+# scanlib
+
+[![Tests](https://github.com/amottola/scanlib/actions/workflows/test.yml/badge.svg)](https://github.com/amottola/scanlib/actions/workflows/test.yml)
+[![Build & Publish](https://github.com/amottola/scanlib/actions/workflows/wheels.yml/badge.svg)](https://github.com/amottola/scanlib/actions/workflows/wheels.yml)
+[![Documentation](https://readthedocs.org/projects/python-scanlib/badge/?version=latest)](https://python-scanlib.readthedocs.io/)
+
+A multiplatform document scanning library for Python with platform-native scanning backends and minimal dependencies.
+
+## Features
+
+- **Cross-platform** — unified API across Windows (WIA 2.0), macOS (ImageCaptureCore), and Linux (SANE)
+- **Output to PDF** — assemble scanned pages into a PDF and control page encoding (JPEG or PNG)
+- **Minimal dependencies** — no external image or PDF processing libraries; JPEG uses platform-native encoders, PNG uses stdlib `zlib`, PDF assembly uses only the standard library
+- **Multi-page scanning** — automatic document feeder support and flatbed multi-page with a simple callback
+- **Page-level control** — preview, rotate, reorder, and encode individual pages as JPEG or PNG before assembling the final PDF
+- **Thread-safe** — call from any thread; backend threading is handled internally
+- **Progress & cancellation** — monitor scan progress and abort mid-scan via callback
+
+## Installation
+
+```bash
+pip install scanlib
+```
+
+Python 3.9+. Pre-built wheels available for all major platforms. On Linux, `libsane` and `libjpeg-turbo` are required at runtime (`apt install libsane-dev libturbojpeg0-dev`); on other platforms, no additional dependencies are required.
+
+## Quick Start
+
+```python
+import scanlib
+
+scanners = scanlib.list_scanners()
+
+with scanners[0] as scanner:
+    doc = scanner.scan()
+
+with open("output.pdf", "wb") as f:
+    f.write(doc.data)
+```
+
+## Documentation
+
+Full documentation is available at [python-scanlib.readthedocs.io](https://python-scanlib.readthedocs.io/).
+
+## About
+
+Created by Angelo Mottola, with the help of [Claude Code](https://claude.ai/code).
+
+This project was started to fill a void in the Python scanning ecosystem, which I found to be very much fragmented. It is also my first experiment in heavily AI-assisted software development (I still hesitate to use the term "vibe" coding), where I mostly did code review and direction.
+
+## License
+
+MIT

scanlib-1.0.0/README.md

@@ -0,0 +1,53 @@
+# scanlib
+
+[![Tests](https://github.com/amottola/scanlib/actions/workflows/test.yml/badge.svg)](https://github.com/amottola/scanlib/actions/workflows/test.yml)
+[![Build & Publish](https://github.com/amottola/scanlib/actions/workflows/wheels.yml/badge.svg)](https://github.com/amottola/scanlib/actions/workflows/wheels.yml)
+[![Documentation](https://readthedocs.org/projects/python-scanlib/badge/?version=latest)](https://python-scanlib.readthedocs.io/)
+
+A multiplatform document scanning library for Python with platform-native scanning backends and minimal dependencies.
+
+## Features
+
+- **Cross-platform** — unified API across Windows (WIA 2.0), macOS (ImageCaptureCore), and Linux (SANE)
+- **Output to PDF** — assemble scanned pages into a PDF and control page encoding (JPEG or PNG)
+- **Minimal dependencies** — no external image or PDF processing libraries; JPEG uses platform-native encoders, PNG uses stdlib `zlib`, PDF assembly uses only the standard library
+- **Multi-page scanning** — automatic document feeder support and flatbed multi-page with a simple callback
+- **Page-level control** — preview, rotate, reorder, and encode individual pages as JPEG or PNG before assembling the final PDF
+- **Thread-safe** — call from any thread; backend threading is handled internally
+- **Progress & cancellation** — monitor scan progress and abort mid-scan via callback
+
+## Installation
+
+```bash
+pip install scanlib
+```
+
+Python 3.9+. Pre-built wheels available for all major platforms. On Linux, `libsane` and `libjpeg-turbo` are required at runtime (`apt install libsane-dev libturbojpeg0-dev`); on other platforms, no additional dependencies are required.
+
+## Quick Start
+
+```python
+import scanlib
+
+scanners = scanlib.list_scanners()
+
+with scanners[0] as scanner:
+    doc = scanner.scan()
+
+with open("output.pdf", "wb") as f:
+    f.write(doc.data)
+```
+
+## Documentation
+
+Full documentation is available at [python-scanlib.readthedocs.io](https://python-scanlib.readthedocs.io/).
+
+## About
+
+Created by Angelo Mottola, with the help of [Claude Code](https://claude.ai/code).
+
+This project was started to fill a void in the Python scanning ecosystem, which I found to be very much fragmented. It is also my first experiment in heavily AI-assisted software development (I still hesitate to use the term "vibe" coding), where I mostly did code review and direction.
+
+## License
+
+MIT

scanlib-1.0.0/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "scanlib"
+version = "1.0.0"
+description = "A multiplatform document scanning library for Python"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{name = "Angelo Mottola", email = "a.mottola@gmail.com"}]
+requires-python = ">=3.9"
+dependencies = [
+    "comtypes>=1.4; sys_platform == 'win32'",
+    "pyobjc-framework-ImageCaptureCore; sys_platform == 'darwin'",
+]
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-timeout", "pre-commit"]
+docs = ["sphinx", "furo", "sphinx-autodoc-typehints"]
+
+[tool.pytest.ini_options]
+markers = ["hardware: tests requiring a physical scanner"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 88
+target-version = ["py39"]
+
+[tool.cibuildwheel]
+build = "cp39-* cp314t-*"
+skip = "*-musllinux_*"
+test-requires = ["pytest", "pytest-timeout"]
+test-command = "pytest {project}/tests --ignore={project}/tests/test_hardware.py -v"
+enable = ["cpython-freethreading"]
+
+[tool.cibuildwheel.linux]
+archs = ["x86_64", "aarch64"]
+before-build = [
+    "yum install -y libjpeg-turbo-devel 2>/dev/null || apk add libjpeg-turbo-dev 2>/dev/null || true",
+]
+before-test = [
+    "yum install -y libjpeg-turbo-devel 2>/dev/null || apk add libjpeg-turbo-dev 2>/dev/null || true",
+]
+
+[tool.cibuildwheel.macos]
+archs = ["universal2"]
+
+[tool.cibuildwheel.windows]
+archs = ["AMD64"]

scanlib-1.0.0/setup.cfg

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

scanlib-1.0.0/setup.py

@@ -0,0 +1,34 @@
+import sys
+import sysconfig
+
+from setuptools import Extension, setup
+
+define_macros = []
+libraries = []
+
+if sys.platform == "linux":
+    define_macros.append(("HAVE_JPEGLIB", "1"))
+    libraries.append("jpeg")
+
+# Use stable ABI (abi3) for non-free-threaded builds
+free_threaded = bool(sysconfig.get_config_var("Py_GIL_DISABLED"))
+py_limited_api = not free_threaded
+if py_limited_api:
+    define_macros.append(("Py_LIMITED_API", "0x03090000"))
+
+options = {}
+if py_limited_api:
+    options["bdist_wheel"] = {"py_limited_api": "cp39"}
+
+setup(
+    ext_modules=[
+        Extension(
+            "_scanlib_accel",
+            sources=["src/accel/_scanlib_accel.c"],
+            define_macros=define_macros,
+            libraries=libraries,
+            py_limited_api=py_limited_api,
+        )
+    ],
+    options=options,
+)