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
Built Distributions
flask_ponywhoosh-1.0.2-py2.7.egg
(10.2 kB
view details)
File details
Details for the file flask-ponywhoosh-1.0.2.tar.gz
.
File metadata
- Download URL: flask-ponywhoosh-1.0.2.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
aaef34dffff4885cc1011ec8628249fb5f13e742af45e4f113d940f508425acd
|
|
MD5 |
0817c93caa292712d391babfb6275f75
|
|
BLAKE2b-256 |
bb261e75c6f35e5b76175bc8ed1d856ef33319a3849b8c4521bab55878ca5649
|
File details
Details for the file flask_ponywhoosh-1.0.2-py2.py3-none-any.whl
.
File metadata
- Download URL: flask_ponywhoosh-1.0.2-py2.py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
b56de9a483f62eeebf119e1a22d3ac2f7b968157be9c0f19e1f7f0fcb11b8427
|
|
MD5 |
6c21c3cb8aa5485d215520a503b6acb4
|
|
BLAKE2b-256 |
49221126998d9283a326c3b4321e02dfa70e55f436fe374e7ac6e3d946323274
|
File details
Details for the file flask_ponywhoosh-1.0.2-py2.7.egg
.
File metadata
- Download URL: flask_ponywhoosh-1.0.2-py2.7.egg
- Upload date:
- Size: 10.2 kB
- Tags: Egg
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
b079bdb1c8cdde52051497b844d5bdcf4f532e2ae511d05683c2aee6e510689d
|
|
MD5 |
fc1ea2ab2d55ec507a2ecc7247e2751a
|
|
BLAKE2b-256 |
3ddef9a527ce88db054a0bbd15f2fb7e9f58f8d265d4df00502cecc043455de5
|
File details
Details for the file flask_ponywhoosh-1.0.2-py2-none-any.whl
.
File metadata
- Download URL: flask_ponywhoosh-1.0.2-py2-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
94e792ad5da738dfdd8d3a0973990dd816fb071b1c4345b4ebca40d13e08a188
|
|
MD5 |
d551cb35f11615dadf8689c9e0c6e7c5
|
|
BLAKE2b-256 |
01624ceab3cd07afb8af553254323ff7d49df8928f6b3ed48d26d13c623a9ea0
|