Metadata-Version: 2.0
Name: flask-ponywhoosh
Version: 1.0.1
Summary: A search engine for flask framework using pony orm.
Home-page: https://github.com/jonaprieto/flask-ponywhoosh
Author: Jonathan Prieto-Cubides & Felipe Rodriguez
Author-email: jprieto9@eafit.edu.co
License: MIT
Keywords: elastic,engine,flask,flask-sqlalchemy,flask-whooshalchemy,mysql,pony,ponyorm,ponywhoosh,search,searchable,sqlite3,whoosh
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: flask
Requires-Dist: flask-bootstrap
Requires-Dist: flask-wtf
Requires-Dist: ponywhoosh

.. image:: https://github.com/jonaprieto/flask-ponywhoosh/blob/master/docs/_static/logo.png?raw=true
   :target: https://pypi.python.org/pypi/flask-ponywhoosh
   :scale: 100%
   :align: center
   :alt: PonyWhoosh

flask-ponywhoosh
================
|PyPI Package latest release| |Test|

Install the 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.


Install
-------


The easiest way:

.. code:: bash

    $ pip install flask-ponywhoosh

The hard way:

.. code:: bash

    $ 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.

.. code:: bash

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

Then, you can run the example using:

.. code:: bash

    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:

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


Screenshots
-----------

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

.. image:: https://github.com/jonaprieto/flask-ponywhoosh/blob/master/images/databaseconfig.gif?raw=true
   :target: https://pypi.python.org/pypi/flask-ponywhoosh
   :scale: 60%
   :align: center
   :alt: PonyWhoosh




.. image:: http://g.recordit.co/6MnvKNod6y.gif
   :target: https://pypi.python.org/pypi/flask-ponywhoosh
   :scale: 25%
   :align: center
   :alt: PonyWhoosh



.. |PyPI Package latest release| image:: http://img.shields.io/pypi/v/flask-ponywhoosh.png?style=flat

.. |Test| image:: https://travis-ci.org/jonaprieto/flask-ponywhoosh.svg?branch=master
    :target: https://travis-ci.org/jonaprieto/flask-ponywhoosh


