is-page-empty 1.0.4__tar.gz

is_page_empty-1.0.4/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - run: pip install build
+      - run: python -m build
+      - uses: pypa/gh-action-pypi-publish@release/v1

is_page_empty-1.0.4/.gitignore

@@ -0,0 +1,218 @@
+# 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

is_page_empty-1.0.4/LICENSE

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

is_page_empty-1.0.4/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.5
+Name: is-page-empty
+Version: 1.0.4
+Summary: A very simple script that tests whether an image is likely empty.
+Project-URL: Homepage, https://github.com/johannes-bauer/is_page_empty
+Author-email: Johannes Bauer <atomm-clap@interesting-problems.de>
+License: MIT
+License-File: LICENSE
+Keywords: argument-parser,cli,subcommands
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Provides-Extra: imageio
+Requires-Dist: imageio>=2.0.0; extra == 'imageio'
+Provides-Extra: pil
+Requires-Dist: numpy>=2.2; extra == 'pil'
+Requires-Dist: pillow>=12.0.0; extra == 'pil'
+Provides-Extra: skimage
+Requires-Dist: scikit-image>=0.20.0; extra == 'skimage'
+Description-Content-Type: text/markdown
+
+# is_page_empty
+
+A simple package/script that checks whether a given image file is empty.
+
+Install it with one of the optional dependencies `skimage`, `imageio`, or `pil` or provide that skimage, imageio, or pillow are installed.
+
+Then you can check whether an image file is empty using the commandline:
+
+```bash
+if is_page_empty some_image.png; then echo "Yes, it's empty"; else echo "No, it's not empty."; fi
+```
+
+Or you can use the package to check programmatically
+
+```python
+import is_page_empty
+if is_empty('path/to/image/file.png'):
+    print("That file is empty.")
+```
+
+The script simply cuts the page into small squares, counts the number of pixels below a certain threshold in each, and compares the sum of those numbers in the squares with the highest numbers to a cutoff threshold.
+
+This has been very robust, in my experience, for scanned text; in particular in double-sided prints, where some of the print on the other side may shine through, and in pages with punched holes, which are rendered black in the print.

is_page_empty-1.0.4/README.md

@@ -0,0 +1,23 @@
+# is_page_empty
+
+A simple package/script that checks whether a given image file is empty.
+
+Install it with one of the optional dependencies `skimage`, `imageio`, or `pil` or provide that skimage, imageio, or pillow are installed.
+
+Then you can check whether an image file is empty using the commandline:
+
+```bash
+if is_page_empty some_image.png; then echo "Yes, it's empty"; else echo "No, it's not empty."; fi
+```
+
+Or you can use the package to check programmatically
+
+```python
+import is_page_empty
+if is_empty('path/to/image/file.png'):
+    print("That file is empty.")
+```
+
+The script simply cuts the page into small squares, counts the number of pixels below a certain threshold in each, and compares the sum of those numbers in the squares with the highest numbers to a cutoff threshold.
+
+This has been very robust, in my experience, for scanned text; in particular in double-sided prints, where some of the print on the other side may shine through, and in pages with punched holes, which are rendered black in the print.

is_page_empty-1.0.4/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/is_page_empty"]
+
+[project]
+name = "is-page-empty"
+version = "1.0.4"
+description = "A very simple script that tests whether an image is likely empty."
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+dependencies = []
+authors = [{name = "Johannes Bauer", email = "atomm-clap@interesting-problems.de"}]
+keywords = ["cli", "argument-parser", "subcommands"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Topic :: Software Development :: Libraries",
+]
+
+[project.urls]
+Homepage = "https://github.com/johannes-bauer/is_page_empty"
+
+[project.optional-dependencies]
+skimage = ["scikit-image>=0.20.0"]
+imageio = ["ImageIO>=2.0.0"]
+pil = ["pillow>=12.0.0", "numpy>=2.2"]
+
+[project.scripts]
+is_page_empty = "is_page_empty:main"

is_page_empty-1.0.4/src/is_page_empty/__init__.py

@@ -0,0 +1,62 @@
+try:
+    import skimage
+    def load_image(fn):
+        return skimage.io.imread(fn)
+except ImportError:
+    try:
+        import imageio.v3 as iio
+        def load_image(fn):
+            return iio.imread(fn)
+    except ImportError:
+        import PIL, numpy
+        def load_image(fn):
+            im = PIL.Image.open(fn)
+            return numpy.array(im)
+    
+import sys
+
+CUTOFF = 0.02
+
+def score(im):
+    ratio_bright = (im > 127).mean()
+    return min(ratio_bright, 1-ratio_bright)
+
+
+def is_empty(im, cutoff=CUTOFF):
+    if isinstance(im, str):
+        im = load_image(im)
+        if len(im.shape) == 3:
+            im = im[..., 0] / 3 + im[..., 1] / 3 + im[..., 2] / 3
+
+    smaller_dim, larger_dim = sorted(im.shape)
+    max_stride = smaller_dim / 10
+
+    scores = [
+        score(im[
+            x:int(x+max_stride),
+            y:int(y+max_stride)
+        ])
+        for x in range(0, (im.shape[0] - int(max_stride) - 1), int(max_stride))
+        for y in range(0, (im.shape[1] - int(max_stride) - 1), int(max_stride))
+    ]
+
+    im_score = sum(sorted(scores)[-3:]) / 3
+    return im_score < cutoff, im_score
+
+
+def main():
+    import argparse
+    parser = argparse.ArgumentParser()
+    parser.add_argument('infile')
+    parser.add_argument('-c', dest='cutoff', type=float, default=CUTOFF)
+    parser.add_argument('-r', dest='retval', action='store_true')
+    parser.add_argument('-v', dest='verbose', action='store_true')
+    args = parser.parse_args()
+    empty, im_score = is_empty(args.infile, args.cutoff)
+    if args.verbose:
+        verdict = '' if empty else 'not '
+        print(f"File {args.infile} is {verdict}empty (score: {im_score})")
+    if args.retval:
+        status=(0 if empty else 1)
+        sys.exit(status)
+