# Welcome to flask-ponywhoosh’s documentation!

> It’s the easiest way to add a search engine in your flask application on the shoulders of Pony ORM and Whoosh. To prove this, we’ve included some templates to render the search engine. Just checkout the example. Source code and issue tracking at http://github.com/jonaprieto/flask-ponywhoosh.

## User’s Guide

- What’s new?
- Getting Started:
  - Installation
  - Flask-App Configuration
  - Database Configuration
  - Searching: for the first time
- Searching
  - Testing on the shell.
  - Search():
  - The Attribute `_pw_.`
  - Searching by field:
  - add_wildcards and something
  - The output dictionary
  - use_dict:
- A Preload View For The Search Engine
  - Search Form
  - Advanced search form
  - Results
- App Full Example
  - Running the App
  - Running the app example
- API
  - PonyWhoosh Class
  - PonyWhooshIndex Class
  - Utils Methods
  - View method