From 8e90e1865df056a7d81f136698578bec6dad2f61 Mon Sep 17 00:00:00 2001 From: cmdoret Date: Fri, 20 Sep 2024 15:07:07 +0200 Subject: [PATCH] docs(readme): add python installation instructions --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1853e88..ba50a12 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,12 @@ > [!WARNING] > This repository is a prototype and not yet in a usable state. -fuzon allows to fuzzy search entities in rdf knowledge graphs based on their labels. It is a wrapper around the [rff](https://github.com/stewart/rff) fuzzy finder. Example use cases of this tool include finding codes based on their label in a given source ontology. It prefetches URI - label pairs in the back-end, by parsing source ontologies. This allows for highly performant fuzzy searches, with near-instant feedback to use in "auto-complete" interfaces. +fuzon allows to fuzzy search entities in rdf knowledge graphs based on their labels. It is a wrapper around the [rff](https://github.com/stewart/rff) fuzzy finder. Example use cases of this tool include finding codes based on their label in a given source ontology. It prefetches URI - label pairs in the back-end, by parsing source ontologies (either from a local file or a URL). This allows for highly performant fuzzy searches, with near-instant feedback to use in "auto-complete" interfaces. ## installation +The rust crate can be installed by cloning the repo and building locally: + ```shell git clone https://github.com/sdsc-ordes/fuzon cd fuzon @@ -15,6 +17,12 @@ cargo build --release ./target/release/fuzon --help ``` +The python package is distributed on PyPI and can be installed with: + +```shell +pip install pyfuzon +``` + ## usage ### command line interface