🐳 Ocean DB BigchainDB driver (Python).
Project description
[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)
# oceandb-bigchaindb-driver
> 🐳 Ocean DB [BigchainDB](https://www.bigchaindb.com/) driver (Python).
> [oceanprotocol.com](https://oceanprotocol.com)
[![Travis (.com)](https://img.shields.io/travis/com/oceanprotocol/oceandb-bigchaindb-driver.svg)](https://travis-ci.com/oceanprotocol/oceandb-bigchaindb-driver)
[![Codacy coverage](https://img.shields.io/codacy/coverage/be42a51b898e46c7b7c2531d49a4e1ac.svg)](https://app.codacy.com/project/ocean-protocol/oceandb-bigchaindb-driver/dashboard)
[![PyPI](https://img.shields.io/pypi/v/oceandb-bigchaindb-driver.svg)](https://pypi.org/project/oceandb-bigchaindb-driver/)
[![GitHub contributors](https://img.shields.io/github/contributors/oceanprotocol/oceandb-bigchaindb-driver.svg)](https://github.com/oceanprotocol/oceandb-bigchaindb-driver/graphs/contributors)
---
## Table of Contents
- [Features](#features)
- [Quick-start](#quick-start)
- [Environment variables](#environment-variables)
- [About BigchainDB plugin implementation](#about-bigchaindb-plugin-implementation)
- [Code style](#code-style)
- [Testing](#testing)
- [License](#license)
------------|------------
**C**reate | **C**reate
**R**ead | **R**etrieve
**U**pdate | **A**ppend
**D**elete | **B**urn
You can find [here](https://blog.bigchaindb.com/crab-create-retrieve-append-burn-b9f6d111f460) a link talking about the CRAB model.
## Search capabilities
Take in account that BigchainDB is not thought to have a great search/query capabilities. At the moment we add two methods,
one allow you to do queries directly to MongoDB and the other do text search queries. This could be a bit unstable, because
is base in a new functionality that is not exposed in the last BigchainDB release. In this repo you can find more information
about the query capabilities of BigchainDB https://github.com/bigchaindb/ethereum-integration/tree/master/poc3/query-engine.
## Code style
The 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)
and [python-style-guide](https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/python-style-guide.md).
## Testing
Automatic tests are setup via Travis, executing `tox`.
Our test use pytest framework.
## License
```
Copyright 2018 Ocean Protocol Foundation Ltd.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# Changelog
## 0.1.0 (2018-05-31)
* First release on PyPI.
# oceandb-bigchaindb-driver
> 🐳 Ocean DB [BigchainDB](https://www.bigchaindb.com/) driver (Python).
> [oceanprotocol.com](https://oceanprotocol.com)
[![Travis (.com)](https://img.shields.io/travis/com/oceanprotocol/oceandb-bigchaindb-driver.svg)](https://travis-ci.com/oceanprotocol/oceandb-bigchaindb-driver)
[![Codacy coverage](https://img.shields.io/codacy/coverage/be42a51b898e46c7b7c2531d49a4e1ac.svg)](https://app.codacy.com/project/ocean-protocol/oceandb-bigchaindb-driver/dashboard)
[![PyPI](https://img.shields.io/pypi/v/oceandb-bigchaindb-driver.svg)](https://pypi.org/project/oceandb-bigchaindb-driver/)
[![GitHub contributors](https://img.shields.io/github/contributors/oceanprotocol/oceandb-bigchaindb-driver.svg)](https://github.com/oceanprotocol/oceandb-bigchaindb-driver/graphs/contributors)
---
## Table of Contents
- [Features](#features)
- [Quick-start](#quick-start)
- [Environment variables](#environment-variables)
- [About BigchainDB plugin implementation](#about-bigchaindb-plugin-implementation)
- [Code style](#code-style)
- [Testing](#testing)
- [License](#license)
------------|------------
**C**reate | **C**reate
**R**ead | **R**etrieve
**U**pdate | **A**ppend
**D**elete | **B**urn
You can find [here](https://blog.bigchaindb.com/crab-create-retrieve-append-burn-b9f6d111f460) a link talking about the CRAB model.
## Search capabilities
Take in account that BigchainDB is not thought to have a great search/query capabilities. At the moment we add two methods,
one allow you to do queries directly to MongoDB and the other do text search queries. This could be a bit unstable, because
is base in a new functionality that is not exposed in the last BigchainDB release. In this repo you can find more information
about the query capabilities of BigchainDB https://github.com/bigchaindb/ethereum-integration/tree/master/poc3/query-engine.
## Code style
The 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)
and [python-style-guide](https://github.com/oceanprotocol/dev-ocean/blob/master/doc/development/python-style-guide.md).
## Testing
Automatic tests are setup via Travis, executing `tox`.
Our test use pytest framework.
## License
```
Copyright 2018 Ocean Protocol Foundation Ltd.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# Changelog
## 0.1.0 (2018-05-31)
* First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file oceandb_bigchaindb_driver-0.1.4.tar.gz
.
File metadata
- Download URL: oceandb_bigchaindb_driver-0.1.4.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c02c515e8e9bc25c2cd500c99523d7eb80e3d6aed751a54f2c1c32a884f7aae3 |
|
MD5 | dceefaf1ade4ba82e25c5667d931d717 |
|
BLAKE2b-256 | 6e10a461131a1b7a5355f893700ba8de3a5c866f31fd61a24d22bdcff54f5b3f |
File details
Details for the file oceandb_bigchaindb_driver-0.1.4-py2.py3-none-any.whl
.
File metadata
- Download URL: oceandb_bigchaindb_driver-0.1.4-py2.py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4705a5aa339b653cb12f4dc614e6a8e0758db2dcbab1c9fff4ad56b5d3fd566 |
|
MD5 | eaad46bb60a717e8f0b4bdb103019acb |
|
BLAKE2b-256 | 45172be350a577a1de0050fdada55bf2af84a63be56e37ef954fd87e7d04e91a |