Perception 0.8.4__tar.gz → 0.8.5__tar.gz

perception-0.8.5/.dockerignore

@@ -0,0 +1,2 @@
+notebooks
+.venv/

perception-0.8.5/.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# Format with black
+6c03f96a9335e548685ece233474125fe453c262

perception-0.8.5/.gitattributes

@@ -0,0 +1 @@
+perception/_version.py export-subst

perception-0.8.5/.github/dependabot.yaml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week.
+      interval: "weekly"

perception-0.8.5/.github/workflows/ci.yaml

@@ -0,0 +1,56 @@
+name: ci
+on:
+  push:
+    branches:
+      - "**"
+    tags-ignore:
+      - v*
+permissions:
+  contents: read
+jobs:
+  test:
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: checkout
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: Set up uv
+        uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+          cache-python: true
+          cache-dependency-glob: |
+            pyproject.toml
+            uv.lock
+          cache-suffix: ${{ runner.os }}-${{ matrix.python-version }}
+      - name: Setup FFMPEG on Ubuntu
+        if: startsWith(matrix.os, 'ubuntu')
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y ffmpeg
+      - name: Setup FFMPEG on Windows
+        if: startsWith(matrix.os, 'windows')
+        run: choco install ffmpeg --yes --no-progress
+      - name: Setup Dependencies with Homebrew
+        if: startsWith(matrix.os, 'macos')
+        run: |
+          brew install llvm ffmpeg
+          echo "CC=$(brew --prefix)/opt/llvm/bin/clang" >> $GITHUB_ENV
+          echo "CXX=$(brew --prefix)/opt/llvm/bin/clang++" >> $GITHUB_ENV
+      - name: Verify FFMPEG
+        run: |
+          ffmpeg -version
+          ffprobe -version
+      - name: Setup Project
+        run: uv sync --all-extras --frozen
+      - name: Run checks
+        run: |
+          uv lock --check
+          uv run ruff check perception tests
+          uv run mypy perception
+          uv run black --check .
+          uv run pytest tests/

perception-0.8.5/.github/workflows/gh-pages.yaml

