ocr-stringdist 0.2.1__cp313-cp313-macosx_10_12_x86_64.whl → 0.2.2__cp313-cp313-macosx_10_12_x86_64.whl

{ocr_stringdist-0.2.1.dist-info → ocr_stringdist-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
-Name: ocr_stringdist
-Version: 0.2.1
+Name: ocr-stringdist
+Version: 0.2.2
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python
 Classifier: Operating System :: OS Independent
@@ -8,6 +8,7 @@ License-File: LICENSE
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: repository, https://github.com/NiklasvonM/ocr-stringdist
+Project-URL: documentation, https://niklasvonm.github.io/ocr-stringdist/
 
 # OCR-StringDist
 
@@ -38,8 +39,6 @@ OCR-StringDist uses a **weighted Levenshtein distance**, assigning lower costs t
 
 This makes it ideal for matching potentially incorrect OCR output against known values (e.g., product codes, database entries).
 
-> **Note:** This project is in early development. APIs may change in future releases.
-
 ## Installation
 
 ```bash
@@ -48,7 +47,9 @@ pip install ocr-stringdist
 
 ## Features
 
+- **High Performance**: The core logic is implemented in Rust with speed in mind.
 - **Weighted Levenshtein Distance**: Calculates Levenshtein distance with customizable costs for substitutions, insertions, and deletions. Includes an efficient batch version (`batch_weighted_levenshtein_distance`) for comparing one string against many candidates.
+- **Explainable Edit Path**: Returns the optimal sequence of edit operations (substitutions, insertions, and deletions) used to transform one string into another.
 - **Substitution of Multiple Characters**: Not just character pairs, but string pairs may be substituted, for example the Korean syllable "이" for the two letters "OI".
 - **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").
 - **Unicode Support**: Works with arbitrary Unicode strings.
@@ -56,25 +57,45 @@ pip install ocr-stringdist
 
 ## Usage
 
-### Weighted Levenshtein Distance
+### Basic usage
+
+```python
+from ocr_stringdist import WeightedLevenshtein
+
+# Default substitution costs are ocr_stringdist.ocr_distance_map.
+wl = WeightedLevenshtein()
+
+print(wl.distance("CXDE", "CODE")) # == 1
+print(wl.distance("C0DE", "CODE")) # < 1
+```
+
+### Explain the Edit Path
+
+```python
+edit_path = wl.explain("C0DE", "CODE")
+print(edit_path)
+# EditOperation(op_type='substitute', source_token='0', target_token='O', cost=0.1)]
+```
+
+### Fast Batch Calculations
+
+Quickly compare a string to a list of candidates.
 
 ```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
-substitution_costs = {("In", "h"): 0.5}
-distance = osd.weighted_levenshtein_distance(
-    "hi", "Ini",
-    substitution_costs=substitution_costs,
-    symmetric_substitution=True,
-)
-print(f"Distance with custom map: {distance}")
+distances: list[float] = wl.batch_distance("CODE", ["CXDE", "C0DE"])
+# [1.0, 0.1]
 ```
 
+### Multi-character Substitutions
+
+```python
+# Custom costs with multi-character substitution
+wl = WeightedLevenshtein(substitution_costs={("In", "h"): 0.5})
+
+print(wl.distance("hi", "Ini")) # 0.5
+```
+
+
 ## Acknowledgements
 
 This project is inspired by [jellyfish](https://github.com/jamesturk/jellyfish), providing the base implementations of the algorithms used here.

{ocr_stringdist-0.2.1.dist-info → ocr_stringdist-0.2.2.dist-info}/RECORD

@@ -1,10 +1,10 @@
-ocr_stringdist-0.2.1.dist-info/METADATA,sha256=dIjhLqdKIzSgqyX45jQ6mZTzZjm3UOcghfe2zYoKeS0,3320
-ocr_stringdist-0.2.1.dist-info/WHEEL,sha256=iXfRWk7-127zCPB-_BNFDQE-qLd9Rsj-fJMRKNRg-kg,106
-ocr_stringdist-0.2.1.dist-info/licenses/LICENSE,sha256=5BPRcjlnbl2t4TidSgpfGrtC_birSf8JlZfA-qmVoQE,1072
+ocr_stringdist-0.2.2.dist-info/METADATA,sha256=2KjG6DHqpsannN0lPK4EwkYBbY3adZrl1oTCq-elnL8,3868
+ocr_stringdist-0.2.2.dist-info/WHEEL,sha256=iXfRWk7-127zCPB-_BNFDQE-qLd9Rsj-fJMRKNRg-kg,106
+ocr_stringdist-0.2.2.dist-info/licenses/LICENSE,sha256=5BPRcjlnbl2t4TidSgpfGrtC_birSf8JlZfA-qmVoQE,1072
 ocr_stringdist/__init__.py,sha256=ApxqraLRcWAkzXhGJXSf3EqGEVFbxghrYrfJ9dmQjQU,467
-ocr_stringdist/_rust_stringdist.cpython-313-darwin.so,sha256=nzhPB5QAg1-oCplNhL5Mw9rGLIrseTpHZJP4ZsUkpcQ,708016
+ocr_stringdist/_rust_stringdist.cpython-313-darwin.so,sha256=hrK-1mgOjJZNE8JEOs1ynxKGghzMoBlYGTeRYkv1Bcs,708016
 ocr_stringdist/default_ocr_distances.py,sha256=oSu-TpHjPA4jxKpLAfmap8z0ZsC99jsOjnRVHW7Hj_Y,1033
 ocr_stringdist/levenshtein.py,sha256=Jypg31BQyULipJ_Yh3dcBQDKNnbvEIlmf28tDr_gySw,11243
 ocr_stringdist/matching.py,sha256=rr8R63Ttu2hTf5Mni7_P8aGBbjWs6t2QPV3wxKXspAs,3293
 ocr_stringdist/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ocr_stringdist-0.2.1.dist-info/RECORD,,
+ocr_stringdist-0.2.2.dist-info/RECORD,,