# API

This part of the documentation documents all the public classes and functions in flask-ponywhoosh.

## PonyWhoosh Class

## PonyWhooshIndex Class

## Utils Methods

## View method

### flask_ponywhoosh.views module

Perform full-text searches over your database with Pony ORM and PonyWhoosh, for flask applications.

copyright: | 2015-2018 by Jonathan Prieto-Cubides & Felipe Rodriguez.
license: | MIT (see LICENSE.md)

class `flask_ponywhoosh.views.``IndexView`(pw, action_url_form)

  This is all the setting for the template index.html in the templates folder. methods (list): POST and GET

  `dispatch_request`()

    This form is plugeable. That means that all what you need to do is to install the package and run the url :: /ponywhoosh/ (You may change it in the config) and get the results.

    Returns:
      Results: The results are sent to the template using bootstrap. They are renderized using whether a grid or a table, depending on what models did you register. By default the first field registered is considered the one that will be contained in the tittle of each searh result.