From 412af1454fef1262c3f777e4c97a640d76dc036f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Sat, 25 Jan 2020 10:11:27 +0100 Subject: [PATCH] Rename the Python package to tantivy. --- .travis.yml | 3 +-- Cargo.toml | 2 +- README.md | 10 +++++----- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/.travis.yml b/.travis.yml index 98356b5..195de1a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -23,13 +23,12 @@ before_cache: - rm -rfv target/debug/deps/libtantivy-* - rm -rfv target/debug/deps/tantivy-* - rm -rfv target/debug/{tantivy,libtantivy}.d - - cargo clean -p tantivy-py env: global: - TRAVIS_RUST_VERSION=nightly - RUST_BACKTRACE=1 - - secure: NsP9l1lbkaY2jRuxWtCl/k+abdpkZ8faeUu/EMtUQwK3ro110/P4IWaMoZ/KuQkouB6n+RNi9abM7RaOmV30QPE7Gpyn6ePKt8AANqX75J/iLjGaxmyKhvRoRtAOU+HcujRXAKEs9xPu56ZlvGVwlZECaqjQExn1ND07Sd5TvwjlEExvgjAemYeHUG4Hwcw2GCRfOQicVjbZxFHSLCQHUCSO3amKnB2Xwk1oa/CT4xaSuWEZRN1UW0qPWLrfmB3SrIgAIn+VlRQau9VW4D6tFqnREAq0ZZ4zr19OC3PiOm4VTiMJBFTHCKlGQcKAoE7qWyhQME8K3fxcxeNlj1k88RZUz4LLh6rTEaltnx3bB26dRohG3EngGjtITN/BtaH1oewPnSPyXWq08rQt7kt1w6bjWhLwaYGmL7f6H1ZA4lPCik/6Jf5kDGjD2lWIhzoyHYIU7Xk56KSgbqfexafnQHNv2irExW2nXJ8Iqke8iKWa8gm8Qy0lP8ODjWQi6GkW95N9umT7TSeLuiQKs241tMEetuYau64cqomy3KuucUtbjIA4N4R3ljDp4kSfi9T4RtnSMh/QAD6uKqMwcg1YEzIMsq7YkC1JwPaAsyUoDmd5xj54WJTko7MgTBk52V6yt05SNpx6jkXt8ZDnjwzeXn2COwpQE3NHY9/19bRcq7w= + - secure: ZR/4EeOZBCa63aYIuSo36c2DsJoRpOUTQo3zcPzOJoxFxvCTYUJnyX8P38hktdcTcpgEm1ALDbsQDZNboJIP80OkLtWbaQNHgP6jFLqbENryyXYmPunbU9QQWOZaFhEJ+kgUun3kBLYoTW0iZFcJ0AHzjogOEenxKan4lFsZG9Wgku8Q0HX0zK8PPk6ZpMASUrmDAUbW/K6fVuxpix+VF6iPeK1IOxnDSn9CMBI6F1Tq46J/kWzMOWthVthjA0G0OiXi4eQN3ysP/o4bYpr1mifiHCssVKpfwmpqoDR3Nka9H39RN8xcn4X+0h5XA+jAVsD4qUfOcg2otkuZST/h0r1Q30/NrxWmxS6PtIImVlOAxotEkrRwt/DT0sXSRbApmyLApPDPKJ16mjm1miAZvXeJOwB1pT9SKqyxlh4+pPOnXUMYVH44XVCTF7C3zsgxMmv3frRbKfcedJAon4UIIZdE3guA83aadTk6HEXXefmAsxEyJDsA3NJJ8Wm5GkGvrFJZnI9X88eYLX0+H+NW/RHi0CCi6JfnsFjmDpXLRkdAxN8fRIaaDBmleir2AFFXYHAPdcM7z/B1HnTTJBbjeezFwb8JvFPZzxIOijxVfIVeoGcOwgpFzm2wHEi0AH4z2KtAzDQnhdhmle3Q4TrCt78e0iFJb1dANbdmhYpe/xI= install: - pip install --upgrade pip diff --git a/Cargo.toml b/Cargo.toml index b7e0302..9f67f3c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "tantivy-py" +name = "tantivy" version = "0.11.0-rc.7" authors = ["Damir Jelić "] edition = "2018" diff --git a/README.md b/README.md index 43fad84..73743ca 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ tantivy-py ========== -Python bindings for tantivy. +Python bindings for Tantivy. # Installation The bindings can be installed using from pypi using pip: - pip install tantivy-py + pip install tantivy If no binary wheel is present for your operating system the bindings will be build from source, this means that Rust needs to be installed before building @@ -22,8 +22,8 @@ requires rust nightly and only supports python3. # Development -Developing tantivy-py can be done in a virtual environment using `pipenv` or -using local packages using the provided `Makefile`. +Setting up a development enviroment can be done in a virtual environment using +`pipenv` or using local packages using the provided `Makefile`. For the `pipenv` setup install the virtual environment and build the bindings using: @@ -44,7 +44,7 @@ Running the tests is done using: # Usage -tantivy-py has a similar API to tantivy. To create a index first a schema +The Python bindings have 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.