Metadata-Version: 2.1
Name: Flask-arango-orm
Version: 0.2.0
Summary: Flask connector for ArangoDB using arango-orm
Home-page: https://github.com/QuaererePlatform/Flask-arango-orm
License: LGPL-3.0-or-later
Author: ravenoak
Author-email: ravenoak@virtualxistenz.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Database
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: arango-orm (>=0.7.2)
Requires-Dist: flask (>=2.0.0)
Requires-Dist: python-arango (>=7)
Project-URL: Documentation, http://flask-arango-orm.readthedocs.io/
Project-URL: Repository, https://github.com/QuaererePlatform/Flask-arango-orm
Description-Content-Type: text/x-rst

About
-----

Flask-arango-orm is used to connect to an `ArangoDB`_ instance using `arango-orm`_ as an object
model layer to your `Flask`_ app.  ArangoDB is a hybrid database that can provide a document, graph,
and relational mode which can be taken advantage of using arango-orm.

.. _ArangoDB: https://www.arangodb.com/
.. _arango-orm: https://github.com/threatify/arango-orm
.. _Flask: http://flask.pocoo.org/docs/1.0/

Installation
------------

Using pip:

.. code-block:: shell

   pip install Flask-arango-orm

Or using setup.py:

.. code-block:: shell

   python setup.py install


Tests can be ran using:

.. code-block:: shell

   python setup.py test


Documentation can be generated using:

.. code-block:: shell

   python setup.py build_sphinx


Usage
-----

This extension for the Flask framework uses arango-orm to provide an Object Model to use
within the Flask application.

.. code-block:: python

   from flask import Flask
   from flask_arango_orm import ArangoORM

   app = Flask(__name__)
   arango = ArangoORM(app)

   @app.route('/route')
   def some_route():
      db_conn = arango.connection


