simstring-rust 0.3.1b2__cp37-abi3-win_amd64.whl

simstring_rust/__init__.py

@@ -0,0 +1,5 @@
+from .simstring_rust import *
+
+__doc__ = simstring_rust.__doc__
+if hasattr(simstring_rust, "__all__"):
+    __all__ = simstring_rust.__all__

simstring_rust-0.3.1b2.dist-info/METADATA

@@ -0,0 +1,154 @@
+Metadata-Version: 2.4
+Name: simstring-rust
+Version: 0.3.1b2
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+License-File: LICENSE
+Summary: A fast, native Rust implementation of the SimString algorithm with Python bindings.
+Keywords: string-matching,nlp,simstring,fuzzy
+Home-Page: https://github.com/PyDataBlog/simstring_rs
+Author: Bernard Brenyah <bbrenyah@gmail.com>
+Author-email: Bernard Brenyah <bbrenyah@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/PyDataBlog/simstring_rs
+Project-URL: Repository, https://github.com/PyDataBlog/simstring_rs
+
+# simstring_rust
+
+[![Build Status](https://github.com/PyDataBlog/simstring_rs/actions/workflows/CI.yml/badge.svg)](https://github.com/PyDataBlog/simstring_rs/actions)
+[![Crates.io](https://img.shields.io/crates/v/simstring_rust.svg)](https://crates.io/crates/simstring_rust)
+[![Documentation](https://docs.rs/simstring_rust/badge.svg)](https://docs.rs/simstring_rust)
+[![Rust](https://img.shields.io/badge/rust-1.63.0%2B-blue.svg?maxAge=3600)](https://github.com/PyDataBlog/simstring_rs)
+
+A native Rust implementation of the CPMerge algorithm, designed for approximate string matching. This crate is particularly useful for natural language processing tasks that require the retrieval of strings/texts from very large corpora (big amounts of texts). Currently, this crate supports both character and word-based N-grams feature generation, with plans to allow custom user-defined feature generation methods.
+
+## Features
+
+- ✅ Fast algorithm for string matching
+- ✅ 100% exact retrieval
+- ✅ Support for Unicode
+- [ ] Support for building databases directly from text files
+- [ ] Mecab-based tokenizer support
+
+## Supported String Similarity Measures
+
+- ✅ Dice coefficient
+- ✅ Jaccard coefficient
+- ✅ Cosine coefficient
+- ✅ Overlap coefficient
+- ✅ Exact match
+
+## Installation
+
+Add `simstring_rust` to your `Cargo.toml`:
+
+```toml
+[dependencies]
+simstring_rust = "0.3.0" # change version accordingly
+```
+
+For the latest features, you can add the master branch by specifying the Git repository:
+
+```toml
+[dependencies]
+simstring_rust = { git = "https://github.com/PyDataBlog/simstring_rs.git", branch = "main" }
+```
+
+Note: Using the master branch may include experimental features and potential breakages. Use with caution!
+
+To revert to a stable version, ensure your Cargo.toml specifies a specific version number instead of the Git repository.
+
+## Usage
+
+Here is a basic example of how to use simstring_rs in your Rust project:
+
+```Rust
+use simstring_rust::database::HashDb;
+use simstring_rust::extractors::CharacterNgrams;
+use simstring_rust::measures::Cosine;
+use simstring_rust::Searcher;
+
+use std::sync::Arc;
+
+fn main() {
+    // 1. Setup the database
+    let feature_extractor = Arc::new(CharacterNgrams::new(2, "$"));
+    let mut db = HashDb::new(feature_extractor);
+
+    // 2. Index some strings
+    db.insert("hello".to_string());
+    db.insert("help".to_string());
+    db.insert("halo".to_string());
+    db.insert("world".to_string());
+
+    // 3. Search for strings
+    let measure = Cosine;
+    let searcher = Searcher::new(&db, measure);
+    let query = "hell";
+    let alpha = 0.5;
+
+    if let Ok(results) = searcher.ranked_search(query, alpha) {
+        println!("Found {} results for query '{}'", results.len(), query);
+        for (item, score) in results {
+            println!("- Match: '{}', Score: {:.4}", item, score);
+        }
+    }
+}
+```
+
+<!-- ## Releasing -->
+<!---->
+<!-- This project uses [`cargo-release`](https://github.com/crate-ci/cargo-release) and [`git-cliff`](https://github.com/orhun/git-cliff) to automate the release process. -->
+<!---->
+<!-- ### Prerequisites -->
+<!---->
+<!-- Before creating a release, ensure you have installed the necessary tools: -->
+<!---->
+<!-- ```bash -->
+<!-- cargo install cargo-release -->
+<!-- cargo install git-cliff -->
+<!-- ``` -->
+<!---->
+<!-- ### Creating a Release -->
+<!---->
+<!-- 1.  Ensure your local `main` branch is up-to-date: -->
+<!--     ```bash -->
+<!--     git checkout main -->
+<!--     git pull origin main -->
+<!--     ``` -->
+<!-- 2.  Run `cargo release` with the desired release level (`patch`, `minor`, or `major`). The command runs in dry-run mode by default, so you can review the changes. -->
+<!--     ```bash -->
+<!--     cargo release <LEVEL> -->
+<!--     ``` -->
+<!-- 3.  Once you have verified the plan, execute the release: -->
+<!--     ```bash -->
+<!--     cargo release <LEVEL> --execute -->
+<!--     ``` -->
+<!---->
+<!-- This will automatically: -->
+<!-- -   Generate and update the `CHANGELOG.md`. -->
+<!-- -   Bump the version in `Cargo.toml`. -->
+<!-- -   Commit the changes and create a new Git tag. -->
+<!-- -   Push the commit and tag to GitHub, which triggers the CI/CD pipeline to publish the crate to `crates.io`. -->
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request on GitHub.
+License
+
+This project is licensed under the MIT License.
+
+## Acknowledgements
+
+Inspired by the [SimString](https://www.chokkan.org/software/simstring/) project.
+

simstring_rust-0.3.1b2.dist-info/RECORD

@@ -0,0 +1,6 @@
+simstring_rust-0.3.1b2.dist-info/METADATA,sha256=K1DSDltY8lzw_nd3qh7F5WqYlbF_0Bhwn91eHEt9HQs,5746
+simstring_rust-0.3.1b2.dist-info/WHEEL,sha256=w2DcmsZAr9ddjKlLMUTE23jGpzdTZ81PKXQO_ZXoN5A,94
+simstring_rust-0.3.1b2.dist-info/licenses/LICENSE,sha256=1h9YYTCkdwcFEQugoPDFIvMfTply9WBS7b0q7BO6wq8,1093
+simstring_rust/__init__.py,sha256=848LALFhj3KZD2jqtwOA_Zd5LkhRP-6Bdp6pagM93I0,139
+simstring_rust/simstring_rust.pyd,sha256=o5tb6tynTLTkr4T75uFdnyfj40DMcd1h1EJZxvJ11go,603648
+simstring_rust-0.3.1b2.dist-info/RECORD,,

simstring_rust-0.3.1b2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.9.1)
+Root-Is-Purelib: false
+Tag: cp37-abi3-win_amd64

simstring_rust-0.3.1b2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Bernard Brenyah
+
+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.