Skip to main content

๐Ÿณ Ocean Provider.

Project description

banner

provider

๐Ÿ‹ Provide an off-chain database store for data assets metadata and registration and perform part of access control in collaboration with the keeper-contracts. oceanprotocol.com

Docker Build Status Travis (.com) Codacy coverage PyPI GitHub contributors


๐Ÿฒ๐Ÿฆ‘ THERE BE DRAGONS AND SQUIDS. This is in alpha state and you can expect running into problems. If you run into them, please open up a new issue. ๐Ÿฆ‘๐Ÿฒ


Table of Contents


Features

The Provider handles all non-blockchain related core functionality, including compute and storage interfaces, and connections to Ocean Keepers. Additionally, the Provider implements Ocean's Service Integrity and Orchestration capabilities, allowing for services to be requested, ordered, scheduled, verfied, and curated.

Running Locally, for Dev and Test

If you want to contribute to the development of the Provider, then you could do the following. (If you want to run a Provider in production, then you will have to do something else.)

First, clone this repository:

git clone git@github.com:oceanprotocol/provider.git
cd provider/

Then run some things that the Provider expects to be running:

cd docker
docker-compose up

You can see what that runs by reading docker/docker-compose.yml. Note that it runs MongoDB but the Provider can also work with BigchainDB or Elasticsearch. It also runs Ganache with all Ocean Protocol Keeper Contracts and Ganache CLI.

The most simple way to start is:

pip install -r requirements_dev.txt # or requirements_conda.txt if using Conda
export FLASK_APP=provider/run.py
export CONFIG_FILE=oceandb.ini
./scripts/deploy
flask run

That will use HTTP (i.e. not SSL/TLS).

The proper way to run the Flask application is using an application server such as Gunicorn. This allow you to run using SSL/TLS. You can generate some certificates for testing by doing:

openssl req -x509 -newkey rsa:4096 -nodes -out cert.pem -keyout key.pem -days 365

and when it asks for the Common Name (CN), answer localhost

Then edit the config file oceandb.ini so that:

provider.scheme = https
provider.host = localhost
provider.port = 5000

Then execute this command:

gunicorn --certfile cert.pem --keyfile key.pem -b 0.0.0.0:5000 -w 1 provider.run:app

API documentation

Once you have your application running you can get access to the documentation at:

https://127.0.0.1:5000/api/v1/docs

(or http if you're using HTTP.)

Tip: if your browser shows the swagger header across the top but says "Failed to load spec." then we found that, in Chrome, if we went to chrome://flags/#allow-insecure-localhost and toggled it to Enabled, then relaunched Chrome, it worked.

If you want to know more about the ontology of the metadata, you can find all the information in OEP-8.

Configuration

You can pass the configuration using the CONFIG_FILE environment variable (recommended) or locating your configuration in oceandb.ini file.

In the configuration there are now three sections:

  • oceandb: Contains different values to connect with oceandb. You can find more information about how to use OceanDB here.
  • keeper-contracts: This section help you to connect with the network where you have deployed the contracts. You can find more information of how to configure here.
    [keeper-contracts]
    keeper.host=0.0.0.0
    keeper.port=8545
    #contracts.folder=venv/contracts
    market.address=0xbc0be3598a31715bac5235718f96bb242804e61e
    auth.address=0x6ba5f72e5399aa67db5b22ee791851937d4910f5
    token.address=0xfd83b273b395b1029c41bb32071500bf662e6a8a
    provider.address=
    
  • resources: This section have properties to connect with the different resourcer provideres. At the moment we are only using Azure but this is going to increase quickly.
    [resources]
    azure.account.name=testocnfiles
    azure.account.key=k2Vk4yfb88WNlWW+W54a8ytJm8MYO1GW9IgiV7TNGKSdmKyVNXzyhiRZ3U1OHRotj/vTYdhJj+ho30HPyJpuYQ==
    azure.container=testfiles
    

Code style

The information about code style in python is documented in this two links python-developer-guide and python-style-guide.

Testing

Automatic tests are setup via Travis, executing tox. Our test use pytest framework.

New Version

The 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.

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.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ocean-provider, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size ocean_provider-0.1.1-py2.py3-none-any.whl (18.7 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size ocean-provider-0.1.1.tar.gz (22.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page