@@ -0,0 +1,31 @@
+name: Deploy Sphinx documentation to Pages
+
+on:
+  push:
+    branches:
+      - dunnack/sphinx-to-github-pages
+      - main
+    paths:
+      - .github/workflows/gh-pages.yaml
+      - docs/**
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+      - id: deployment
+        uses: sphinx-notes/pages@e9c8f79f285fb41a150ba6e08a3c2a29635e7ee1 # 3.5
+        with:
+          checkout: false
+          documentation_path: docs
+          requirements_path: docs/requirements.txt

perception-0.8.5/.github/workflows/release.yaml

@@ -0,0 +1,120 @@
+name: release
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-wheels:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        os: ["ubuntu-latest", "windows-latest", "macos-latest"]
+    name: Build for ${{ matrix.os }} on Python ${{ matrix.python-version }}
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          # Full clone for version calculation
+          fetch-depth: 0
+          fetch-tags: true
+          ref: ${{ github.event_name == 'release' && format('refs/tags/{0}', github.event.release.tag_name) || github.ref }}
+      - name: Set up uv
+        uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: false
+      - name: Setup Build Dependencies with Homebrew
+        if: startsWith(matrix.os, 'macos')
+        run: |
+          brew install llvm
+          echo "CC=$(brew --prefix)/opt/llvm/bin/clang" >> $GITHUB_ENV
+          echo "CXX=$(brew --prefix)/opt/llvm/bin/clang++" >> $GITHUB_ENV
+      - name: Build Project
+        shell: bash
+        run: |
+          rm -rf build Perception.egg-info
+          echo "uv: $(uv --version)"
+          echo "Python: $(uv run python --version)"
+          echo "Git describe: $(git describe --tags --always)"
+          uv build --wheel --out-dir="dist-tmp" --clear
+          uv tool run --from repairwheel repairwheel -o dist dist-tmp/*.whl
+          find dist -name "*.whl" -type f | sed -n "s/\(.*\)\.linux.*\.whl$/& \1.whl/p" | xargs -r -n 2 mv
+          rm -rf dist-tmp
+      - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+        with:
+          name: package-wheels-${{ matrix.os }}-${{ matrix.python-version }}
+          path: dist/*
+
+  build-sdist:
+    runs-on: ubuntu-latest
+    name: Build sdist
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          # Full clone for version calculation
+          fetch-depth: 0
+          fetch-tags: true
+          ref: ${{ github.event_name == 'release' && format('refs/tags/{0}', github.event.release.tag_name) || github.ref }}
+      - name: Set up uv
+        uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
+        with:
+          python-version: "3.13"
+          enable-cache: false
+      - name: Build Project
+        shell: bash
+        run: |
+          rm -rf build Perception.egg-info
+          echo "uv: $(uv --version)"
+          echo "Python: $(uv run python --version)"
+          echo "Git describe: $(git describe --tags --always)"
+          uv build --sdist --out-dir="dist"
+      - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+        with:
+          name: package-sdist
+          path: dist/*
+
+  publish:
+    needs: [build-wheels, build-sdist]
+    runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'thorn-oss' && github.event_name == 'release' }}
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          # Full clone for version calculation
+          fetch-depth: 0
+          fetch-tags: true
+          ref: refs/tags/${{ github.event.release.tag_name }}
+      - name: Set up uv
+        uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57 # v8.0.0
+        with:
+          python-version: "3.13"
+          enable-cache: false
+      - name: Download wheels
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          path: dist
+          pattern: package-*
+          merge-multiple: true
+      - name: Load PyPI Token
+        uses: 1password/load-secrets-action@7ce42673ba9ed69053d678faeba29ea36bd25755 # v4.0.0
+        with:
+          # Export loaded secrets as environment variables
+          export-env: true
+        env:
+          OP_SERVICE_ACCOUNT_TOKEN: ${{ secrets.DATA_SCIENCE_OP_SERVICE_ACCOUNT_TOKEN }}
+          UV_PUBLISH_TOKEN: op://data-science-oss/perception-pypi-api-key/secret/value
+      - name: Verify artifacts
+        run: |
+          mapfile -t artifacts < <(find dist -type f \( -name "*.whl" -o -name "*.tar.gz" \))
+          if [ ${#artifacts[@]} -eq 0 ]; then
+            echo "No artifacts found in dist"
+            exit 1
+          fi
+          printf '%s\n' "${artifacts[@]}"
+          if printf '%s\n' "${artifacts[@]}" | grep -E -- '-0\.0\.0([.-]|$)'; then
+            echo "Refusing to publish placeholder version 0.0.0 artifacts"
+            exit 1
+          fi
+      - name: Publish package
+        run: uv publish --trusted-publishing never --no-attestations

perception-0.8.5/.gitignore

@@ -0,0 +1,41 @@
+# MacOS stuff
+.DS_Store
+
+# Python artifacts
+*.egg-info
+
+# Cache
+.mypy_cache
+.pytest_cache
+__pycache__
+.ipynb_checkpoints
+dist
+
+# Any temporary images or CSV files
+notebooks
+
+# Local environment
+.venv
+.python-version
+.pre-commit-cache/
+
+# Coverage file
+.coverage
+
+# Versioneer artifacts
+/versioneer.pyc
+
+# Build artifacts
+/build
+
+# Docs build artifacts
+/docs/_build
+
+# Remove .vscode folder
+.vscode
+
+# Extension artifacts
+*.c
+*.cpp
+*.so
+debug-image*

perception-0.8.5/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/psf/black
+    rev: 26.3.1
+    hooks:
+      - id: black
+        language_version: python3
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.11.13
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+      - id: mypy

perception-0.8.5/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+formats: all
+
+# Installs the package and the docs requirements.
+python:
+   version: 3.9
+   install:
+      - requirements: docs/requirements.txt
+      - method: pip
+        path: .
+   system_packages: true

perception-0.8.5/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.4.0] - 2020-10-17
+This release switches from using false positive rates in benchmarking to reporting precision, which is more intuitive.
+
+### Breaking changes
+All references to fpr_threshold now refer to precision_threshold.
+
+### Bug fixes
+The PDQHash hasher now correctly returns the hash vector instead of the (vector, quality) tuple.
+
+## [0.3.0] - 2020-04-27
+This release adds significantly more support for video.
+
+### Breaking changes
+- Previously, `read_video` returned `(frame, index, timestamp)` tuples where `index` reflected the index of the yielded frame (i.e., it always increased by exactly 1). It now reflects the index of the frame in the original video. This means that, if the requested framerate is higher than the encoded video framerate, this index may repeat the same value, indicating that we have repeated the same frame.
+
+### Enhancements
+- We now include a `SimpleSceneDetection` hasher that can wrap other video hashers using scene detection.
+- `compute_metrics` is much faster now for integer-valued hashes that use a euclidean distance metric.
+- We now include an unsigned 8-bit integer version of `PHash`, called `PHashU8`. This provides a useful framewise hasher for averaging across frames (e.g., using TMK) while being more compact than `PHashF`.
+- We include more thorough support for benchmarking video hashes.
+
+### Bug fixes
+- When using `hasher.vector_to_string` with hashers that return multiple hashes, the `hash_format` argument was not respected.
+- The `compute_threshold_recall` and `show_histograms` functions did not work properly when `grouping=[]`.
+
+## [0.2.0] - 2019-12-20
+This release adds more support for hashing videos (including TMK L2 and TMK L2). As part of that, it also includes a re-factor to separate `benchmarking.BenchmarkDataset` and `benchmarking.BenchmarkTransforms` into image and video variants.
+
+## [0.1.0] - 2019-11-04
+Initial release

perception-0.8.5/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at conduct@thorn.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

perception-0.8.5/MANIFEST.in

@@ -0,0 +1,7 @@
+include perception/testing/images/*
+include perception/testing/videos/*
+include perception/testing/logos/*
+include perception/**/*.pyx
+include perception/*.pyx
+include perception/py.typed
+exclude tests/*

perception-0.8.5/Makefile

@@ -0,0 +1,58 @@
+TEST_SCOPE?=tests/
+
+.PHONY: build build-wheel build-sdist verify-version init-project init test lint_check type_check format format_check precommit clean-build
+
+init-project:
+	uv sync --all-extras
+
+init: init-project
+	uv run pre-commit install
+
+test:
+	uv run pytest $(TEST_SCOPE)
+
+lint_check:
+	uv run ruff check perception tests
+
+type_check:
+	uv run mypy perception
+
+format:
+	uv run black .
+
+format_check:
+	uv run black --check . || (echo '\nUnexpected format.' && exit 1)
+
+precommit:
+	uv lock --check
+	uv run ruff check perception tests
+	uv run mypy perception
+	uv run black --check . || (echo '\nUnexpected format.' && exit 1)
+	uv run pytest $(TEST_SCOPE)
+
+verify-version:
+	@echo "uv: $$(uv --version)"
+	@echo "Python: $$(uv run python --version)"
+	@echo "Git describe: $$(git describe --tags --always)"
+
+clean-build:
+	@rm -rf build Perception.egg-info
+
+build-wheel:
+	@rm -rf build Perception.egg-info
+	@echo "uv: $$(uv --version)"
+	@echo "Python: $$(uv run python --version)"
+	@echo "Git describe: $$(git describe --tags --always)"
+	uv build --wheel --out-dir="dist-tmp" --clear
+	uv tool run --from repairwheel repairwheel -o dist dist-tmp/*.whl
+	@find dist -name "*.whl" -type f | sed -n "s/\(.*\)\.linux.*\.whl$$/& \1.whl/p" | xargs -r -n 2 mv # Fix wheel name
+	@rm -rf dist-tmp
+
+build-sdist:
+	@rm -rf build Perception.egg-info
+	@echo "uv: $$(uv --version)"
+	@echo "Python: $$(uv run python --version)"
+	@echo "Git describe: $$(git describe --tags --always)"
+	uv build --sdist --out-dir="dist"
+
+build: build-wheel build-sdist

{perception-0.8.4 → perception-0.8.5}/PKG-INFO

@@ -1,43 +1,36 @@
 Metadata-Version: 2.4
 Name: Perception
-Version: 0.8.4
+Version: 0.8.5
 Summary: Perception provides flexible, well-documented, and comprehensively tested tooling for perceptual hashing research, development, and production use.
+Author-email: Thorn <info@wearethorn.org>
 License-Expression: Apache-2.0
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/markdown
 License-File: LICENSE
-Author: Thorn
-Author-email: info@wearethorn.org
-Requires-Python: >=3.10,<4.0
-Classifier: Programming Language :: Python :: 3
-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: Programming Language :: Python :: 3.14
+Requires-Dist: numpy<3.0.0,>=1.26.4
+Requires-Dist: opencv-contrib-python-headless<5.0.0,>=4.10.0
+Requires-Dist: faiss-cpu<2.0.0,>=1.8.0
+Requires-Dist: networkit<12.0.0,>=11.1; sys_platform != "darwin"
+Requires-Dist: networkx<4.0,>=3.0; sys_platform == "darwin"
+Requires-Dist: pandas
+Requires-Dist: Pillow
+Requires-Dist: pywavelets<2.0.0,>=1.5.0
+Requires-Dist: validators<1.0.0,>=0.22.0
+Requires-Dist: rich<14.0.0,>=13.7.0
+Requires-Dist: scipy
+Requires-Dist: tqdm<5.0.0,>=4.67.1
 Provides-Extra: benchmarking
+Requires-Dist: matplotlib; extra == "benchmarking"
+Requires-Dist: albumentations<3.0.0,>=2.0.8; extra == "benchmarking"
+Requires-Dist: tabulate; extra == "benchmarking"
+Requires-Dist: scikit-learn; extra == "benchmarking"
+Requires-Dist: ffmpeg-python; extra == "benchmarking"
 Provides-Extra: matching
+Requires-Dist: aiohttp; extra == "matching"
+Requires-Dist: python-json-logger; extra == "matching"
 Provides-Extra: pdq
-Requires-Dist: Cython (>=3.0.0,<4.0.0)
-Requires-Dist: Pillow
-Requires-Dist: aiohttp ; extra == "matching"
-Requires-Dist: albumentations (>=2.0.8,<3.0.0) ; extra == "benchmarking"
-Requires-Dist: faiss-cpu (>=1.8.0,<2.0.0)
-Requires-Dist: ffmpeg-python ; extra == "benchmarking"
-Requires-Dist: matplotlib ; extra == "benchmarking"
-Requires-Dist: networkit (>=11.1,<12.0.0) ; sys_platform != "darwin"
-Requires-Dist: networkx (>=3.0,<4.0) ; sys_platform == "darwin"
-Requires-Dist: numpy (>=1.26.4,<3.0.0)
-Requires-Dist: opencv-contrib-python-headless (>=4.10.0,<5.0.0)
-Requires-Dist: pandas
-Requires-Dist: pdqhash (>=0.2.7,<0.3.0) ; extra == "pdq"
-Requires-Dist: python-json-logger ; extra == "matching"
-Requires-Dist: pywavelets (>=1.5.0,<2.0.0)
-Requires-Dist: rich (>=13.7.0,<14.0.0)
-Requires-Dist: scikit-learn ; extra == "benchmarking"
-Requires-Dist: scipy
-Requires-Dist: tabulate ; extra == "benchmarking"
-Requires-Dist: tqdm (>=4.67.1,<5.0.0)
-Requires-Dist: validators (>=0.22.0,<1.0.0)
-Description-Content-Type: text/markdown
+Requires-Dist: pdqhash<0.3.0,>=0.2.7; extra == "pdq"
+Dynamic: license-file
 
 # perception ![ci](https://github.com/thorn-oss/perception/workflows/ci/badge.svg)
 
@@ -53,6 +46,35 @@ Description-Content-Type: text/markdown
 
 `pip install perception`
 
+#### Optional extras
+
+`perception` provides optional extras for additional functionality:
+
+- `benchmarking` – tools for benchmarking perceptual hashes
+- `matching` – async matching utilities
+- `pdq` – Facebook's PDQ hash support
+
+**Note for `benchmarking` extra users:** The `benchmarking` extra depends on
+`albumentations`, which in turn requires `opencv-python-headless`. However,
+`perception` already depends on `opencv-contrib-python-headless` (needed for
+contrib modules such as `cv2.img_hash` and `cv2.SIFT_create`). Installing both
+OpenCV distributions simultaneously causes file-level conflicts.
+
+If you are using [uv](https://docs.astral.sh/uv/), this is handled
+automatically:
+
+```bash
+uv pip install "perception[benchmarking]"
+```
+
+If you are using plain `pip`, install the extra and then force-reinstall the
+contrib variant to remove the conflicting headless package:
+
+```bash
+pip install "perception[benchmarking]"
+pip install --force-reinstall --no-deps opencv-contrib-python-headless
+```
+
 ### Hashing
 
 Hashing with different functions is simple with `perception`.
@@ -92,11 +114,12 @@ See below for end-to-end examples for common use cases for perceptual hashes.
 To work on the project, start by doing the following.
 
 ```bash
-# Install local dependencies for
-# code completion, etc.
+# Install local dependencies for code completion,
+# testing, and linting.
 make init
+```
 
-- To do a (close to) comprehensive check before committing code, you can use `make precommit`.
+To do a (close to) comprehensive check before committing code, use `make precommit`.
 
 To implement new features, please first file an issue proposing your change for discussion.
 
@@ -111,5 +134,3 @@ examples.
 - [imagededup](https://idealo.github.io/imagededup/)
 - [ImageHash](https://github.com/JohannesBuchner/imagehash)
 - [PhotoHash](https://github.com/bunchesofdonald/photohash)
-```
-