23 lines
913 B
Markdown
23 lines
913 B
Markdown
[![Build Status](https://travis-ci.org/quickwit-inc/tantivy-py.svg?branch=master)](https://travis-ci.org/quickwit-inc/tantivy-py)
|
|
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
|
|
[![Docs](https://readthedocs.org/projects/tantivy-py/badge/?version=latest&style=flat-default)](https://tantivy-py.readthedocs.io/en/latest/)
|
|
|
|
tantivy-py
|
|
==========
|
|
|
|
Python bindings for [Tantivy](https://github.com/quickwit-oss/tantivy) the full-text search engine library written in Rust.
|
|
|
|
# Installation
|
|
|
|
The bindings can be installed using from pypi using pip:
|
|
|
|
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
|
|
can succeed.
|
|
|
|
# Documentation
|
|
|
|
Please see [the documentation](https://tantivy-py.readthedocs.io/en/latest/) for more information.
|