File python-pfzy.spec of Package python-pfzy
#
# spec file for package python-pfzy
#
# Copyright (c) 2023 SUSE LLC
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
# upon. The license for this file, and modifications and additions to the
# file, is the same license as for the pristine package itself (unless the
# license for the pristine package is not an Open Source License, in which
# case the license is the MIT License). An "Open Source License" is a
# license that conforms to the Open Source Definition (Version 1.9)
# published by the Open Source Initiative.
# Please submit bugfixes or comments via https://bugs.opensuse.org/
#
Name: python-pfzy
Version: 0.3.4
Release: 0
Summary: Python port of the fzy fuzzy string matching algorithm
License: MIT
URL: https://github.com/kazhala/pfzy
Source: https://files.pythonhosted.org/packages/source/p/pfzy/pfzy-%{version}.tar.gz
BuildRequires: python-rpm-macros
BuildRequires: %{python_module pip}
BuildRequires: %{python_module poetry}
BuildRequires: fdupes
BuildArch: noarch
%python_subpackages
%description
# pfzy
[](https://github.com/kazhala/pfzy/actions?query=workflow%3ACI)
[](https://readthedocs.org/projects/pfzy/)
[](https://ap-southeast-2.console.aws.amazon.com/codesuite/codebuild/378756445655/projects/pfzy/history?region=ap-southeast-2&builds-meta=eyJmIjp7InRleHQiOiIifSwicyI6e30sIm4iOjIwLCJpIjowfQ)
[](https://coveralls.io/github/kazhala/pfzy?branch=master)
[](https://pypi.org/project/pfzy/)
[](https://pypi.org/project/pfzy/)
[](https://github.com/kazhala/pfzy/blob/master/LICENSE)
<!-- start elevator-pitch-intro -->
Python port of the [fzy](https://github.com/jhawthorn/fzy) fuzzy string matching algorithm.
- [Async fuzzy match function](https://pfzy.readthedocs.io/en/latest/pages/usage.html#matcher)
- [Fzy scorer (fuzzy string match)](https://pfzy.readthedocs.io/en/latest/pages/usage.html#fzy-scorer)
- [Substring scorer (exact substring match)](https://pfzy.readthedocs.io/en/latest/pages/usage.html#substr-scorer)
## Requirements
```
python >= 3.7
```
## Installation
```sh
pip install pfzy
```
## Quick Start
**Full documentation: [https://pfzy.readthedocs.io/](https://pfzy.readthedocs.io/)**
```python
import asyncio
from pfzy import fuzzy_match
result = asyncio.run(fuzzy_match("ab", ["acb", "acbabc"]))
```
```
>>> print(result)
[{'value': 'acbabc', 'indices': [3, 4]}, {'value': 'acb', 'indices': [0, 2]}]
```
<!-- end elevator-pitch-intro -->
## Background
[fuzzywuzzy](https://github.com/seatgeek/fuzzywuzzy) is a famous python package for performing fuzzy matching
between strings powered by [python-Levenshtein](https://github.com/miohtama/python-Levenshtein). While it does its
job well it doesn't calculate/provide the matching indices which is essential in a fuzzy finder applications.
The [fzy](https://github.com/jhawthorn/fzy) fuzzy matching algorithm can calculate the matching score while also
providing the matching indices which fuzzy finder applications can use to provide extra highlights.
The initial implementation of this algorithm can be found at [sweep.py](https://github.com/aslpavel/sweep.py) which
is a python implementation of the terminal fuzzy finder. The code snippet is later used by the project [vim-clap](https://github.com/liuchengxu/vim-clap).
**I found myself needing this logic across multiple projects hence decided to strip out the logic and publish a dedicated
package with detailed documentation and unittest.**
<!-- start elevator-pitch-ending -->
## Credit
- [fzy](https://github.com/jhawthorn/fzy)
- [sweep.py](https://github.com/aslpavel/sweep.py)
- [vim-clap](https://github.com/liuchengxu/vim-clap)
## LICENSE
> All 3 projects mentioned in [Credit](#credit) are all licensed under [MIT](https://opensource.org/licenses/MIT).
This project is licensed under [MIT](https://github.com/kazhala/pfzy). Copyright (c) 2021 Kevin Zhuang
<!-- end elevator-pitch-ending -->
%prep
%autosetup -p1 -n pfzy-%{version}
%build
%pyproject_wheel
%install
%pyproject_install
%python_expand %fdupes %{buildroot}%{$python_sitelib}
%files %{python_files}
%{python_sitelib}/pfzy
%{python_sitelib}/pfzy-%{version}.dist-info
%changelog
