{ "info": { "author": "Eirik Krogstad", "author_email": "eirikkr@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 3" ], "description": "====================================\neve-arango \u2013 Eve ArangoDB data layer\n====================================\n\n.. image:: https://badge.fury.io/py/eve-arango.svg\n :target: https://badge.fury.io/py/eve-arango.svg\n\n.. image:: https://travis-ci.org/tangram/eve-arango.svg?branch=master\n :target: https://travis-ci.org/tangram/eve-arango\n\nProvides a data layer for ArangoDB to be used with Eve REST API framework.\n\nFeatures\n========\n\n- CRUD operations for using ArangoDB as a document store\n- Supports the same operations on edge documents for managing relations\n- Filtering based on AQL syntax\n- Pagination and sorting\n\nNot supported (yet):\n\n- Proper graph queries\n- Versioning\n- Projection\n- Aggregation\n- Etc.\n\nInstallation\n============\n\n.. code-block:: bash\n\n $ pip install eve-arango\n\nUsage\n=====\n\n.. code-block:: python\n\n from eve import Eve\n from eve_arango import ArangoDB\n\n app = Eve(data=ArangoDB)\n app.run()\n\nThe following settings are processed:\n\n.. code-block:: python\n\n # These are necessary for item lookups to work,\n # the regex is for the characters allowed in ArangoDB keys.\n ID_FIELD = '_key'\n ITEM_LOOKUP_FIELD = ID_FIELD\n ITEM_URL = 'regex(\"[\\w\\d\\-:.@()+,=;$!*\\'%]+\")'\n\n # If a database named ARANGO_DB's value doesn't exist,\n # it will be created when the data layer is initialized.\n ARANGO_DB = 'database_name'\n ARANGO_HOST = 'localhost'\n ARANGO_PORT = 8529\n\n # If the keys in DOMAIN do not exist as collection names,\n # they will be created when the data layer is initialized.\n # There's no need to add '_id', '_key' or '_rev' fields,\n # they are added to the schema automatically.\n # If you specifiy 'edge_collection': True as below,\n # an edge collection will be created if it does not exist.\n DOMAIN = {\n 'people': {\n 'schema': {\n 'name': {\n 'type': 'string'\n }\n }\n },\n 'friends_with': {\n 'edge_collection': True\n },\n # ...\n }\n\nFiltering and sorting\n=====================\n\neve-arango uses AQL syntax for filtering via the Eve ``where`` parameter. Mongo-style queries are not valid. Here are some examples of valid (url decoded) queries and their resulting AQL:\n\n.. code-block::\n\n ?where=foo == \"bar\"\n # Spaces are optional.\n # FILTER doc.foo == \"bar\"\n\n ?where=numIN[1,2,3],present!=null\n # Use , as simple separator between FILTER expressions.\n # FILTER doc.num IN [1,2,3]\n # FILTER doc.present != null\n\n ?where=a==\"a\"ANDb==\"b\"ORc==\"c\"\n # AND, OR, NOT can be used to combine expressions.\n # FILTER doc.a == \"a\" AND doc.b == \"b\" OR doc.c == \"c\"\n\nSorting uses the regular Eve syntax. An example is given below:\n\n.. code-block::\n\n ?sort=name,-age\n # SORT doc.name, doc.age DESC\n\nContributing\n============\n\nContributions are welcome. Open an issue and send a pull request.\n\nLicense\n=======\n\n`MIT License `_.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/tangram/eve-arango", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "eve-arango", "package_url": "https://pypi.org/project/eve-arango/", "platform": "", "project_url": "https://pypi.org/project/eve-arango/", "project_urls": { "Homepage": "https://github.com/tangram/eve-arango" }, "release_url": "https://pypi.org/project/eve-arango/0.3.3/", "requires_dist": [ "Eve", "python-arango" ], "requires_python": "", "summary": "Eve ArangoDB data layer", "version": "0.3.3" }, "last_serial": 4288046, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "352afbbf1cc6a7495f4a081e4356851e", "sha256": "bb661b21c18a0a1457d501eeb2eac86c3df44d5a07e1dca5de78f893e989e65d" }, "downloads": -1, "filename": "eve_arango-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "352afbbf1cc6a7495f4a081e4356851e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4984, "upload_time": "2018-07-31T13:48:24", "url": "https://files.pythonhosted.org/packages/74/55/a991882db553fcfd99ef48ca82d91bebb685248047038b8d1e75d845aa80/eve_arango-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5810f105381b1e7693b4a0a9dac77c58", "sha256": "1b78e2e4ca01e4c178b8e032c0d6908cbb310572ea77c9a1c96cb4728c0e8db4" }, "downloads": -1, "filename": "eve-arango-0.1.0.tar.gz", "has_sig": false, "md5_digest": "5810f105381b1e7693b4a0a9dac77c58", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5454, "upload_time": "2018-07-31T13:48:25", "url": "https://files.pythonhosted.org/packages/11/97/6aee70d6e55954b3d72595285202377214d14d681a2abbc645901a517bcb/eve-arango-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "4c7f04e5bd2ffc5a0969ebc7363ff397", "sha256": "a3e26d755843b8ded2a47868c3bb64774f246571faf28947832fe8cf8f76716f" }, "downloads": -1, "filename": "eve_arango-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4c7f04e5bd2ffc5a0969ebc7363ff397", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5070, "upload_time": "2018-08-27T14:21:43", "url": "https://files.pythonhosted.org/packages/aa/d8/30baec327c9b232329727edd18198c640f71bbdfb9b92c978a3db98ea170/eve_arango-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "41a9334641549c19ed820c2aa61050f0", "sha256": "b33fc870824133c2d7d605072f3917c33098372dd4e0ad39a7038241faf703a2" }, "downloads": -1, "filename": "eve-arango-0.1.1.tar.gz", "has_sig": false, "md5_digest": "41a9334641549c19ed820c2aa61050f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5563, "upload_time": "2018-08-27T14:21:45", "url": "https://files.pythonhosted.org/packages/9e/14/440b31216c7fb18cbd5a3da2f2c52a5952a7fe698820155422532884a48b/eve-arango-0.1.1.tar.gz" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "76166a9477644e53bd01a3c95c43b2f7", "sha256": "b495f3b6334b029bc8fcb75f9515ffa9ecfccfcd3c4b62cf23148d94ca9af457" }, "downloads": -1, "filename": "eve_arango-0.3.3-py3-none-any.whl", "has_sig": false, "md5_digest": "76166a9477644e53bd01a3c95c43b2f7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6081, "upload_time": "2018-09-19T10:58:41", "url": "https://files.pythonhosted.org/packages/dc/b7/010b88ac790dabac312e438771eff5cc4055784b19fbd905203631a9b66a/eve_arango-0.3.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ed5cf8df2856083ae39c2d4b90c0d26e", "sha256": "ed9e1c596cfd846aa7d9053a84ed8e87a073cf463ca4a8dfd303dcdf59df78e1" }, "downloads": -1, "filename": "eve-arango-0.3.3.tar.gz", "has_sig": false, "md5_digest": "ed5cf8df2856083ae39c2d4b90c0d26e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6612, "upload_time": "2018-09-19T10:58:42", "url": "https://files.pythonhosted.org/packages/54/74/7425e6bb4c5e6a889093e82fd770efef2cef5faef2d86db91ac09964ac8d/eve-arango-0.3.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "76166a9477644e53bd01a3c95c43b2f7", "sha256": "b495f3b6334b029bc8fcb75f9515ffa9ecfccfcd3c4b62cf23148d94ca9af457" }, "downloads": -1, "filename": "eve_arango-0.3.3-py3-none-any.whl", "has_sig": false, "md5_digest": "76166a9477644e53bd01a3c95c43b2f7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6081, "upload_time": "2018-09-19T10:58:41", "url": "https://files.pythonhosted.org/packages/dc/b7/010b88ac790dabac312e438771eff5cc4055784b19fbd905203631a9b66a/eve_arango-0.3.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ed5cf8df2856083ae39c2d4b90c0d26e", "sha256": "ed9e1c596cfd846aa7d9053a84ed8e87a073cf463ca4a8dfd303dcdf59df78e1" }, "downloads": -1, "filename": "eve-arango-0.3.3.tar.gz", "has_sig": false, "md5_digest": "ed5cf8df2856083ae39c2d4b90c0d26e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6612, "upload_time": "2018-09-19T10:58:42", "url": "https://files.pythonhosted.org/packages/54/74/7425e6bb4c5e6a889093e82fd770efef2cef5faef2d86db91ac09964ac8d/eve-arango-0.3.3.tar.gz" } ] }