Python HTML Makefile
Latest commit 98acc62 Apr 2, 2017 @jonaprieto committed on GitHub Update README.rst
Permalink
Failed to load latest commit information.
docs Renaming piperod/ponywhoosh to jonaprieto/ponywhoosh. Mar 24, 2017
flask_ponywhoosh [ naming ] Renamed Flask-PonyWhoosh to flask-ponywhoosh Jan 29, 2017
images Add files via upload Dec 22, 2016
.gitignore [ make ] test, doc, TODO, and install Jan 30, 2017
.gitmodules tag 0.1.1 Aug 16, 2015
.travis.yml [ make ] test, doc, TODO, and install Jan 30, 2017
AUTHORS.rst beautify sources Dec 20, 2016
CHANGELOG.rst [ pip ] preparing the release (#18) this closes #16 Jan 29, 2017
LICENSE.md beautify sources Dec 20, 2016
MANIFIEST.in fixing some bugs Jan 29, 2017
Makefile [ make ] test, doc, TODO, and install Jan 30, 2017
README.rst Update README.rst Apr 2, 2017
example.py [ pip ] preparing the release (#18) this closes #16 Jan 29, 2017
requirements.txt [ pip ] requirements updated. Mar 24, 2017
setup.cfg
setup.py [ setup.py ] import fixed. Mar 24, 2017
test.py [ pip ] preparing the release (#18) this closes #16 Jan 29, 2017

README.rst

PonyWhoosh

flask-ponywhoosh

PyPI Package latest release Test

Get a search engine in your flask application using Pony ORM and Whoosh. We included some templates to render the search engine.

Install

$ pip install flask-ponywhoosh

The hard way:

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

Example

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

$ git clone https://github.com/jonaprieto/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.

Hacking

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

Screenshots

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

PonyWhoosh PonyWhoosh