{ "info": { "author": "leucothia", "author_email": "devops@oceanprotocol.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6" ], "description": "[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)\n\n# oceandb-driver-interface\n\n> \ud83d\udc33 Ocean DB driver interface(Python).\n> [oceanprotocol.com](https://oceanprotocol.com)\n\n[![Travis (.com)](https://img.shields.io/travis/com/oceanprotocol/oceandb-driver-interface.svg)](https://travis-ci.com/oceanprotocol/oceandb-driver-interface)\n[![PyPI](https://img.shields.io/pypi/v/oceandb-driver-interface.svg)](https://pypi.org/project/oceandb-driver-interface/)\n[![GitHub contributors](https://img.shields.io/github/contributors/oceanprotocol/oceandb-driver-interface.svg)](https://github.com/oceanprotocol/oceandb-driver-interface/graphs/contributors)\n\n---\n\n## Table of Contents\n\n - [Features](#features)\n - [Quick-start](#quick-start)\n - [Environment variables](#environment-variables)\n - [Plugins availables](#plugins-availables)\n - [How to develop a plugin](#how-to-develop-a-plugin)\n - [Code style](#code-style)\n - [Testing](#testing)\n - [New Version](#new-version)\n - [License](#license)\n\n---\n\n## Features\n\nHigh-level, plugin-bound Ocean DB functions. You should implement a plugin class extending this module to connect with Ocean DB.\n\n\n## Quick-start\n\n\nAbstract interface for all persistence layer plugins.\nExpects the following to be defined by the subclass:\n\n* type - A string denoting the type of plugin (e.g. BigchainDB).\n* write - Write an object in OceanDB\n* read - Read the registry for a provided id\n* update - Update an object in OceanDB\n* delete - Delete the registry for a provided id\n* list - List the elements saved in OceanDB\n\nOnce you have your plugin, the way to use it is the following:\n\n\nYou have to provide a configuration with the following information:\n\n```yaml\n [oceandb]\n\n enabled=true # In order to enable or not the plugin\n module=bigchaindb # You can use one the plugins already created. Currently we have mongodb and bigchaindb.\n module.path= # You can specify the location of your custom plugin.\n db.hostname=localhost # Address of your persistence.\n db.port=9985 # Port of yout persistence database.\n\n # In order to use SSL, configure below options.\n db.ssl=true # If *true*, connections will be made using HTTPS, else using HTTP\n db.verify_certs=false # If *true*, CA certificate will be verified\n db.ca_cert_path= # If verifyCerts is *true*, then path to the CA cert should be provided here\n db.client_key= # If db server needs client verification, then provide path to your client key\n db.client_cert_path= # If db server needs client verification, then provide path to your client cert\n\n # If you choose bigchaindb you have to provide this:\n secret= # A secret that serves as a seed.\n db.namespace=namespace # Namespace that you are going to use in bigchaindb\n db.app_id= # App id of your bigchaindb application.\n db.app_key= # App key of your bigchaindb application.\n\n # If you choose mongodb you have to provide this:\n db.username=travis # If you are using authentication, mongodb username.\n db.password=test # If you are using authentication, mongodb password.\n db.name=test # Mongodb database name\n db.collection=col # Mongodb collection name\n\n # If you choose elastic-search you have to provide this:\n db.username=elastic # If you are using authentication, elasticsearch username.\n db.password=changeme # If you are using authentication, elasticsearch password.\n db.index=oceandb # Elasticsearch index name\n```\n\n## Environment variables\n\nWhen you want to instantiate an Oceandb plugin you can provide the next environment variables:\n\n\n- **$CONFIG_PATH** -> If you provide the config path Oceandb is going to run using this config values.\n- **$MODULE** -> If you provide the module, you are going to select one of the modules. \n\n## Plugins availables\n\nAt the moment we have developed two plugins:\n\n* Bigchaindb (https://github.com/oceanprotocol/oceandb-bigchaindb-driver)\n* Mongodb (https://github.com/oceanprotocol/oceandb-mongodb-driver)\n\n\n## How to develop a plugin\n\nTo create a plugin you have to create a class called Plugin extending AbstractPlugin.\n\nYou could find an example in https://github.com/oceanprotocol/oceandb-bigchaindb-driver\n\n\n## Code style\n\nThe information about code style in python is documented in this two links [python-developer-guide](https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/python-developer-guide.md)\nand [python-style-guide](https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/python-style-guide.md).\n\n## Testing\n\nAutomatic tests are setup via Travis, executing `tox`.\nOur test use pytest framework.\n\n## New Version\n\nThe `bumpversion.sh` script helps to bump the project version. You can execute the script using as first argument {major|minor|patch} to bump accordingly the version.\n\n## License\n\n```\nCopyright 2018 Ocean Protocol Foundation Ltd.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/oceanprotocol/oceandb-driver-interface", "keywords": "oceandb-driver-interface", "license": "Apache Software License 2.0", "maintainer": "", "maintainer_email": "", "name": "oceandb-driver-interface", "package_url": "https://pypi.org/project/oceandb-driver-interface/", "platform": "", "project_url": "https://pypi.org/project/oceandb-driver-interface/", "project_urls": { "Homepage": "https://github.com/oceanprotocol/oceandb-driver-interface" }, "release_url": "https://pypi.org/project/oceandb-driver-interface/0.2.0/", "requires_dist": null, "requires_python": "", "summary": "\ud83d\udc33 Ocean DB driver interface(Python).", "version": "0.2.0" }, "last_serial": 5113874, "releases": { "0.0.6": [ { "comment_text": "", "digests": { "md5": "b1e6877a1774e0090a975c3edd171b9a", "sha256": "878f01716c1efdfae8a15682843b4c3797a4692fb37d333b24f8b94c6bf3a3c7" }, "downloads": -1, "filename": "oceandb_driver_interface-0.0.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b1e6877a1774e0090a975c3edd171b9a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8067, "upload_time": "2018-08-14T13:31:25", "url": "https://files.pythonhosted.org/packages/9c/74/821d80310a30f72c42c339eecaae619bae402f426f4db699e9ac45e3a94e/oceandb_driver_interface-0.0.6-py2.py3-none-any.whl" } ], "0.1.10": [ { "comment_text": "", "digests": { "md5": "327fb3de6ef3277c41a9037886ab6643", "sha256": "1ed7fc457a28b0218ede493b0d4680d96c7d51cbdfc8b31b31644124f0cf3bf3" }, "downloads": -1, "filename": "oceandb_driver_interface-0.1.10-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "327fb3de6ef3277c41a9037886ab6643", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11373, "upload_time": "2018-10-02T07:28:33", "url": "https://files.pythonhosted.org/packages/49/d9/88c601f2b3c8ed378ae27596f15b6b0c1b3de399201c3c42aa8b225756c7/oceandb_driver_interface-0.1.10-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b6612d881035f2a45b55debd428c9541", "sha256": "93d56870a3b8c917c56291fca73db017379e4befa639e800026ac8abe56325f1" }, "downloads": -1, "filename": "oceandb-driver-interface-0.1.10.tar.gz", "has_sig": false, "md5_digest": "b6612d881035f2a45b55debd428c9541", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10290, "upload_time": "2018-10-02T07:28:34", "url": "https://files.pythonhosted.org/packages/08/a0/082cb97d433aa9106792a636e251e3c2c891f012f51266b6ae9ee862d087/oceandb-driver-interface-0.1.10.tar.gz" } ], "0.1.11": [ { "comment_text": "", "digests": { "md5": "d491223d0c5fd92af2bc8333e441c2fa", "sha256": "fa18dd30cf3e970b7873fc8289261a14cb442e17b578ddf2d486a7c56ae8080b" }, "downloads": -1, "filename": "oceandb_driver_interface-0.1.11-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d491223d0c5fd92af2bc8333e441c2fa", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11351, "upload_time": "2018-10-04T12:01:09", "url": "https://files.pythonhosted.org/packages/13/a7/2da7af67f6e34c30fee5bd417085adf4aa4af01c038b6cc03baad9d15cda/oceandb_driver_interface-0.1.11-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "88cd3b9b3832d7f47b14e1c80ca27dca", "sha256": "7a4c125e69b33e65bc24562a3ccd1fcb006441e7629a88542a2a825b2ea72d33" }, "downloads": -1, "filename": "oceandb-driver-interface-0.1.11.tar.gz", "has_sig": false, "md5_digest": "88cd3b9b3832d7f47b14e1c80ca27dca", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10270, "upload_time": "2018-10-04T12:01:10", "url": "https://files.pythonhosted.org/packages/a4/16/32b9571b0e8ffb0ab0206907baae3d35af33461ee819339bd219c74a60af/oceandb-driver-interface-0.1.11.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "350a2d0736fe2d559b747b6d0aa7006d", "sha256": "3bbfc00c52e118f5d07a89624f65ba71f8ac912579cef5b1f21e393569d05abe" }, "downloads": -1, "filename": "oceandb_driver_interface-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "350a2d0736fe2d559b747b6d0aa7006d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8067, "upload_time": "2018-08-14T13:41:15", "url": "https://files.pythonhosted.org/packages/c2/2a/9040e9e8a7b06c3a7cb61f86696ab92b3bb3502187cb0dd6a3bed7f3aee0/oceandb_driver_interface-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4f07007ecf6c60492a93dcaf723baa8c", "sha256": "9e17130bcfe7f67ed978f33104176b2e78d21bfa576687cebd0dbf66eed18c7c" }, "downloads": -1, "filename": "oceandb-driver-interface-0.1.2.tar.gz", "has_sig": false, "md5_digest": "4f07007ecf6c60492a93dcaf723baa8c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 95408, "upload_time": "2018-08-14T13:41:16", "url": "https://files.pythonhosted.org/packages/57/da/1c32bd6512c84c555dc186e395e9c8ec2e1663be233e6e09a130192e6abe/oceandb-driver-interface-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "de299a126a52ad619275a889251524c9", "sha256": "8ede58ecfc47fabe311bdce31af73e55bdfb407ed3e5e5a1cc638e3c30cb66ae" }, "downloads": -1, "filename": "oceandb_driver_interface-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "de299a126a52ad619275a889251524c9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5996, "upload_time": "2018-08-15T13:15:22", "url": "https://files.pythonhosted.org/packages/d4/a2/3413caa58154caef1459ea21af09799d02e43b820ac29cd3d8c5257a221d/oceandb_driver_interface-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5f5fa8ec24e68537cd8e763cbd08f151", "sha256": "47eb0e8eb77bd9aa405bac19af7b18c6f38b0e52404839767995e6957df708de" }, "downloads": -1, "filename": "oceandb-driver-interface-0.1.3.tar.gz", "has_sig": false, "md5_digest": "5f5fa8ec24e68537cd8e763cbd08f151", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 95763, "upload_time": "2018-08-15T13:15:23", "url": "https://files.pythonhosted.org/packages/b9/2a/99614b058628134708a26ba03fd1098db924f880cfba0342f54eadd8ff2f/oceandb-driver-interface-0.1.3.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "64018a368a9efd6246ebeadd7b025cbe", "sha256": "441cffae39ac741e15fb7968dc83629125a8f74213d4ac77ba4c0a7bb704b2f9" }, "downloads": -1, "filename": "oceandb_driver_interface-0.1.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "64018a368a9efd6246ebeadd7b025cbe", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6569, "upload_time": "2018-08-30T16:09:09", "url": "https://files.pythonhosted.org/packages/29/4e/71631eea588ace43b9a122c79f8ee8ba775ce3228cda1c2cb345b05bda84/oceandb_driver_interface-0.1.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0ea84a53cb7815bce69a955b3fc5b04f", "sha256": "185a40f1474d5e9f45ae8beb1cc7379da83bc92c83b1d920753b9101d5abfa67" }, "downloads": -1, "filename": "oceandb-driver-interface-0.1.5.tar.gz", "has_sig": false, "md5_digest": "0ea84a53cb7815bce69a955b3fc5b04f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10188, "upload_time": "2018-08-30T16:09:10", "url": "https://files.pythonhosted.org/packages/59/08/138addd61ea11ef28f6c47211b9cb0e1aad3d6c10e5fb124afffbabefb82/oceandb-driver-interface-0.1.5.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "63f95c890d3d6672ffc4cb562ef37c56", "sha256": "a30522d8925b8f033bc7c36aa15f83a8fca05f22a098502a3fc8bf77caa0e78a" }, "downloads": -1, "filename": "oceandb_driver_interface-0.1.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "63f95c890d3d6672ffc4cb562ef37c56", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6569, "upload_time": "2018-09-03T11:54:41", "url": "https://files.pythonhosted.org/packages/92/b1/15c368f0957e3e4344f203902137f693143ef3a0a281ddf45987a287d770/oceandb_driver_interface-0.1.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "56367be73400c89da24ca8a3ced41c7f", "sha256": "89816e05e79922fd1b2b5789b76e3649564f3a7728745979b1b9f20a52b76914" }, "downloads": -1, "filename": "oceandb-driver-interface-0.1.7.tar.gz", "has_sig": false, "md5_digest": "56367be73400c89da24ca8a3ced41c7f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10187, "upload_time": "2018-09-03T11:54:43", "url": "https://files.pythonhosted.org/packages/33/f0/17a1979e100bddefe99c74366652890339db6708acfa0fec54d510cd9809/oceandb-driver-interface-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "6523d17e824299394a15f5db25b5cad8", "sha256": "f9612020e769655dcbcbdcbc25e6bc9fef0b663599b6e754fd357167ec434651" }, "downloads": -1, "filename": "oceandb_driver_interface-0.1.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6523d17e824299394a15f5db25b5cad8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6567, "upload_time": "2018-09-12T14:19:06", "url": "https://files.pythonhosted.org/packages/4e/8c/fd3a886cc9cb9c4394a6cf1b2649c0234372fd1935259d5a0d122d22ab06/oceandb_driver_interface-0.1.8-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a1d24b7589f909434dca09add83f147c", "sha256": "fc4d7d227f8448b7357db2a43c6db33cc81378f884e29c45f10783580b907a72" }, "downloads": -1, "filename": "oceandb-driver-interface-0.1.8.tar.gz", "has_sig": false, "md5_digest": "a1d24b7589f909434dca09add83f147c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10188, "upload_time": "2018-09-12T14:19:07", "url": "https://files.pythonhosted.org/packages/17/f3/808e0e0e2d35a3dd78dd38acdac9197f6afbe90d0c0af63bc4680b4e9deb/oceandb-driver-interface-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "eeaa98fdddfab737ec9dbd5018851806", "sha256": "3770f53dbc616cb9bfb21cdb2d56b2f15e8ddf7f5579810a143769f7a36b2d02" }, "downloads": -1, "filename": "oceandb_driver_interface-0.1.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "eeaa98fdddfab737ec9dbd5018851806", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6566, "upload_time": "2018-09-12T14:39:18", "url": "https://files.pythonhosted.org/packages/18/ec/a470cab224b5ed1cee14167bfc59bfe9b0389e098070ae0895dc8c88b7e8/oceandb_driver_interface-0.1.9-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bb1516544399fab09f822b7394d8c7c7", "sha256": "7f9ac968e73940831ca25a019cee429602956a3532ddbbf82b3b04f3cafb12f9" }, "downloads": -1, "filename": "oceandb-driver-interface-0.1.9.tar.gz", "has_sig": false, "md5_digest": "bb1516544399fab09f822b7394d8c7c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9695, "upload_time": "2018-09-12T14:39:19", "url": "https://files.pythonhosted.org/packages/9e/95/152fa038076cc35e1cabbf914a008dabb458fdb2b25c18b9fa70ae6a13bd/oceandb-driver-interface-0.1.9.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "fef6c5dc28c51a8d771bacb4abad887f", "sha256": "11ccdd807a1211522ce084947bc66ee00f579815368c2b69a2a4d70a5feb6c64" }, "downloads": -1, "filename": "oceandb_driver_interface-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fef6c5dc28c51a8d771bacb4abad887f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11876, "upload_time": "2019-04-08T14:06:02", "url": "https://files.pythonhosted.org/packages/ad/e6/56ac05203f96460c0ed52049ed661104e6db266191f44d5422ebae887d41/oceandb_driver_interface-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "69f2b8009ae4ebae0bd83f64b0223fda", "sha256": "56c858ae352d8ad645bb2c4b1e381be74931dd17f432ef556246de1de5980a97" }, "downloads": -1, "filename": "oceandb-driver-interface-0.2.0.tar.gz", "has_sig": false, "md5_digest": "69f2b8009ae4ebae0bd83f64b0223fda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10442, "upload_time": "2019-04-08T14:06:04", "url": "https://files.pythonhosted.org/packages/0d/1e/145063b12e561f6df7803d7b82f29be3ac309e08c30ce07ae8ff1a66b72d/oceandb-driver-interface-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fef6c5dc28c51a8d771bacb4abad887f", "sha256": "11ccdd807a1211522ce084947bc66ee00f579815368c2b69a2a4d70a5feb6c64" }, "downloads": -1, "filename": "oceandb_driver_interface-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fef6c5dc28c51a8d771bacb4abad887f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11876, "upload_time": "2019-04-08T14:06:02", "url": "https://files.pythonhosted.org/packages/ad/e6/56ac05203f96460c0ed52049ed661104e6db266191f44d5422ebae887d41/oceandb_driver_interface-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "69f2b8009ae4ebae0bd83f64b0223fda", "sha256": "56c858ae352d8ad645bb2c4b1e381be74931dd17f432ef556246de1de5980a97" }, "downloads": -1, "filename": "oceandb-driver-interface-0.2.0.tar.gz", "has_sig": false, "md5_digest": "69f2b8009ae4ebae0bd83f64b0223fda", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10442, "upload_time": "2019-04-08T14:06:04", "url": "https://files.pythonhosted.org/packages/0d/1e/145063b12e561f6df7803d7b82f29be3ac309e08c30ce07ae8ff1a66b72d/oceandb-driver-interface-0.2.0.tar.gz" } ] }