ocr-stringdist 0.0.1__cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl → 0.0.3__cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl

ocr_stringdist/__init__.py

@@ -1 +1,41 @@
-from ._rust_stringdist import *
+from typing import Optional
+
+from ._rust_stringdist import *  # noqa: F403
+
+from .default_ocr_distances import ocr_distance_map
+
+
+__all__ = [
+    "ocr_distance_map",
+    "weighted_levenshtein_distance",  # noqa: F405
+]
+
+
+def weighted_levenshtein_distance(
+    s1: str,
+    s2: str,
+    /,
+    cost_map: Optional[dict[tuple[str, str], float]] = None,
+    *,
+    symmetric: bool = True,
+    default_cost: float = 1.0,
+) -> float:
+    """
+    Levenshtein distance with custom substitution costs.
+    Insertion/deletion costs are 1.
+
+    The default `cost_map` considers common OCR errors, see `ocr_stringdist.ocr_distance_map`.
+
+    :param s1: First string
+    :param s2: Second string
+    :param cost_map: Dictionary mapping tuples of characters to their substitution cost.
+                     Only one direction needs to be configured unless `symmetric` is False.
+                     Defaults to `ocr_stringdist.ocr_distance_map`.
+    :param symmetric: Should the keys of `cost_map` be considered to be symmetric? Defaults to True.
+    :param default_cost: The default substitution cost for character pairs not found in `cost_map`.
+    """
+    if cost_map is None:
+        cost_map = ocr_distance_map
+    return _weighted_levenshtein_distance(  # noqa: F405
+        s1, s2, cost_map=cost_map, symmetric=symmetric, default_cost=default_cost
+    )

ocr_stringdist/default_ocr_distances.py

@@ -0,0 +1,38 @@
+ocr_distance_map: dict[tuple[str, str], float] = {
+    ("O", "0"): 0.1,
+    ("l", "1"): 0.1,
+    ("I", "1"): 0.15,
+    ("o", "0"): 0.2,
+    ("B", "8"): 0.25,
+    ("S", "5"): 0.3,
+    ("G", "6"): 0.3,
+    ("Z", "2"): 0.3,
+    ("C", "c"): 0.3,
+    ("é", "e"): 0.3,
+    ("Ä", "A"): 0.4,
+    ("Ö", "O"): 0.4,
+    ("Ü", "U"): 0.4,
+    ("c", "e"): 0.4,
+    ("a", "o"): 0.4,
+    ("u", "v"): 0.4,
+    ("i", "l"): 0.4,
+    ("s", "5"): 0.4,
+    ("m", "n"): 0.5,
+    ("f", "s"): 0.5,
+    (".", ","): 0.5,
+    ("2", "Z"): 0.5,
+    ("t", "f"): 0.6,
+    ("r", "n"): 0.6,
+    ("-", "_"): 0.6,
+    ("ß", "B"): 0.6,
+    ("h", "b"): 0.7,
+    ("v", "y"): 0.7,
+    ("i", "j"): 0.7,
+    ("é", "á"): 0.7,
+    ("E", "F"): 0.8,
+}
+"""
+Pre-defined distance map between characters, considering common OCR errors.
+The distances are between 0 and 1.
+This map is intended to be used with `symmetric=True`.
+"""

