pegasust
/
tantivy-py
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: Rename the project to tantivy-py and mention that the are py3 only.

master
Damir Jelić 2019-06-06 12:12:57 +02:00
parent 5ea790518b
commit 5d92452604
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.toml
View File

@ -1,5 +1,5 @@
[package]
name = "tantivy-python"
name = "tantivy-py"
version = "0.1.0"
authors = ["Damir Jelić <poljar@termina.org.uk>"]
edition = "2018"

10
README.md
View File

@ -1,5 +1,5 @@
python-tantivy
==============
tantivy-py
==========
Python bindings for tantivy.
@ -8,15 +8,15 @@ Python bindings for tantivy.
The bindings can be installed using setuptools:
python setup.py install --user
python3 setup.py install --user
Note that this requires setuptools-rust to be installed. Another thing to note
is that the bindings are using [PyO3](https://github.com/PyO3/pyo3), which
requires rust nightly currently.
requires rust nightly and only supports python3.
# Usage
python-tantivy has a similar API to tantivy. To create a index first a schema
tantivy-py has a similar API to tantivy. To create a index first a schema
needs to be built. After that documents can be added to the index and a reader
can be created to search the index.