Install package, import it and start adding what fields of your models in your database you want to search. We included some templates for the search engine.

The easiest way:

$ pip install flask-ponywhoosh

The hard way:

$ git clone https://github.com/compiteing/flask-ponywhoosh.git
$ cd flask-ponywhoosh
$ python setup.py install

After installing the package. Clone this repository in order to run the example or just download the source.

$ git clone https://github.com/compiteing/flask-ponywhoosh.git
$ cd flask-ponywhoosh

Then, you can run the example using:

python example.py runserver

You will see in the shell some outputs showing settings of flask-ponywhoosh (debug mode is on by default). We provide two urls by default:

• localhost/search : the form of the search engine
• localhost/database : contents of the database for our example

Recall localhost is usually http://127.0.0.1:5000.

Customize the templates, url routes and other stuffs, please checkout the documentation on:

• http://pythonhosted.org/flask-ponywhoosh/
• https://pypi.python.org/pypi/flask-ponywhoosh

Adding what fields of your models in your database you want to search.