Metadata-Version: 2.1
Name: Flask-tinydb
Version: 1.3.0.dev0
Summary: flask-tinydb is a Flask extension that provides a TinyDB database.
Home-page: https://flask-tinydb.readthedocs.io/
Author: Komeil Parseh
Author-email: ahmdparsh129@gmail.com
Maintainer: Komeil Parseh
Maintainer-email: ahmdparsh129@gmail.co
License: BSD-3-Clause
Project-URL: Documentation, https://flask-tinydb.readthedocs.io/
Project-URL: Source Code, https://github.com/mmdbalkhi/flask-tinydb
Project-URL: Issue Tracker, https://github.com/mmdbalkhi/flask-tinydb/issues/
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD 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-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: Flask>=2.1.0
Requires-Dist: tinydb>=4.0.0
Provides-Extra: yaml
Requires-Dist: pyyaml>=6.0; extra == "yaml"

Flask-tinydb
=================

flask-tinydb is a Flask extension that provides a TinyDB database.

- tiny 🔍
- fast 🚀
- simple 💡
- lightweight 📦
- typed ✨

requirements
----------------

- Python 3.8+
- Flask 1.0+
- TinyDB 4.0+
- pyyaml 6.0+(optinal)

install
-----------------

via pip::

    pip install flask-tinydb

via source::

    git clone https://github.com/mmdbalkhi/flask-tinydb.git
    cd flask-tinydb
    python setup.py install


usage
-----------------

.. code-block:: python

    from flask import Flask, jsonify
    from flask_tinydb import TinyDB

    app = Flask(__name__)
    db = TinyDB(app).get_db()

    @app.route('/<username>')
    def index(username):
        db.insert({'name': username})
        return f"{username} added to database"

    @app.route('/users')
    def users():
        return jsonify(db.all())

    if __name__ == '__main__':
        app.run()


Links
-----

-   Documentation: https://flask-tinydb.readthedocs.io/
-   Source Code: https://github.com/mmdbalkhi/flask-tinydb
-   Issue Tracker: https://github.com/mmdbalkhi/flask-tinydb/issues/
