Merge pull request #110 from roy-ht/use-pdm

turn into pdm project

.github/workflows/build.yml

@@ -0,0 +1,78 @@
+name: Build and upload to PyPI
+
+on:
+  workflow_dispatch:
+  pull_request:
+  # push:
+  #   branches:
+  #     - main
+  release:
+    types:
+      - published
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up QEMU
+        if: runner.os == 'Linux'
+        uses: docker/setup-qemu-action@v1
+        with:
+          platforms: all
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel==2.16.5
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_SKIP: "{cp27-*}"
+          CIBW_TEST_REQUIRES: pytest
+          CIBW_TEST_COMMAND: "pytest {project}/test"
+          CIBW_ARCHS_MACOS: "x86_64 universal2 arm64"
+          CIBW_ARCHS_LINUX: "auto aarch64"
+      - name: Show built files
+        shell: bash
+        run: ls -la wheelhouse
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-sdist
+          path: dist/*.tar.gz
+
+  upload_pypi:
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    if: github.event_name == 'release' && github.event.action == 'published'
+    # or, alternatively, upload to PyPI on every tag starting with 'v' (remove on: release above to use this)
+    # if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          # unpacks all CIBW artifacts into dist/
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        # with:
+          # To test: repository-url: https://test.pypi.org/legacy/

README.md

@@ -0,0 +1,101 @@
+# editdistance
+
+Fast implementation of the edit distance (Levenshtein distance).
+
+This library simply implements [Levenshtein distance](http://en.wikipedia.org/wiki/Levenshtein_distance) with C++ and Cython.
+
+The algorithm used in this library is proposed by
+[Heikki Hyyrö, "Explaining and extending the bit-parallel approximate string matching algorithm of Myers", (2001)](http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.19.7158&rep=rep1&type=pdf)
+
+## Binary wheels
+
+Thanks to [pypa/cibuildwheel](https://github.com/pypa/cibuildwheel)
+There are binary wheels on Linux, Mac OS, and Windows.
+
+## Install
+
+You can install via pip:
+
+```bash
+pip install editdistance
+```
+
+
+## Usage
+
+It's quite simple:
+
+```python
+import editdistance
+editdistance.eval('banana', 'bahama')
+# 2L
+```
+
+
+# Simple Benchmark
+
+With IPython, I tried several libraries:
+
+* [pyxDamerauLevenshtein](https://pypi.python.org/pypi/pyxDamerauLevenshtein)
+* [pylev](https://pypi.python.org/pypi/pylev)
+* [python-Levenshtein](https://pypi.python.org/pypi/python-Levenshtein)
+
+On Python 2.7.5:
+
+```python
+a = 'fsffvfdsbbdfvvdavavavavavava'
+b = 'fvdaabavvvvvadvdvavavadfsfsdafvvav'
+import pylev
+timeit pylev.levenshtein(a, b)
+# 100 loops, best of 3: 7.48 ms per loop
+
+from pyxdameraulevenshtein import damerau_levenshtein_distance
+timeit damerau_levenshtein_distance(a, b)
+# 100000 loops, best of 3: 11.4 µs per loop
+
+timeit editdistance.eval(a, b)  # my library
+# 100000 loops, best of 3: 3.5 µs per loop
+
+import Levenshtein
+
+timeit Levenshtein.distance(a, b)
+# 100000 loops, best of 3: 3.21 µs per loop
+```
+
+## Distance with Any Object
+
+Above libraries only support strings.
+But Sometimes other type of objects such as list of strings(words).
+I support any iterable, only requires hashable object of it:
+
+```python
+Levenshtein.distance(['spam', 'egg'], ['spam', 'ham'])
+# ---------------------------------------------------------------------------
+# TypeError                                 Traceback (most recent call last)
+# <ipython-input-22-3e0b30d145ac> in <module>()
+# ----> 1 Levenshtein.distance(['spam', 'egg'], ['spam', 'ham'])
+#
+# TypeError: distance expected two Strings or two Unicodes
+
+editdistance.eval(['spam', 'egg'], ['spam', 'ham'])
+# 1L
+```
+
+So if object's hash is same, it's same.
+You can provide `__hash__` method to your object instances.
+
+Enjoy!
+
+## License
+
+It is released under the MIT license.
+
+```
+Copyright (c) 2013 Hiroyuki Tanaka
+
+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.
+```