A search engine for flask framework using pony orm.
Project description
.. 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|
Get a search engine in your flask application using Pony ORM and Whoosh.
We included some templates to render the search engine.
Install
-------
.. 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
:target: https://pypi.python.org/pypi/flask-ponywhoosh
:scale: 100%
:align: center
:alt: 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
-------
.. 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flask-ponywhoosh-1.0.5.tar.gz
(12.2 kB
view details)
Built Distribution
File details
Details for the file flask-ponywhoosh-1.0.5.tar.gz
.
File metadata
- Download URL: flask-ponywhoosh-1.0.5.tar.gz
- Upload date:
- Size: 12.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
170b104ac5876f5316bd791ef67c29f76d53510173a71ba5b8b1d67a0cd30afa
|
|
MD5 |
b3f7575a72aca0aaeaff46509b66d715
|
|
BLAKE2b-256 |
0f985e3f24596a8a01ac01dc9c950146312e2ab6da983b71cc18e61350074584
|
File details
Details for the file flask_ponywhoosh-1.0.5-py2.py3-none-any.whl
.
File metadata
- Download URL: flask_ponywhoosh-1.0.5-py2.py3-none-any.whl
- Upload date:
- Size: 11.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
8f778ed26a14ec7ef93fc658143aed21332c1aff8f7116f0b6240a74b5771cde
|
|
MD5 |
6b237a84bae9e4987821253f80ea1d0f
|
|
BLAKE2b-256 |
e249b7e453ca461f53396422c287c5635db0086cf1e6d71203ca80188fefced1
|