ocr_stringdist-0.0.3.dist-info/METADATA

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: ocr_stringdist
+Version: 0.0.3
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Summary: String distances considering OCR errors.
+Author: Niklas von Moers <niklasvmoers@protonmail.com>
+Author-email: Niklas von Moers <niklasvmoers@protonmail.com>
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: repository, https://github.com/NiklasvonM/ocr-stringdist
+
+# OCR-StringDist
+
+A Python library for string distance calculations that account for common OCR (optical character recognition) errors.
+
+[![PyPI](https://img.shields.io/badge/PyPI-Package-blue)](https://pypi.org/project/ocr-stringdist/)
+[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)
+
+## Overview
+
+OCR-StringDist provides specialized string distance algorithms that accommodate for optical character recognition (OCR) errors. Unlike traditional string comparison algorithms, OCR-StringDist considers common OCR confusions (like "0" vs "O", "6" vs "G", etc.) when calculating distances between strings.
+
+> **Note:** This project is in early development. APIs may change in future releases.
+
+## Installation
+
+```bash
+pip install ocr-stringdist
+```
+
+## Features
+
+- **Weighted Levenshtein Distance**: An adaptation of the classic Levenshtein algorithm with custom substitution costs for character pairs that are commonly confused in OCR models.
+- **Pre-defined OCR Distance Map**: A built-in distance map for common OCR confusions (e.g., "0" vs "O", "1" vs "l", "5" vs "S").
+- **Customizable Cost Maps**: Create your own substitution cost maps for specific OCR systems or domains.
+
+## Usage
+
+```python
+import ocr_stringdist as osd
+
+# Using default OCR distance map
+distance = osd.weighted_levenshtein_distance("OCR5", "OCRS")
+print(f"Distance between 'OCR5' and 'OCRS': {distance}")  # Will be less than 1.0
+
+# Custom cost map
+custom_map = {("f", "t"): 0.2, ("m", "n"): 0.1}
+distance = osd.weighted_levenshtein_distance(
+    "first", "tirst",
+    cost_map=custom_map,
+    symmetric=True,
+    default_cost=1.0
+)
+print(f"Distance with custom map: {distance}")
+```
+
+## Acknowledgements
+
+This project is inspired by [jellyfish](https://github.com/jamesturk/jellyfish), providing the base implementations of the algorithms used here.
+

ocr_stringdist-0.0.3.dist-info/RECORD

@@ -0,0 +1,8 @@
+ocr_stringdist-0.0.3.dist-info/METADATA,sha256=8zNTXdk7LHrW3hhpozRJoxUX_lFfUAwi04c3HajrDQ0,2427
+ocr_stringdist-0.0.3.dist-info/WHEEL,sha256=g5K2e2K_d6dSxc4iNLXoY6_5bqvbTor5WhBlTFP_8rM,129
+ocr_stringdist-0.0.3.dist-info/licenses/LICENSE,sha256=5BPRcjlnbl2t4TidSgpfGrtC_birSf8JlZfA-qmVoQE,1072
+ocr_stringdist/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ocr_stringdist/__init__.py,sha256=80efQ2jxe_BjTFQHbsPXYfpk5Cu6R9sOxrEY7tI8sGk,1347
+ocr_stringdist/default_ocr_distances.py,sha256=8jmR5aLrEfrm5Fj2-nEqdTCKEmoEcm8DxBWv7IQd5_k,887
+ocr_stringdist/_rust_stringdist.cpython-311-arm-linux-gnueabihf.so,sha256=YCOBeLCQQohUNHvgojIW2EcNNbtoX18RsRYJQx0hTm4,576676
+ocr_stringdist-0.0.3.dist-info/RECORD,,

ocr_stringdist-0.0.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Niklas von Moers
+
+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.

ocr_stringdist/__init__.pyi

@@ -1,8 +0,0 @@
-def levenshtein_distance(s1: str, s2: str) -> int: ...
-def ocr_weighted_levenshtein_distance(s1: str, s2: str) -> float: ...
-def custom_weighted_levenshtein_distance(
-    s1: str, 
-    s2: str, 
-    cost_map: dict[tuple[str, str], float], 
-    default_cost: float | None = None
-) -> float: ...

ocr_stringdist-0.0.1.dist-info/METADATA

@@ -1,16 +0,0 @@
-Metadata-Version: 2.4
-Name: ocr_stringdist
-Version: 0.0.1
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Operating System :: OS Independent
-Summary: String distances considering OCR errors.
-Author: Niklas von Moers <niklasvmoers@protonmail.com>
-Author-email: Niklas von Moers <niklasvmoers@protonmail.com>
-License: MIT
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-Project-URL: repository, https://github.com/NiklasvonM/ocr-stringdist
-
-# OCR-Stringdist
-

ocr_stringdist-0.0.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-ocr_stringdist-0.0.1.dist-info/METADATA,sha256=wzwsLfsR7-TwdpbHNwd09kUufLa_mq7Q38qwMjkQRI8,574
-ocr_stringdist-0.0.1.dist-info/WHEEL,sha256=g5K2e2K_d6dSxc4iNLXoY6_5bqvbTor5WhBlTFP_8rM,129
-ocr_stringdist/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ocr_stringdist/__init__.py,sha256=XDpr7RXrjnR6Ct3cFl8f_6VoSXbshoIKWha-g3p6aR4,32
-ocr_stringdist/__init__.pyi,sha256=YCjks23HgatBVfwi3EkDPPrgM4ctQ3f2apesgA5S13Q,294
-ocr_stringdist/_rust_stringdist.cpython-311-arm-linux-gnueabihf.so,sha256=BLc51sMpBOM9D5lo8ZI6wAGpNMvqLTthHgtWShWiEww,578000
-ocr_stringdist-0.0.1.dist-info/RECORD,,