flask-whooshee


Nameflask-whooshee JSON
Version 0.9.1 PyPI version JSON
download
home_pagehttps://github.com/fedora-copr/flask-whooshee
SummaryFlask-SQLAlchemy - Whoosh Integration
upload_time2024-02-15 16:10:55
maintainer
docs_urlNone
authorBohuslav "Slavek" Kabrda
requires_python
licenseBSD-3-Clause
keywords flask sqlalchemy whoosh
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
Flask-Whooshee
--------------

Adds Whoosh integration to Flask-SQLAlchemy.


Setup
`````

Flask-Whooshee supports two different methods of setting up the extension.
You can either initialize it directly, thus binding it to a specific
application instance:

.. code:: python

    app = Flask(__name__)
    whooshee = Whooshee(app)

and the second is to use the factory pattern which will allow you to
configure whooshee at a later point:

.. code:: python

    whooshee = Whooshee()
    def create_app():
        app = Flask(__name__)
        whooshee.init_app(app)
        return app

Now you can create a basic whoosheer:

.. code:: python

    @whooshee.register_model('title', 'content')
    class Entry(db.Model):
        id = db.Column(db.Integer, primary_key=True)
        title = db.Column(db.String)
        content = db.Column(db.Text)

and finally you can search the model:

.. code:: python

    Entry.query.whooshee_search('chuck norris').order_by(Entry.id.desc()).all()


Links
`````

* `Documentation <https://flask-whooshee.readthedocs.io>`_
* `Source Code <https://github.com/fedora-copr/flask-whooshee>`_
* `Issues <https://github.com/fedora-copr/flask-whooshee/issues>`_

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/fedora-copr/flask-whooshee",
    "name": "flask-whooshee",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "flask,sqlalchemy,whoosh",
    "author": "Bohuslav \"Slavek\" Kabrda",
    "author_email": "bkabrda@redhat.com",
    "download_url": "https://files.pythonhosted.org/packages/c9/5a/861bd48c6b48a2ec1049d399cccb4bc55059037e28acc0c7487e4694f00a/flask-whooshee-0.9.1.tar.gz",
    "platform": "any",
    "description": "\nFlask-Whooshee\n--------------\n\nAdds Whoosh integration to Flask-SQLAlchemy.\n\n\nSetup\n`````\n\nFlask-Whooshee supports two different methods of setting up the extension.\nYou can either initialize it directly, thus binding it to a specific\napplication instance:\n\n.. code:: python\n\n    app = Flask(__name__)\n    whooshee = Whooshee(app)\n\nand the second is to use the factory pattern which will allow you to\nconfigure whooshee at a later point:\n\n.. code:: python\n\n    whooshee = Whooshee()\n    def create_app():\n        app = Flask(__name__)\n        whooshee.init_app(app)\n        return app\n\nNow you can create a basic whoosheer:\n\n.. code:: python\n\n    @whooshee.register_model('title', 'content')\n    class Entry(db.Model):\n        id = db.Column(db.Integer, primary_key=True)\n        title = db.Column(db.String)\n        content = db.Column(db.Text)\n\nand finally you can search the model:\n\n.. code:: python\n\n    Entry.query.whooshee_search('chuck norris').order_by(Entry.id.desc()).all()\n\n\nLinks\n`````\n\n* `Documentation <https://flask-whooshee.readthedocs.io>`_\n* `Source Code <https://github.com/fedora-copr/flask-whooshee>`_\n* `Issues <https://github.com/fedora-copr/flask-whooshee/issues>`_\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Flask-SQLAlchemy - Whoosh Integration",
    "version": "0.9.1",
    "project_urls": {
        "Homepage": "https://github.com/fedora-copr/flask-whooshee"
    },
    "split_keywords": [
        "flask",
        "sqlalchemy",
        "whoosh"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e7ece75a2139daff74963218812d4c85afdecc9618046a2b560eae50a52a9e2b",
                "md5": "cb2b65a16a9a5d5bc23fdc02aa4cb02c",
                "sha256": "a0dde9f59b0f171c911d6d39d237b19a50e2b432775a23a9f2b188a3cbafea77"
            },
            "downloads": -1,
            "filename": "flask_whooshee-0.9.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cb2b65a16a9a5d5bc23fdc02aa4cb02c",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 8729,
            "upload_time": "2024-02-15T16:10:53",
            "upload_time_iso_8601": "2024-02-15T16:10:53.142130Z",
            "url": "https://files.pythonhosted.org/packages/e7/ec/e75a2139daff74963218812d4c85afdecc9618046a2b560eae50a52a9e2b/flask_whooshee-0.9.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c95a861bd48c6b48a2ec1049d399cccb4bc55059037e28acc0c7487e4694f00a",
                "md5": "b2f8e3c3be79dceb2013acba22f69c5d",
                "sha256": "4770a4b8a0425ad39654a9ec62930fb94d4c4e600505cb589314c0ba35201ae2"
            },
            "downloads": -1,
            "filename": "flask-whooshee-0.9.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b2f8e3c3be79dceb2013acba22f69c5d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14380,
            "upload_time": "2024-02-15T16:10:55",
            "upload_time_iso_8601": "2024-02-15T16:10:55.083286Z",
            "url": "https://files.pythonhosted.org/packages/c9/5a/861bd48c6b48a2ec1049d399cccb4bc55059037e28acc0c7487e4694f00a/flask-whooshee-0.9.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-15 16:10:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fedora-copr",
    "github_project": "flask-whooshee",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "flask-whooshee"
}
        
Elapsed time: 0.17858s