Nimfuzz is a Nim wrapper for the fts_fuzzy_match library by Forrest Smith
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tests
.gitignore
LICENSE
README.md
nimfuzz.cfg
nimfuzz.nimble

README.md

Nimfuzz is a Nim wrapper for the fts_fuzzy_match library by Forrest Smith.

Nimfuzz is distributed as a Nimble package and depends on nimgen and c2nim to generate the wrappers. The fts_fuzzy_match.h source code is downloaded using curl/powershell.

Installation

Nimfuzz can be installed via Nimble:

> nimble install nimgen

> git clone https://github.com/genotrance/nimfuzz
> cd nimfuzz
> nimble install -y

This will download, wrap and install nimfuzz in the standard Nimble package location, typically ~/.nimble. Once installed, it can be imported into any Nim program.

Usage

Module documentation can be found here.

import nimfuzz/fts_fuzzy_match

var i: cint = 0
echo fuzzy_match("ftw", "ForrestTheWoods", i)
echo i

Credits

Nimfuzz wraps the fts_fuzzy_match.h library and all its licensing terms apply to the usage of this package.

Credits go out to c2nim as well without which this package would be greatly limited in its abilities.

Feedback

Nimfuzz is a work in progress and any feedback or suggestions are welcome. It is hosted on GitHub with an MIT license so issues, forks and PRs are most appreciated.